Previous Topic: Connection ClassNext Topic: Result Class


Session Class

The Session class, SmApiSession, lets you create a session object by passing in a valid API connection and, depending upon the constructor you use, a session specification. (A session specification is also known as a session ticket).

The core methods of the SmApiSession class are as follows:

Method

Description

getApiConnection()

Retrieves the SmApiConnection object for the current connection.

getSessionSpec()

Retrieves the specification for the current session.

login()

Logs in a SiteMinder administrator. The Policy Server issues a session specification for the session.

logout()

Logs out a SiteMinder administrator.

setApiConnection()

Sets a valid API connection.

setSessionSpec()

Sets an existing session specification.

Note: For login and logout of end users, DMS organization administrators, and DMS super administrators, use the AgentAPI.login() and AgentAPI.logout() methods in the Agent API package.