| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.sun.identity.saml.AssertionManager
The class AssertionManager is a final class
 that provides interfaces to create, get and destroy Assertions.
 
 It is a singleton class; an instance of this class can be obtained by
 calling AssertionManager.getInstance().
 
 Having obtained an instance of AssertionManager, its methods
 can be called to create/get Assertion, and 
 AssertionArtifact, and to obtain decision from an 
 Query.
 
This class could only be used in the same JVM as the Access Manager.
| Method Summary | |
|  Assertion | createAssertion(SSOToken token)This method creates an Assertion that contains an AuthenticationStatement. | 
|  Assertion | createAssertion(SSOToken token,
                java.util.List attributes)This method creates an Assertion that contains an AuthenticationStatementand 
 anAttributeStatement. | 
|  AssertionArtifact | createAssertionArtifact(Assertion assertion,
                        java.lang.String destID)This method creates an AssertionArtifactfor the given
 Assertion. | 
|  Assertion | getAssertion(AssertionIDReference idRef,
             java.util.Set destID)Gets the Assertion referenced by an AssertionIDReference. | 
|  Assertion | getAssertion(AssertionIDReference idRef,
             SSOToken token)Gets the Assertion referenced by an AssertionIDReference. | 
|  Assertion | getAssertion(AssertionIDReference idRef,
             java.lang.String destID)Gets the Assertion referenced by an AssertionIDReference. | 
|  java.util.Set | getAssertionArtifacts(SSOToken token)This method gets all valid AssertionArtifactsmanaged by thisAssertionManager. | 
|  java.util.Set | getAssertions(SSOToken token)This method gets all valid Assertions managed by this AssertionManager. | 
| static AssertionManager | getInstance()Gets the singleton instance of AssertionManager. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Method Detail | 
public static AssertionManager getInstance()
                                    throws SAMLException
AssertionManager.AssertionManager instanceSAMLException - if unable to get the singleton
         AssertionManager instance.
public Assertion createAssertion(SSOToken token)
                          throws SAMLException
AuthenticationStatement.token - The SSO token that contains authentication information which
        is needed to create the AuthenticationStatement.SAMLException - If the Assertion cannot be created.
public Assertion createAssertion(SSOToken token,
                                 java.util.List attributes)
                          throws SAMLException
AuthenticationStatement and 
 an AttributeStatement.token - The SSO token that contains authentication information which
        is needed to create the AuthenticationStatement
        for the Assertion.attributes - A list of Attribute objects which are used to create the 
        AttributeStatement for the Assertion.SAMLException - If the Assertion cannot be created.
public AssertionArtifact createAssertionArtifact(Assertion assertion,
                                                 java.lang.String destID)
                                          throws SAMLException
AssertionArtifact for the given
 Assertion.assertion - The Assertion for which an Artifact needs to be created.destID - The sourceID of the site for which the 
        AssertionArtifact is created. It is in raw String
        format (not Base64 encoded, for example.) This String can be
        obtained from converting the 20 bytes sequence to char Array, then
        from the char Array to String.AssertionArtifactSAMLException - If the AssertionArtifact cannot be
         created.
public java.util.Set getAssertions(SSOToken token)
                            throws SAMLException
AssertionManager.token - The single sign on token which is allowed to get all
        Assertion.SAMLException - If this method can not gets all valid Assertions.
public java.util.Set getAssertionArtifacts(SSOToken token)
                                    throws SAMLException
AssertionArtifacts
 managed by this AssertionManager.token - The single sign on token which is allowed to get all
        AssertionArtifacts.AssertionArtifacts. Each element in
         the Set is an AssertionArtifacts object representing
         an artifact.SAMLException - If this method can not gets all valid 
         AssertionArtifacts.
public Assertion getAssertion(AssertionIDReference idRef,
                              SSOToken token)
                       throws SAMLException
AssertionIDReference.
 This method is usually used after the call
 AssertionManager.getAssertions(SSOToken).
 The assertion is retrieved from this AssertionManager only.idRef - The AssertionIDReference which references to an
        Assertion.token - The single sign on token that is allowed to obtain the
        assertion. This token must have top level administrator role.AsertionIDReference.SAMLException - If an error occurred during the process; the token
         does not have the privilege; or the assertion could not be
         found.
public Assertion getAssertion(AssertionIDReference idRef,
                              java.lang.String destID)
                       throws SAMLException
AssertionIDReference.idRef - The AssertionIDReference which references to an
        Assertion.destID - The destination site id requesting the assertion using
 	      the assertion id reference. This String is compared with the
	      destID that the assertion is created for originally.
        This field is not used (could be null) if the assertion was
        created without a destID originally. This String can
        be obtained from converting the 20 byte site id sequence to char
        array, then a new String from the char array.AsertionIDReference.SAMLException - If an error occurred during the process; or
		the assertion could not be found.
public Assertion getAssertion(AssertionIDReference idRef,
                              java.util.Set destID)
                       throws SAMLException
AssertionIDReference.idRef - The AssertionIDReference which references to an
        Assertion.destID - A Set of destination site id. The destination site id
        requesting the assertion using the assertion id reference.
        This String is compared with the destID that the
        assertion is created for originally. This field is not used
        (could be null) if the assertion was created without a
        destID originally. This String can be obtained from
	      converting the 20 byte site id sequence to char array, then a new
        String from the char array.AsertionIDReference.SAMLException - If an error occurred during the process; or
		the assertion could not be found.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||