com.sun.identity.saml.assertion

Class Assertion

java.lang.Object

com.sun.identity.saml.assertion.AssertionBase

com.sun.identity.saml.assertion.Assertion

Direct Known Subclasses:

FSAssertion, SecurityAssertion

public class Assertion
extends AssertionBase

This object stands for Assertion element. An Assertion is a package of information that supplies one or more Statement made by an issuer. There are three kinds of assertionsL Authentication, AuthorizationDecision and Attribute assertion.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Assertion() Default constructor Declaring protected to enable extensibility
	Assertion(Element assertionElement) Contructs Assertion object from a block of existing XML that has already been built into a DOM.
	Assertion(String assertionID, String issuer, Date issueInstant, Conditions conditions, Advice advice, Set statements) Contructs Assertion object and populate the data members: the ssertionID, the issuer, time when assertion issued, the conditions when creating a new assertion , Advice applicable to this Assertion and a set of Statement(s) in the assertion.
	Assertion(String assertionID, String issuer, Date issueInstant, Conditions conditions, Set statements) Contructs Assertion object and populate the data members: the assertionID, the issuer, time when assertion issued, the conditions when creating a new assertion and a set of Statement(s) in the assertion.
	Assertion(String assertionID, String issuer, Date issueInstant, Set statements) Contructs Assertion object and populate the data members: assertionID, the issuer, time when assertion issued and a set of Statement(s) in the assertion.

Method Summary

Modifier and Type	Method and Description
protected AdviceBase	createAdvice(Element adviceElement) Creates appropriate Advice instance
protected AssertionIDReference	createAssertionIDReference(Element assertionIDRefElement) Creates appropriate AssertionIDReference instance
protected AssertionIDReference	createAssertionIDReference(String assertionID) Creates appropriate AssertionIDReference instance
protected AttributeStatement	createAttributeStatement(Element attributeElement) Creates appropriate AttributeStatement instance
protected AuthenticationStatement	createAuthenticationStatement(Element authenticationElement) Creates appropriate AuthenticationStatement instance
protected AuthorizationDecisionStatementBase	createAuthorizationDecisionStatement(Element authDecisionElement) Create appropriate AuthorizationDecisionStatement instance
protected Conditions	createConditions(Element conditionsElement) Creates appropriate Conditions instance
Advice	getAdvice() Returns the advice of an assertion.
protected int	getMaxAssertionMinorVersion()
protected int	getMinAssertionMinorVersion()
boolean	isSignatureValid() Returns whether the signature on the object is valid or not.
protected void	parseAssertionElement(Element assertionElement)
protected boolean	processUnknownElement(Element element)
void	signXML() Signs the Assertion.
void	signXML(String certAlias) Signs the Assertion.

Methods inherited from class com.sun.identity.saml.assertion.AssertionBase

addStatement, getAssertionID, getConditions, getIssueInstant, getIssuer, getMajorVersion, getMinorVersion, getSignature, getStatement, isSigned, isTimeValid, setAdvice, setAssertionID, setConditions, setIssueInstant, setIssuer, setMajorVersion, setMinorVersion, setSignature, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Assertion

protected Assertion()

Default constructor Declaring protected to enable extensibility

Assertion

public Assertion(Element assertionElement)
          throws SAMLException

Contructs Assertion object from a block of existing XML that has already been built into a DOM.

Parameters:

assertionElement - A org.w3c.dom.Element representing DOM tree for Assertion object

Throws:

SAMLException - if it could not process the Element properly, implying that there is an error in the sender or in the element definition.

Assertion

public Assertion(String assertionID,
                 String issuer,
                 Date issueInstant,
                 Set statements)
          throws SAMLException

Contructs Assertion object and populate the data members: assertionID, the issuer, time when assertion issued and a set of Statement(s) in the assertion.

Parameters:

assertionID - assertionID attribute contained within this Assertion if null, an assertionID is generated internally.

issuer - The issuer of this assertion.

issueInstant - time instant of the issue. It has type dateTime which is built in to the W3C XML Schema Types specification.if null, current time is used.

statements - set of Statement objects within this Assertion. It could be of type AuthenticationStatement, AuthorizationDecisionStatement and AttributeStatement. Each Assertion can have multiple type of statements in it.

Throws:

SAMLException - if there is an error in processing input.

Assertion

public Assertion(String assertionID,
                 String issuer,
                 Date issueInstant,
                 Conditions conditions,
                 Set statements)
          throws SAMLException

Contructs Assertion object and populate the data members: the assertionID, the issuer, time when assertion issued, the conditions when creating a new assertion and a set of Statement(s) in the assertion.

Parameters:

assertionID - AssertionID contained within this Assertion if null its generated internally.

issuer - The issuer of this assertion.

issueInstant - time instant of the issue. It has type dateTime which is built in to the W3C XML Schema Types specification. if null, current time is used.

conditions - Conditions under which the this Assertion is valid.

