Package com.sun.identity.saml2.plugins.scripted

Class IdpAdapterScriptHelper

java.lang.Object

com.sun.identity.saml2.plugins.scripted.IdpAdapterScriptHelper

@EvolvingAll
@Singleton
public class IdpAdapterScriptHelper
extends Object

Provides helper functions for IDP Adapter Script Implementations.

Constructor Summary

Constructors

Constructor	Description
IdpAdapterScriptHelper()

Method Summary

Modifier and Type	Method	Description
List<ScriptEntitlementInfo>	getEntitlements(String applicationName, String realm, Object sessionToken, AuthnRequest authnRequest)	Retrieve a List of ScriptEntitlementInfos.
List<ScriptEntitlementInfo>	getEntitlements(String applicationName, String realm, Subject subject, Set<String> resources)	Retrieve a List of ScriptEntitlementInfos.
List<ScriptEntitlementInfo>	getEntitlements(String applicationName, String realm, Subject subject, Set<String> resources, Map<String,Set<String>> environment)	Retrieve a List of ScriptEntitlementInfos.
Evaluator	getEvaluatorForSubject(String applicationName, Subject subject)	Retrieve Evaluator for an application and Subject.
String	getIssuerName(AuthnRequest authnRequest)	Retrieve the issuer name for the AuthN request.
Set<String>	getResourcesForToken(AuthnRequest authnRequest)	Retrieve the issuer name from the AuthN request, within a Singleton Set.
Subject	getSubjectForToken(SSOToken sessionToken)	Retrieve Subject for an SSOToken.
Subject	getSubjectForToken(Object sessionToken)	Retrieve Subject for an SSOToken.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdpAdapterScriptHelper

public IdpAdapterScriptHelper()

Method Detail

getIssuerName

public String getIssuerName(AuthnRequest authnRequest)

Retrieve the issuer name for the AuthN request.

Parameters:

authnRequest - the AuthN request

Returns:

the issuer name

getResourcesForToken

public Set<String> getResourcesForToken(AuthnRequest authnRequest)

Retrieve the issuer name from the AuthN request, within a Singleton Set.

Parameters:

authnRequest - the AuthnRequest

Returns:

the resources for the AuthN token

getSubjectForToken

public Subject getSubjectForToken(Object sessionToken)

Retrieve Subject for an SSOToken.

Parameters:

sessionToken - the SSO Token of type Object

Returns:

the Subject associated with the SSO Token

getSubjectForToken

public Subject getSubjectForToken(SSOToken sessionToken)

Retrieve Subject for an SSOToken.

Parameters:

sessionToken - the SSOToken

Returns:

the Subject associated with the SSO Token

getEvaluatorForSubject

public Evaluator getEvaluatorForSubject(String applicationName,
                                        Subject subject)

Retrieve Evaluator for an application and Subject.

Parameters:

applicationName - the name of the application

subject - the Subject

Returns:

a newly created Evaluator for the given name and subject

getEntitlements

public List<ScriptEntitlementInfo> getEntitlements(String applicationName,
                                                   String realm,
                                                   Object sessionToken,
                                                   AuthnRequest authnRequest)
                                            throws EntitlementException

Retrieve a List of ScriptEntitlementInfos.

Parameters:

applicationName - the application name

realm - the realm

sessionToken - the session token

authnRequest - the AuthnRequest

Returns:

the List of ScriptEntitlementInfos

Throws:

EntitlementException - if an error occurs when evaluating the entitlement information.

getEntitlements

public List<ScriptEntitlementInfo> getEntitlements(String applicationName,
                                                   String realm,
                                                   Subject subject,
                                                   Set<String> resources)
                                            throws EntitlementException

Retrieve a List of ScriptEntitlementInfos.

Parameters:

applicationName - the application name to retrieve the entitlement information for

realm - the realm to evaluate

subject - the Subject to retrieve the entitlement information for

resources - the Set of resources to evaluate

Returns:

the List of ScriptEntitlementInfos

Throws:

EntitlementException - if an error occurs when evaluating the entitlement information.

getEntitlements

public List<ScriptEntitlementInfo> getEntitlements(String applicationName,
                                                   String realm,
                                                   Subject subject,
                                                   Set<String> resources,
                                                   Map<String,Set<String>> environment)
                                            throws EntitlementException

Retrieve a List of ScriptEntitlementInfos.

Parameters:

applicationName - the application name to retrieve the entitlement information for

realm - the realm to evaluate

subject - the Subject to retrieve the entitlement information for

resources - the Set of resources to evaluate

environment - the environment parameters used in the evaluation

Returns:

the List of ScriptEntitlementInfos

Throws:

EntitlementException - if an error occurs when evaluating the entitlement information.