Package com.sun.identity.federation.services

Class FSAssertionManagerClient

java.lang.Object

com.sun.identity.federation.services.FSAssertionManagerClient

public final class FSAssertionManagerClient
extends Object

The class FSAssertionManagerClient is a final class that provides interfaces to create, get and destroy Assertions.

The class provides mechanisms to manage the Assertions either locally (i.e., within the same JVM process) or remotely on another instance of OpenAM. The default constructor will manage the Assertions locally if it detects SAML web services running locally, else will use one of the configured OpenAM. The constructor which accepts an URL will always use the URL to manage the assertions.

Having obtained an instance of FSAssertionManagerClient, its methods can be called to create/get Assertion, and AssertionArtifact, and to obtain decision from an Query.

Constructor Summary

Constructors

Constructor	Description
FSAssertionManagerClient(String metaAlias)	Returns an instance of AssertionManagerClient.
FSAssertionManagerClient(String metaAlias, String url)	Returns an instance of FSAssertionManagerClient that will use the provided URL for the management of assertions.

Method Summary

Modifier and Type	Method	Description
protected Assertion	getAssertion(AssertionArtifact artifact, String destID)	Returns assertion associated with the AssertionArtifact.
protected String	getDestIdForArtifact(AssertionArtifact artifact)	Returns the destination id the artifact is created for.
protected Status	getErrorStatus(AssertionArtifact artifact)
boolean	isUserExists(String userDN)	Checks if the user exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSAssertionManagerClient

public FSAssertionManagerClient(String metaAlias)
                         throws FSException

Returns an instance of AssertionManagerClient.

Parameters:

metaAlias - hosted provider's meta alias.

Throws:

FSException

FSAssertionManagerClient

public FSAssertionManagerClient(String metaAlias,
                                String url)
                         throws FSException

Returns an instance of FSAssertionManagerClient that will use the provided URL for the management of assertions.

Parameters:

metaAlias - hosted provider's meta alias.

url - the FSAssertionManager service URL that will be used to create, get and delete Assertions

Throws:

FSException

Method Detail

getAssertion

protected Assertion getAssertion(AssertionArtifact artifact,
                                 String destID)
                          throws FSException

Returns assertion associated with the AssertionArtifact.

Parameters:

artifact - An AssertionArtifact.

destID - The destination site requesting the assertion using the artifact. This String is compared with the destID that the artifact is created for originally.

Returns:

The Assertion referenced to by artifact.

Throws:

FSException - If an error occurred during the process, or no assertion maps to the input artifact.

getDestIdForArtifact

protected String getDestIdForArtifact(AssertionArtifact artifact)
                               throws FSException

Returns the destination id the artifact is created for.

Parameters:

artifact - AssertionArtifact object

Returns:

destination id

Throws:

FSException - if error occurred.

isUserExists

public boolean isUserExists(String userDN)
                     throws FSException

Checks if the user exists.

Parameters:

userDN - user ID

Returns:

true if the user exists; false otherwise.

Throws:

FSException - if error occurred.

getErrorStatus

protected Status getErrorStatus(AssertionArtifact artifact)
                         throws FSException

Throws:

FSException