com.sun.identity.saml.plugins

Interface ActionMapper

All Known Implementing Classes:

DefaultActionMapper

public interface ActionMapper

The class ActionMapper is an interface that is implemented to get SSO information and map partner actions to OpenAM authorization decisions.

A different implementation of the interface may be developed for different partner. The mapping between the partner source ID and the implementation class are configured at the Trusted Partner Sites field in SAML service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DENY Key to hold a list of actions that are denied.
static String	INDETERMINATE Key to hold a list of actions that are indeterminate.
static String	PERMIT Key to hold a list of actions that are permitted.

Method Summary

Modifier and Type	Method and Description
Map	getAuthorizationDecisions(AuthorizationDecisionQuery query, Object token, String sourceID) Returns Action Decisions for the user.
Assertion	getSSOAssertion(AuthorizationDecisionQuery query, String sourceID) Returns the Assertion that contains Authentication information that can be used to obtain single sign on token.
String	getSSOTokenID(AuthorizationDecisionQuery query) Returns the single sign on token id to OpenAM from the query.

Field Detail

PERMIT

static final String PERMIT

Key to hold a list of actions that are permitted.

See Also:

Constant Field Values

DENY

static final String DENY

Key to hold a list of actions that are denied.

See Also:

Constant Field Values

INDETERMINATE

static final String INDETERMINATE

Key to hold a list of actions that are indeterminate.

See Also:

Constant Field Values

Method Detail

getSSOTokenID

String getSSOTokenID(AuthorizationDecisionQuery query)

Returns the single sign on token id to OpenAM from the query.

Parameters:

query - The received AuthorizationDecisionQuery.

Returns:

String which is the single sign on token ID. Return null if the OpenAM single sign on token id could not be obtained from the query.

getSSOAssertion

Assertion getSSOAssertion(AuthorizationDecisionQuery query,
                          String sourceID)

Returns the Assertion that contains Authentication information that can be used to obtain single sign on token.

Parameters:

query - The received AuthorizationDecisionQuery.

sourceID - The SourceID from which this query is coming from.

Returns:

Assertion The assertion contained inside the query.

getAuthorizationDecisions

Map getAuthorizationDecisions(AuthorizationDecisionQuery query,
                              Object token,
                              String sourceID)
                       throws SAMLException

Returns Action Decisions for the user. The returned Map is subject to changes per SAML specification.

Parameters:

query - The received AuthorizationDecisionQuery.

token - User sessioin to retrieve the decisions.

sourceID - The sourceID from which the query is coming from.

Returns:

Map which contains the following possible key value pairs:

• PERMIT List of permitted actions, or
• DENY List of denied actions, or
• INDETERMINATE List of indeterminate actions

Throws:

SAMLException - if an error occurs