statements - Set of Statement objects within this Assertion. It could be of type AuthenticationStatement, AuthorizationDecisionStatement and AttributeStatement. Each Assertion can have multiple type of statements in it.

Throws:

SAMLException - if there is an error in processing input.

Assertion

public Assertion(String assertionID,
                 String issuer,
                 Date issueInstant,
                 Conditions conditions,
                 Advice advice,
                 Set statements)
          throws SAMLException

Contructs Assertion object and populate the data members: the ssertionID, the issuer, time when assertion issued, the conditions when creating a new assertion , Advice applicable to this Assertion and a set of Statement(s) in the assertion.

Parameters:

assertionID - AssertionID object contained within this Assertion if null its generated internally.

issuer - The issuer of this assertion.

issueInstant - Time instant of the issue. It has type dateTime which is built in to the W3C XML Schema Types specification. if null, current time is used.

conditions - Conditions under which the this Assertion is valid.

advice - Advice applicable for this Assertion.

statements - Set of Statement objects within this Assertion. It could be of type AuthenticationStatement, AuthorizationDecisionStatement and AttributeStatement. Each Assertion can have multiple type of statements in it.

Throws:

SAMLException - if there is an error in processing input.

Method Detail

isSignatureValid

public boolean isSignatureValid()

Returns whether the signature on the object is valid or not.

Overrides:

isSignatureValid in class AssertionBase

Returns:

true if the signature on the object is valid; false otherwise.

signXML

public void signXML()
             throws SAMLException

Signs the Assertion.

Overrides:

signXML in class AssertionBase

Throws:

SAMLException - If it could not sign the Assertion.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the Assertion.

Overrides:

signXML in class AssertionBase

Parameters:

certAlias - certification Alias used to sign Assertion.

Throws:

SAMLException - if it could not sign the Assertion.

parseAssertionElement

protected void parseAssertionElement(Element assertionElement)
                              throws SAMLException

Throws:

SAMLException

getAdvice

public Advice getAdvice()

Returns the advice of an assertion.

Returns:

Advice object containing advice information of the assertion.

createAdvice

protected AdviceBase createAdvice(Element adviceElement)
                           throws SAMLException

Description copied from class: AssertionBase

Creates appropriate Advice instance

Specified by:

createAdvice in class AssertionBase

Parameters:

adviceElement - the Advice Element

Returns:

the Advice instance

Throws:

SAMLException

createAuthorizationDecisionStatement

protected AuthorizationDecisionStatementBase createAuthorizationDecisionStatement(Element authDecisionElement)
                                                                           throws SAMLException

Description copied from class: AssertionBase

Create appropriate AuthorizationDecisionStatement instance

Specified by:

createAuthorizationDecisionStatement in class AssertionBase

Parameters:

authDecisionElement - the AuthorizationDecisionStatement Element

Returns:

AuthorizationDecisionStatement instance

Throws:

SAMLException

createAuthenticationStatement

protected AuthenticationStatement createAuthenticationStatement(Element authenticationElement)
                                                         throws SAMLException

Description copied from class: AssertionBase

Creates appropriate AuthenticationStatement instance

Specified by:

createAuthenticationStatement in class AssertionBase

Parameters:

authenticationElement - the AuthenticationStatement Element

Returns:

AuthenticationStatement instance

Throws:

SAMLException

createAttributeStatement

protected AttributeStatement createAttributeStatement(Element attributeElement)
                                               throws SAMLException

Description copied from class: AssertionBase

Creates appropriate AttributeStatement instance

Specified by:

createAttributeStatement in class AssertionBase

Parameters:

attributeElement - the AttributeStatement Element

Returns:

AttributeStatement instance

Throws:

SAMLException

createAssertionIDReference

protected AssertionIDReference createAssertionIDReference(Element assertionIDRefElement)
                                                   throws SAMLException

Description copied from class: AssertionBase

Creates appropriate AssertionIDReference instance

Specified by:

createAssertionIDReference in class AssertionBase

Parameters:

assertionIDRefElement - the AssertionIDReference Element

Returns:

AssertionIDReference instance

Throws:

SAMLException

createAssertionIDReference

protected AssertionIDReference createAssertionIDReference(String assertionID)
                                                   throws SAMLException

Description copied from class: AssertionBase

Creates appropriate AssertionIDReference instance

Specified by:

createAssertionIDReference in class AssertionBase

Parameters:

assertionID - the AssertionID String

Returns:

AssertionIDReference instance

Throws:

SAMLException

createConditions

protected Conditions createConditions(Element conditionsElement)
                               throws SAMLException

Description copied from class: AssertionBase

Creates appropriate Conditions instance

Specified by:

createConditions in class AssertionBase

Parameters:

conditionsElement - the Conditions Element

Returns:

Conditions instance

Throws:

SAMLException

processUnknownElement

protected boolean processUnknownElement(Element element)
                                 throws SAMLException

Throws:

SAMLException

getMinAssertionMinorVersion

protected int getMinAssertionMinorVersion()

getMaxAssertionMinorVersion

protected int getMaxAssertionMinorVersion()