Session handling on sillysky.net

CRecordSessionCreateRight

Tue, 09 Dec 2025 00:00:00 +0000

With this request a new permission is stored in the database. This new right can then be assigned to users or roles by the administrator.

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

{
  "id": "4b2bf3f8-7406-4829-9c1c-6f4c14188356",
  "name": "SESSION_CREATE_RIGHT",
  "description": "Create a new right.",
  "slots": [
    {
      "key": "right",
      "name": "RIGHT",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The new right to add."
    },
    {
      "key": "description",
      "name": "DESCRIPTION",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The description of the new right."
    },
    {
      "key": "protected",
      "name": "PROTECTED",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "BOOLEAN",
      "description": "True if the new right is protected."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager:

CRecordSessionExpired

Tue, 09 Dec 2025 00:00:00 +0000

In nyssr.net, when a session token expires or the session is closed, a broadcast is sent to all nodes.
You can register an observer for this message to receive it directly.

This message belongs to the session manager API.
It is part of the kernel.

{
  "id": "274f6cd9-f1fe-4973-9f0e-fd26db19d276",
  "name": "SESSION_EXPIRED",
  "description": "A session has been expired due to inactivity.",
  "isNanoService": "true",
  "namespaces": "SYSTEM",
  "slots": [
  ]
}

Usage

Install the observer

The observer for receiving the message is easiest to set up by handling the CRecordStartTarget message. This is the message that every target receives first after registration. Here, we use the RecordHelper. Alternatively, you can retrieve the SYSTEM namespace, then the nanoservice registry, and finally call the addObserver() method.

CRecordSessionGetLongToken

Tue, 09 Dec 2025 00:00:00 +0000

nyssr.net supports two types of session tokens: a long token with data and a short token without data. If you want to exchange a short token for a long token, this message can be used to retrieve the long token from the SessionManager.

This message belongs to the session manager API.
It is part of the kernel.

{
  "id": "bb156b98-b587-4e47-8c3a-eba8f1f512b8",
  "name": "SESSION_GET_LONG_TOKEN",
  "description": "Get a long session token with a short session token.",
  "slots": [
    {
      "key": "1",
      "name": "SHORT_TOKEN",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "BYTE_ARRAY",
      "description": "The short session token."
    },
    {
      "key": "10",
      "name": "LONG_TOKEN",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "BYTE_ARRAY",
      "description": "The long session token."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager:

CRecordSessionLogin

Tue, 09 Dec 2025 00:00:00 +0000

This record is used for the login of a user.

This message belongs to the Session Manager API.
It is part of the kernel.

{
  "id": "a8c83b58-a567-4eb9-b3b4-ce568899a696",
  "name": "SESSION_LOGIN",
  "description": "LogIn.",
  "slots": [
    {
      "key": "userId",
      "name": "USER_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The user id."
    },
    {
      "key": "pw",
      "name": "PASSWORD",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The base64 encoded hash (SHA384) of the password."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager:

CRecordSessionLogout

Tue, 09 Dec 2025 00:00:00 +0000

Quit the session.

This message belongs to the session manager API.
It is part of the kernel.

{
  "id": "7f736870-b41b-48ea-9220-6f104cae17d3",
  "name": "SESSION_LOGOUT",
  "isNanoService: "false",
  "type": "REQUEST",
  "description": "Close the session.",
  "slots": [
  ]
}

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");

To close the session, we need the token we received when we logged in.

private void closeSession(final byte[] aToken) throws CException
{
    final CEnvelope env = CEnvelope.forMicroService(SESSION_MICROSERVICE_ID);
    env.setSessionToken(aToken);

    final CRecord record = CRecordSessionLogout.create();
    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.

CRecordSessionManagementAvailable

Tue, 09 Dec 2025 00:00:00 +0000

The message CRecordSessionManagementAvailable is an announcement and is sent to all nodes via broadcast. To receive it, an observer must be installed on the nanoservice of the same name in the SYSTEM namespace.

This message belongs to the session manager API.
It is part of the kernel.

{
  "id": "ed0319bd-b50c-49e1-ade7-d9d7bcb67242",
  "name": "SESSION_MANAGEMENT_AVAILABLE",
  "description": "Broadcast: The session management is now available.",
  "isNanoService": "true",
  "namespaces": "SYSTEM",
  "slots": [
    {
      "key": "av",
      "name": "IS_AVAILABLE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "BOOLEAN",
      "description": "True: The session management is available."
    },
    {
      "key": "addr",
      "name": "ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The address of the session management."
    }
  ]
}

Usage

Install the observer

CRecordSessionValidate

Tue, 09 Dec 2025 00:00:00 +0000

This record is needed when a session token we received from a user request is to be checked for validity. With the response we also receive the user ID and a list with the rights of the user.

This message belongs to the session manager API. It is part of the kernel.

{
  "id": "deb4b364-0890-4380-8c36-a142fcb29034",
  "name": "SESSION_VALIDATE",
  "description": "Validate a token.",
  "slots": [
    {
      "key": "userId",
      "name": "USER_ID",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The user ID (only on SUCCESS)."
    },
    {
      "key": "rights",
      "name": "RIGHTS",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING_ARRAY",
      "description": "The rights the user has (only on SUCCESS)."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager: