GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::Session::Data(3) User Contributed Perl Documentation OpenXPKI::Server::Session::Data(3)

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

Returns an ArrayRef containing the names of all 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

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.

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 (delete) the secret of the given group (default group: "").

Named parameters

group - optional: the secrets group

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)

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).

2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.