org.forgerock.openam.core.rest.session

Class SessionResource

java.lang.Object

org.forgerock.openam.core.rest.session.SessionResource

All Implemented Interfaces:

org.forgerock.json.resource.CollectionResourceProvider

public class SessionResource
extends Object
implements org.forgerock.json.resource.CollectionResourceProvider

Represents Sessions that can queried via a REST interface. Currently describe three different entrypoints for this Resource, useful when querying Session Information:

• All - All sessions across all servers known to OpenAM.
• Servers - Lists all servers that are known to OpenAM.
• [server-id] - Lists the servers for that server instance.

This resources acts as a read only resource for the most part, allowing only specific, whitelisted properties to be set through it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_PROPERTY_ACTION_ID
static String	GET_IDLE_ACTION_ID
static String	GET_MAX_IDLE_ACTION_ID
static String	GET_MAX_SESSION_TIME_ACTION_ID
static String	GET_MAX_SESSION_TIME_ID
static String	GET_MAX_TIME_ACTION_ID Deprecated. use getTimeLeft instead.
static String	GET_PROPERTY_ACTION_ID
static String	GET_PROPERTY_NAMES_ACTION_ID
static String	GET_TIME_LEFT_ACTION_ID
static String	IS_ACTIVE_ACTION_ID
static String	KEYWORD_ALL
static String	KEYWORD_LIST
static String	KEYWORD_PROPERTIES
static String	KEYWORD_RESULT
static String	KEYWORD_SERVER_ID
static String	KEYWORD_SUCCESS
static String	LOGOUT_ACTION_ID
static String	SET_PROPERTY_ACTION_ID
static String	TOKEN_ID
static String	VALIDATE_ACTION_ID

Constructor Summary

Constructors

Constructor and Description
SessionResource(SSOTokenManager ssoTokenManager, AuthUtilsWrapper authUtilsWrapper, SessionPropertyWhitelist sessionPropertyWhitelist, SessionResourceUtil sessionResourceUtil) Dependency Injection constructor allowing the SessionResource dependency to be provided.

Method Summary

