CRecordUserDbDeleteRole

Delete a role from the user database.

This message belongs to the Session Manager API.
The Session Manager is part of the NY_Session2PlugIn plugin.

{
  "id": "6d41016b-041d-4094-945d-8498f0b8f3be",
  "name": "USER_DB_DELETE_ROLE",
  "description": "Delete a role.",
  "slots": [
    {
      "key": "1",
      "name": "ROLE_ID",
      "direction": "REQUEST",
      "mandatory": "true",
      "type": "STRING",
      "description": "The id of the role to delete."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager:

public static final IId SESSION_MICROSERVICE_ID = CIdFactory.fromObject("ccf168c1-f18b-4229-85f9-24461a19ee6a");

The own SessionToken is needed to verify the authorization for the change. You need the permission NY_DeleteRole. In addition, the role id is required.

private void deleteRole(final byte[] aToken,
                        @NotNull final String aRoleId) throws CException
{
    final CEnvelope env = CEnvelope.forMicroService(SESSION_MICROSERVICE_ID);
    env.setSessionToken(aToken);

    final CRecord record = CRecordUserDbDeleteRole.create();
    CRecordUserDbDeleteRole.setRoleId(record,
                                      aRoleId);

    sendRequest(env,
                record);
}

Dealing with the response

To catch the response of the request, we need a message handler. We add it in the constructor of the message handler registry.

// constructor:
addMessageHandler(CRecordUserDbDeleteRole.ID,
                  this::asyncDeleteRole);

private boolean asyncDeleteRole(@NotNull final CEnvelope aEnvelope,
                                @NotNull final CRecord aRecord)
{
    if (aEnvelope.isAnswer())
    {
        final int resultCode = aEnvelope.getResultCode();
        if (resultCode == CResultCode.SUCCESS)
        {
            // ...
        }
        return true;
    }
    return false;
}