Skip navigation links

com.bea.wlcp.wlng.account.management
Interface ApplicationSessionMBean

public interface ApplicationSessionMBean

Field Summary

static int	expiryTime Session expiry time.
static int	validityTime Session validity time.

Method Summary

int	countApplicationSessions(String applicationIdentifier, String serviceProviderIdentifier) Counts the number of active sessions filtered on the service provider account and the application account.
void	destroyApplicationInstanceSession(String applicationInstanceName) Destroys a current application instance session.
void	destroyApplicationSessions(String applicationIdentifier, String serviceProviderIdentifier) Destroys all current sessions for application.
void	destroyServiceProviderSessions(String serviceProviderIdentifier) Destroys a current session.
void	destroySession(String sessionIdentifier) Destroys a current session.
SessionDescription	getApplicationInstanceSession(String applicationInstanceName) Gets currently active or invalid session for specified application instance.
SessionDescription	getCurrentSession(String sessionIdentifier) Gets an active or invalid session.
int	getExpiryTime() Gets the session expiry time.
String	getSessionRequired() Returns the session requirement status.
int	getValidityTime() Gets the session validity time.
String[]	listApplicationSessions(String applicationIdentifier, String serviceProviderIdentifier, int offset, int size) Lists active sessions.
void	setExpiryTime(int time) Sets the session expiry time.
void	setSessionRequired(String flag) Sets the session requirement status.
void	setValidityTime(int time) Sets the session validity time.

Field Detail

expiryTime

public static final int expiryTime

Session expiry time. Time in minutes until invalid sessions are removed.

Scope: Domain

See Also:

Constant Field Values

validityTime

public static final int validityTime

Session validity time. Time in minutes from creation until sessions are invalidated.

Scope: Domain

See Also:

Constant Field Values

Method Detail

countApplicationSessions

public int countApplicationSessions(String applicationIdentifier,
                                    String serviceProviderIdentifier)
                             throws KeyNotFoundException

Counts the number of active sessions filtered on the service provider account and the application account.

Scope: Domain

Parameters:

applicationIdentifier - The account (optional).

serviceProviderIdentifier - The service provider ID (optional).

Returns:

The number of sessions for specified filter.

Throws:

KeyNotFoundException - If no such account exists.

destroyApplicationInstanceSession

public void destroyApplicationInstanceSession(String applicationInstanceName)
                                       throws KeyNotFoundException

Destroys a current application instance session.

Scope: Domain

Parameters:

applicationInstanceName - The application instance name for which to destroy the session.

Throws:

KeyNotFoundException - If no such application instance exists.

destroyApplicationSessions

public void destroyApplicationSessions(String applicationIdentifier,
                                       String serviceProviderIdentifier)
                                throws KeyNotFoundException

Destroys all current sessions for application.

Scope: Domain

Parameters:

applicationIdentifier - The application for which to destroy sessions.

serviceProviderIdentifier - The application service provider.

Throws:

KeyNotFoundException - If no such account exists.

destroyServiceProviderSessions

public void destroyServiceProviderSessions(String serviceProviderIdentifier)
                                    throws KeyNotFoundException

Destroys a current session.

Scope: Domain

Parameters:

serviceProviderIdentifier - The application for which to destroy sessions.

Throws:

KeyNotFoundException - If no such account exists.

destroySession

public void destroySession(String sessionIdentifier)
                    throws KeyNotFoundException

Destroys a current session.

Scope: Domain

Parameters:

sessionIdentifier - The session to destroy.

Throws:

KeyNotFoundException - If no such session exists.

getApplicationInstanceSession

public SessionDescription getApplicationInstanceSession(String applicationInstanceName)

Gets currently active or invalid session for specified application instance. The informaiton includes:

• Session ID
• ID of the application instance that established the session
• Age in minutes since the session was established
• Validity indicator for the session: true if ACTIVE; false if INVALID

Scope: Domain

Parameters:

applicationInstanceName - The application instance name.

Returns:

The active session or null if no session exists.

getCurrentSession

public SessionDescription getCurrentSession(String sessionIdentifier)

Gets an active or invalid session. The informaiton includes:

• Session ID
• ID of the application instance that established the session
• Age in minutes since the session was established
• Validity indicator for the session: true if ACTIVE; false if INVALID

Scope: Domain

Parameters:

sessionIdentifier - The session ID.

Returns:

The session.

getExpiryTime

public int getExpiryTime()

Gets the session expiry time.

Scope: Domain

Returns:

Validity time in minutes before sessions are removed after invalidation.

getSessionRequired

public String getSessionRequired()

Returns the session requirement status. Format: String.

Scope: Domain

Returns:

'Enabled' if sessions should be required to use plug-ins, 'Disabled' if not. 'Optional' means if sessionid is provided in the application request it must be valid. If sessionid is not provided in the request, it will be allowed.

getValidityTime

public int getValidityTime()

Gets the session validity time. Invalid sessions are refreshable until they have been invalid for the expiry time.

Scope: Domain

Returns:

Validity time in minutes before sessions are invalidated. 0 means no expiry.

listApplicationSessions

public String[] listApplicationSessions(String applicationIdentifier,
                                        String serviceProviderIdentifier,
                                        int offset,
                                        int size)
                                 throws KeyNotFoundException

Lists active sessions. Filters on service provider account and application account.

Scope: Domain

Parameters:

applicationIdentifier - The account (optional).

serviceProviderIdentifier - The service provider (optional).

offset - Offset within the complete resultset. Must be >= 0.

size - Number of entries to return. 0 means no limit.

Returns:

The sessions matching the specified filter.

Throws:

KeyNotFoundException - If no such account exists.

setExpiryTime

public void setExpiryTime(int time)

Sets the session expiry time.

Scope: Domain

Parameters:

time - Expiry time in minutes before sessions are removed after invalidation.

setSessionRequired

public void setSessionRequired(String flag)
                        throws InputManagementException

Sets the session requirement status.

Scope: Domain

Parameters:

flag - 'Enabled' if sessions should be required to use plug-ins, 'Disabled' if not. 'Optional' means if sessionid is provided in the application request it must be valid. If sessionid is not provided in the request, it will be allowed.

Throws:

InputManagementException - exception.

setValidityTime

public void setValidityTime(int time)

Sets the session validity time. Invalid sessions are refreshable until they have been invalid for the expiry time.

Scope: Domain

Parameters:

time - Validity time in minutes before sessions are invalidated. Use 0 for no expiry.

Skip navigation links