Modifier and Type	Method and Description
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>	actionCollection(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request) Actions supported are: VALIDATE_ACTION_ID LOGOUT_ACTION_ID IS_ACTIVE_ACTION_ID GET_IDLE_ACTION_ID GET_MAX_IDLE_ACTION_ID GET_MAX_SESSION_TIME_ACTION_ID GET_MAX_TIME_ACTION_ID GET_TIME_LEFT_ACTION_ID GET_PROPERTY_ACTION_ID SET_PROPERTY_ACTION_ID DELETE_PROPERTY_ACTION_ID GET_PROPERTY_NAMES_ACTION_ID
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>	actionInstance(org.forgerock.services.context.Context context, String tokenId, org.forgerock.json.resource.ActionRequest request) Actions supported are: VALIDATE_ACTION_ID LOGOUT_ACTION_ID IS_ACTIVE_ACTION_ID GET_IDLE_ACTION_ID GET_MAX_IDLE_ACTION_ID GET_MAX_SESSION_TIME_ACTION_ID GET_MAX_TIME_ACTION_ID GET_TIME_LEFT_ACTION_ID GET_PROPERTY_ACTION_ID SET_PROPERTY_ACTION_ID DELETE_PROPERTY_ACTION_ID GET_PROPERTY_NAMES_ACTION_ID
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	createInstance(org.forgerock.services.context.Context ctx, org.forgerock.json.resource.CreateRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	deleteInstance(org.forgerock.services.context.Context ctx, String resId, org.forgerock.json.resource.DeleteRequest request)
Collection<String>	getAllServerIds() Returns a collection of all Server ID that are known to the OpenAM instance.
protected String	getTokenIdFromCookie(org.forgerock.services.context.Context context, String cookieName)
protected String	getTokenIdFromHeader(org.forgerock.services.context.Context context, String cookieName)
protected String	getTokenIdFromUrlParam(org.forgerock.json.resource.ActionRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	patchInstance(org.forgerock.services.context.Context ctx, String resId, org.forgerock.json.resource.PatchRequest request)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>	queryCollection(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request, org.forgerock.json.resource.QueryResourceHandler handler) Queries the session resources using one of the predefined query filters.
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	readInstance(org.forgerock.services.context.Context context, String id, org.forgerock.json.resource.ReadRequest request) Perform a read operation against a named session.
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	updateInstance(org.forgerock.services.context.Context ctx, String resId, org.forgerock.json.resource.UpdateRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATE_ACTION_ID

public static final String VALIDATE_ACTION_ID

See Also:

Constant Field Values

LOGOUT_ACTION_ID

public static final String LOGOUT_ACTION_ID

See Also:

Constant Field Values

IS_ACTIVE_ACTION_ID

public static final String IS_ACTIVE_ACTION_ID

See Also:

Constant Field Values

GET_IDLE_ACTION_ID

public static final String GET_IDLE_ACTION_ID

See Also:

Constant Field Values

GET_MAX_IDLE_ACTION_ID

public static final String GET_MAX_IDLE_ACTION_ID

See Also:

Constant Field Values

GET_MAX_SESSION_TIME_ACTION_ID

public static final String GET_MAX_SESSION_TIME_ACTION_ID

See Also:

Constant Field Values

KEYWORD_PROPERTIES

public static final String KEYWORD_PROPERTIES

See Also:

Constant Field Values

KEYWORD_SUCCESS

public static final String KEYWORD_SUCCESS

See Also:

Constant Field Values

GET_MAX_TIME_ACTION_ID

@Deprecated
public static final String GET_MAX_TIME_ACTION_ID

Deprecated. use getTimeLeft instead.

See Also:

Constant Field Values

GET_MAX_SESSION_TIME_ID

public static final String GET_MAX_SESSION_TIME_ID

See Also:

Constant Field Values

GET_TIME_LEFT_ACTION_ID

public static final String GET_TIME_LEFT_ACTION_ID

See Also:

Constant Field Values

GET_PROPERTY_ACTION_ID

public static final String GET_PROPERTY_ACTION_ID

See Also:

Constant Field Values

SET_PROPERTY_ACTION_ID

public static final String SET_PROPERTY_ACTION_ID

See Also:

Constant Field Values

DELETE_PROPERTY_ACTION_ID

public static final String DELETE_PROPERTY_ACTION_ID

See Also:

Constant Field Values

GET_PROPERTY_NAMES_ACTION_ID

public static final String GET_PROPERTY_NAMES_ACTION_ID

See Also:

Constant Field Values

KEYWORD_RESULT

public static final String KEYWORD_RESULT

See Also:

Constant Field Values

KEYWORD_ALL

public static final String KEYWORD_ALL

See Also:

Constant Field Values

KEYWORD_LIST

public static final String KEYWORD_LIST

See Also:

Constant Field Values

KEYWORD_SERVER_ID

public static final String KEYWORD_SERVER_ID

See Also:

Constant Field Values

TOKEN_ID

public static final String TOKEN_ID

See Also:

Constant Field Values

Constructor Detail

SessionResource

@Inject
public SessionResource(SSOTokenManager ssoTokenManager,
                               AuthUtilsWrapper authUtilsWrapper,
                               SessionPropertyWhitelist sessionPropertyWhitelist,
                               SessionResourceUtil sessionResourceUtil)

Dependency Injection constructor allowing the SessionResource dependency to be provided.

Parameters:

ssoTokenManager - An instance of the SSOTokenManager.

authUtilsWrapper - An instance of AuthUtilsWrapper

sessionPropertyWhitelist - An instance of sessionPropertyWhitelist.

sessionResourceUtil - An instance of the SessionResourceUtil.

Method Detail

getAllServerIds

public Collection<String> getAllServerIds()

Returns a collection of all Server ID that are known to the OpenAM instance.

Returns:

A non null, possibly empty collection of server ids.

actionCollection

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> actionCollection(org.forgerock.services.context.Context context,
                                                                                                                                                     org.forgerock.json.resource.ActionRequest request)

Actions supported are:

• VALIDATE_ACTION_ID
• LOGOUT_ACTION_ID
• IS_ACTIVE_ACTION_ID
• GET_IDLE_ACTION_ID
• GET_MAX_IDLE_ACTION_ID
• GET_MAX_SESSION_TIME_ACTION_ID
• GET_MAX_TIME_ACTION_ID
• GET_TIME_LEFT_ACTION_ID
• GET_PROPERTY_ACTION_ID
• SET_PROPERTY_ACTION_ID
• DELETE_PROPERTY_ACTION_ID
• GET_PROPERTY_NAMES_ACTION_ID

Specified by:

actionCollection in interface org.forgerock.json.resource.CollectionResourceProvider

Parameters:

context -

request -

getTokenIdFromUrlParam

protected String getTokenIdFromUrlParam(org.forgerock.json.resource.ActionRequest request)

getTokenIdFromCookie

protected String getTokenIdFromCookie(org.forgerock.services.context.Context context,
                                      String cookieName)

getTokenIdFromHeader

protected String getTokenIdFromHeader(org.forgerock.services.context.Context context,
                                      String cookieName)

actionInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> actionInstance(org.forgerock.services.context.Context context,
                                                                                                                                                   String tokenId,
                                                                                                                                                   org.forgerock.json.resource.ActionRequest request)

Actions supported are:

• VALIDATE_ACTION_ID
• LOGOUT_ACTION_ID
• IS_ACTIVE_ACTION_ID
• GET_IDLE_ACTION_ID
• GET_MAX_IDLE_ACTION_ID
• GET_MAX_SESSION_TIME_ACTION_ID
• GET_MAX_TIME_ACTION_ID
• GET_TIME_LEFT_ACTION_ID
• GET_PROPERTY_ACTION_ID
• SET_PROPERTY_ACTION_ID
• DELETE_PROPERTY_ACTION_ID
• GET_PROPERTY_NAMES_ACTION_ID

Specified by:

actionInstance in interface org.forgerock.json.resource.CollectionResourceProvider

Parameters:

context -

tokenId - The SSO Token Id.

request -

queryCollection

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException> queryCollection(org.forgerock.services.context.Context context,
                                                                                                                                                   org.forgerock.json.resource.QueryRequest request,
                                                                                                                                                   org.forgerock.json.resource.QueryResourceHandler handler)

Queries the session resources using one of the predefined query filters. all - (default) will query all Sessions across all servers. list - will list the available servers which is useful for the next query [server-id] - will list the available Sessions on the named server.

Specified by:

queryCollection in interface org.forgerock.json.resource.CollectionResourceProvider

Parameters:

context -

request -

handler -

readInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> readInstance(org.forgerock.services.context.Context context,
                                                                                                                                                   String id,
                                                                                                                                                   org.forgerock.json.resource.ReadRequest request)

Perform a read operation against a named session.

Specified by:

readInstance in interface org.forgerock.json.resource.CollectionResourceProvider

createInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> createInstance(org.forgerock.services.context.Context ctx,
                                                                                                                                                     org.forgerock.json.resource.CreateRequest request)

Specified by:

createInstance in interface org.forgerock.json.resource.CollectionResourceProvider

deleteInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> deleteInstance(org.forgerock.services.context.Context ctx,
                                                                                                                                                     String resId,
                                                                                                                                                     org.forgerock.json.resource.DeleteRequest request)

Specified by:

deleteInstance in interface org.forgerock.json.resource.CollectionResourceProvider

patchInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> patchInstance(org.forgerock.services.context.Context ctx,
                                                                                                                                                    String resId,
                                                                                                                                                    org.forgerock.json.resource.PatchRequest request)

Specified by:

patchInstance in interface org.forgerock.json.resource.CollectionResourceProvider

updateInstance

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> updateInstance(org.forgerock.services.context.Context ctx,
                                                                                                                                                     String resId,
                                                                                                                                                     org.forgerock.json.resource.UpdateRequest request)

Specified by:

updateInstance in interface org.forgerock.json.resource.CollectionResourceProvider