Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Session Methods › GetSpec Method—Retrieves the Encrypted Session Specification

GetSpec Method—Retrieves the Encrypted Session Specification

The GetSpec method retrieves the encrypted session specification. The session specification includes information about the user session, such as the session start time, timeout parameters, and the user's distinguished name. You can use the session specification to identify a session across multiple Web sites, as you would for single sign-on applications.

Syntax

The GetSpec method has the following format:

Netegrity::AgentSession‑>GetSpec()

Parameters

The GetSpec method accepts no parameters.

Return Value

The GetSpec method returns the following value:

• encrypted_session_specification (string)

Remarks

Where the session specification is stored depends on the type of session:

• Non-persistent Sessions

  The session specification is stored in a cookie.

• Persistent Sessions

  The session specification is stored in a session server database and optionally, in a cookie on the client.

  Note: The session ticket is used as an index to the actual user session data stored in the Web agent's cache.