NAME

OpenXPKI::Server::Session::Data - data object with some helper methods but no application logic

STATIC CLASS METHODS

METHODS

get_attribute_names

Returns an ArrayRef containing the names of all session attributes.

Session attributes

The following methods are available to access the session attributes:

    getter/setter           clearer
    --------------------------------------------------
    id                      clear_id
    user                    clear_user
    userinfo                clear_userinfo
    role                    clear_role
    tenants                 clear_tenants
    pki_realm               clear_pki_realm
    challenge               clear_challenge
    authentication_stack    clear_authentication_stack
    language                clear_language
    status                  clear_status
    ip_address              clear_ip_address
    created                 clear_created
    modified                clear_modified
    ui_session              clear_ui_session
    authinfo                clear_authinfo

get_attributes

Returns a HashRef containing names and values of all previously set session attributes.

Parameters

•: @attrs - optional: list of attribute names if only a subset shall be returned.

secret

Set or get the secret of the given group (default group: "").

Named parameters

group - optional: the secrets group
value - optional: the value to set

clear_secret

Clear (delete) the secret of the given group (default group: "").

Named parameters

•: group - optional: the secrets group

METHODS

freeze

Serializes the session attributes into a string. The first characters of the string until the first colon indicate the type of serialization (encoder ID).

Returns a string with the serialized data.

Named parameters

only - "ArrayRef" of attributes that shall be included (optional, default: all attributes)
except - "ArrayRef" of attributes that shall be excluded (optional)

thaw

Deserializes the session attributes from a string and sets them. Attributes which are not mentioned will not be touched.

The first characters of the string until the first colon must indicate the type of serialization (encoder ID).

Returns the object instance (allows for method chaining).