6 Managing Sessions

This chapter describes how to configure the behavior of and manage ongoing sessions:

About Sessions
Reference: ApplicationSessions

See "Reference: ApplicationSessions" for information on where to find the operations in the Administration Console and the name of the MBean.

About Sessions

You can configure whether or not to use sessions between applications and Oracle Communications Services Gatekeeper. Sessions can be used for establishing site affinity when using geographical redundant sites.

The setting of "Attribute: sessionRequired" specifies whether sessions are used.

When using sessions, the application must get a session from the Session Web Service prior to using the other application-facing interfaces. The application must also provide the session ID in all requests to the application-facing interfaces, except for requests to the Session Web Service.

A session has a unique ID. A session, once established, can have two states:

ACTIVE
INVALID

After a session has been established, it is always in the ACTIVE state.

Table 6-1describes the possible states for a session, the state into which it can transition from the current state, and the condition under which such a transition occurs.

Table 6-1 Session States and Conditions for Successful Transition

Current Session State	Valid Transition State	Scenario in Which Transition Occurs
ACTIVE	INVALID	The age of the ACTIVE state of a session is older than a configurable time-interval. See "Attribute: validityTime".
ACTIVE	Not applicable This is not a state but rather that the session is not current or does not exist.	A management user performs one of the following management operations: destroySession destroyApplicationInstanceSession destroyApplicationSessions destroyServiceProviderSessions
INVALID	Not applicable This is not a state but rather that the session is not current or does not exist.	The age of the INVALID state of a session is older than a configurable time-interval. See "Attribute: expiryTime". A management user performs one of the following management operations: destroyApplicationInstanceSession destroyApplicationSessions destroySession destroyServiceProviderSessions

Current Session State

Valid Transition State

Scenario in Which Transition Occurs

ACTIVE

INVALID

The age of the ACTIVE state of a session is older than a configurable time-interval. See "Attribute: validityTime".

ACTIVE

Not applicable

This is not a state but rather that the session is not current or does not exist.

A management user performs one of the following management operations:

destroySession
destroyApplicationInstanceSession
destroyApplicationSessions
destroyServiceProviderSessions

INVALID

Not applicable

This is not a state but rather that the session is not current or does not exist.

The age of the INVALID state of a session is older than a configurable time-interval. See "Attribute: expiryTime".

A management user performs one of the following management operations:

destroyApplicationInstanceSession
destroyApplicationSessions
destroySession
destroyServiceProviderSessions

Reference: ApplicationSessions

All operations are reachable from:

Oracle Communications Services Gatekeeper Administration Console Managed Object: Container Services > AccountService > ApplicationSessions
MBean: com.bea.wlcp.wlng.account.management.ApplicationSessionMBean

Following is a list of attributes and operations for ApplicationSessions:

Attribute: expiryTime
Attribute: sessionRequired
Attribute: validityTime
countApplicationSessions
destroyServiceProviderSessions
getApplicationInstanceSession
destroySession
destroyApplicationInstanceSession
destroyApplicationSessions
getCurrentSession
listApplicationSessions

Attribute: expiryTime

Scope: Domain

Unit: Minutes

Format: Integer

Specifies the expiry time of sessions.

See "About Sessions" for more information.

Attribute: sessionRequired

Scope: Domain

Unit: Not applicable

Format: Boolean

Specifies if sessions must be established prior to use the application-facing interfaces in Services Gatekeeper. See "About Sessions" for more information.

Attribute: validityTime

Scope: Domain

Unit: Minutes

Format: Integer

Specifies the validity time of sessions.

See "About Sessions" for more information.

countApplicationSessions

The countApplicationSessions operation displays the number of established sessions filtered on:

service provider account
application account

Scope

Domain

Signature

countApplicationSessions(ApplicationIdentifier: String, ServiceProviderIdentifier: String)

Parameters

ApplicationIdentifier

ID of the application account.

Optional. Leave empty to match all.

Service ProviderIdentifier

ID of the service provider account.

Optional. Leave empty to match all.

destroySession

The destroySession operation destroys an ongoing session using the ID of the session.

Scope

Domain

Signature

destroySession(SessionIdentifier: String)

Parameters

SessionIdentifier: ID of the session to destroy.

destroyApplicationInstanceSession

The destroyApplicationInstanceSession operation destroys the ongoing session using the ID of the application instance that established the session.

Scope

Domain

Signature

destroyApplicationInstanceSession(ApplicationInstanceIdentifier: String)

Parameters

ApplicationInstanceIdentifier: ID of the application instance that established the session.

destroyApplicationSessions

The destroyApplicationSessions operation destroys all on-going session established by applications associated with a specific service provider /application account combination.

Scope

Domain

Signature

destroyApplicationSessions(ApplicationIdentifier: String, ServiceProviderIdentifier: String)

Parameters

ApplicationIdentifier: ID of the application account.

ServiceProviderIdentifier: ID of the service provider account.

destroyServiceProviderSessions

The destroyServiceProviderSessions operation destroys all on-going session established by applications associated with a specific service provider account.

Scope

Domain

Signature

destroyServiceProviderSessions(ServiceProviderIdentifier: String)

Parameters

ServiceProviderIdentifier: ID of the service provider account.

getApplicationInstanceSession

The getApplicationInstanceSession operation gets information about a session, active or invalid, using the ID of the application instance that established the session.

The information includes:

Session ID.
ID of the application instance that established the session.
Age, the time since the session was established. Given in minutes.
Validity indicator for the session:
- true if ACTIVE
- false if INVALID

Scope

Domain

Signature

getApplicationInstanceSession(ApplicationInstanceIdentifier: String)

Parameters

ApplicationInstanceIdentifier: ID of the application instance.

getCurrentSession

The getCurrentSession operation gets information about a session, on-going or invalid, using the ID of the session.

The information includes:

Session ID.
ID of the application instance that established the session.
Age, the time since the session was established. Given in minutes.
Validity indicator for the session:
- true if valid
- false if invalid

Scope

Domain

Signature

getCurrentSession(SessionIdentifier: String)

Parameters

SessionIdentifier: ID of the session to get information about.

listApplicationSessions

The listApplicationSessions operation displays a list of IDs for all sessions, ongoing or invalid, established by applications. Filters on:

service provider account
application account

Scope

Domain

Signature

listApplicationSessions(ApplicationIdentifier: String, ServiceProviderIdentifier: String, Offset: int, Size: int)

Parameters

applicationIdentifier

ID of the application account.

Optional. Leave empty to match all.

serviceProviderIdentifier

ID of the service provider account.

Optional. Leave empty to match all.

Offset: Offset in the list. Starts with 0 (zero)

Size

Size of the list.

For no restrictions on the size of the list, use 0 (zero).