com.sun.identity.federation.message
Class FSAssertion

java.lang.Object
  com.sun.identity.saml.assertion.AssertionBase
      com.sun.identity.saml.assertion.Assertion
          com.sun.identity.federation.message.FSAssertion

public class FSAssertion
extends Assertion

The class FSAssertion creates and parses Liberty Assertion during the Single Sign-On process. This class extends from SAML Assertion.

Field Summary

protected String	id The value of the id attribute in the Assertion.
protected String	inResponseTo The value of the InResponseTo attribute in the Assertion.
protected int	minorVersion The value of the MinorVersion attribute in the Assertion.

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

_advice, _assertionID, _conditions, _issueInstant, _issuer, _majorVersion, _minorVersion, _statements, ASSERTION_ID_ATTRIBUTE, signatureString, signed, valid, validationDone, xmlString

Constructor Summary

FSAssertion(Element assertionElement)
Constructor to create an FSAssertion object from the Document Element.

FSAssertion(String assertionID, String issuer, Date issueInstant, Conditions conditions, Advice advice, Set statements, String inResponseTo)
Constructor to create an FSAssertion object.

FSAssertion(String assertionID, String issuer, Date issueInstant, Conditions conditions, Set statements, String inResponseTo)
Constructor to create FSAssertion object.

FSAssertion(String assertionID, String issuer, Date issueInstant, Set statements, String inResponseTo)
Constructor to create FSAssertion object.

Method Summary

boolean	addStatement(Statement statement) Adds the Statement object to the Statment's object Set.
List	getDiscoveryCredential() Returns the discovery service credentials from the boot strap.
Element	getDOMElement() Returns the Document Element for this object.
String	getID() Returns value of id attribute.
String	getInResponseTo() Returns the value of InResponseTo attribute.
int	getMinorVersion() Returns the MinorVersion attribute.
String	getSignatureString() Returns the Signature string.
String	getSignedXMLString() Returns Signed XML String.
boolean	isTimeValid() Checks validity of time in the assertion.
void	parseAdvice(Element element) Parses the advice element to extract the Security Assertion.
void	setID(String id) Sets value of id attribute.
void	setInResponseTo(String inResponseTo) Sets the value of InResponseTo attribute.
void	setMinorVersion(int version) Sets the MinorVersion attribute.
boolean	setSignature(Element elem) Sets the Element's signature.
void	signXML(String certAlias) Signs the Assertion.
String	toXMLString() Returns a XML String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a XML String representation of this object.

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

createAdvice, createAssertionIDReference, createAssertionIDReference, createAttributeStatement, createAuthenticationStatement, createAuthorizationDecisionStatement, createConditions, getAdvice, getMaxAssertionMinorVersion, getMinAssertionMinorVersion, isSignatureValid, parseAssertionElement, processUnknownElement, signXML

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

getAssertionID, getConditions, getIssueInstant, getIssuer, getMajorVersion, getSignature, getStatement, isSigned, setAdvice, setAssertionID, setConditions, setIssueInstant, setIssuer, setMajorVersion, toString, toString

Field Detail

id

protected String id

The value of the id attribute in the Assertion.

minorVersion

protected int minorVersion

The value of the MinorVersion attribute in the Assertion.

inResponseTo

protected String inResponseTo

The value of the InResponseTo attribute in the Assertion.

Constructor Detail

FSAssertion

public FSAssertion(Element assertionElement)
            throws FSMsgException,
                   SAMLException

Constructor to create an FSAssertion object from the Document Element.

Parameters:

assertionElement - the Assertion Document Element.

Throws:

FSMsgException - if the document element is null or cannot be retrieved.

SAMLException - if the SAML Assertion version is incorrect

FSAssertion

public FSAssertion(String assertionID,
                   String issuer,
                   Date issueInstant,
                   Set statements,
                   String inResponseTo)
            throws FSMsgException,
                   SAMLException

Constructor to create FSAssertion object.

Parameters:

assertionID - the AssertionID element.

issuer - the Issuer element.

issueInstant - the IssueInstant element.

statements - the Statement elements. List of statements that need to be added in assertion.

inResponseTo - value of InResponseTo attribute in the assertion.

Throws:

FSMsgException - if the document element is null or cannot be retrieved.

SAMLException - if the SAML Assertion version is incorrect.

FSAssertion

public FSAssertion(String assertionID,
                   String issuer,
                   Date issueInstant,
                   Conditions conditions,
                   Set statements,
                   String inResponseTo)
            throws FSMsgException,
                   SAMLException

Constructor to create FSAssertion object.

Parameters:

assertionID - the AssertionID element.

issuer - the Issuer element.

issueInstant - the IssueInstant element.

conditions - the Conditions object.

statements - the Statement elements. List of statements that need to be added in assertion.

inResponseTo - value of InResponseTo attribute in the assertion.

Throws:

FSMsgException - if the document element is null or cannot be retrieved.

SAMLException - if the SAML Assertion version is incorrect.

FSAssertion

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

Constructor to create an FSAssertion object.

Parameters:

assertionID - the AssertionID element.

issuer - the Issuer element.

issueInstant - the IssueInstant element.

conditions - the Conditions object.

advice - the Advice object.

statements - the Statement elements. List of statements that need to be added in assertion.

inResponseTo - value of InResponseTo attribute in the assertion.

Throws:

FSMsgException - if the document element is null or cannot be retrieved.

SAMLException - if the SAML Assertion version is incorrect.

Method Detail

getID

public String getID()

Returns value of id attribute.

Returns:

value of id attribute.

See Also:

FSAssertion.setID(String)

setID

public void setID(String id)

Sets value of id attribute.

Parameters:

id - value of id attribute.

See Also:

FSAssertion.getID()

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion attribute.

Overrides:

getMinorVersion in class AssertionBase

Returns:

the MinorVersion attribute.

See Also:

FSAssertion.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the MinorVersion attribute.

Overrides:

setMinorVersion in class AssertionBase

Parameters:

version - the MinorVersion attribute.

See Also:

FSAssertion.getMinorVersion()

getDOMElement

public Element getDOMElement()

Returns the Document Element for this object.

Returns:

the Document Element for this object.

getInResponseTo

public String getInResponseTo()

Returns the value of InResponseTo attribute.

Returns:

the value of InResponseTo attribute.

See Also:

FSAssertion.setInResponseTo(String)

setInResponseTo

public void setInResponseTo(String inResponseTo)

Sets the value of InResponseTo attribute.

Parameters:

inResponseTo - value of InResponseTo attribute.

See Also:

FSAssertion.getInResponseTo()

getSignedXMLString

public String getSignedXMLString()

Returns Signed XML String.

Returns:

Signed XML String.

getSignatureString

public String getSignatureString()

Returns the Signature string.

Returns:

the Signature string.

isTimeValid

public boolean isTimeValid()

Checks validity of time in the assertion.

Overrides:

isTimeValid in class AssertionBase

Returns:

true if time is valid otherwise false.

addStatement

public boolean addStatement(Statement statement)

Adds the Statement object to the Statment's object Set.

Overrides:

addStatement in class AssertionBase

Parameters:

statement - the Statement object.

Returns:

false if statement is null else true.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a XML String representation of this object.

Returns:

a String representation of this Object.

Throws:

FSMsgException - if there is an error creating the XML string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Returns a XML String representation of this object.

Parameters:

includeNS - determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - determines whether or not the namespace is declared within the Element.

Returns:

a string containing the valid XML for this object.

Throws:

FSMsgException - if there is an error creating the XML string.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the Assertion.

Overrides:

signXML in class Assertion

Parameters:

certAlias - the alias/name of the certificate.

Throws:

SAMLException - if FSAssertion cannot be signed.

setSignature

public boolean setSignature(Element elem)

Sets the Element's signature.

Overrides:

setSignature in class AssertionBase

Parameters:

elem - the Element object

Returns:

true if signature is set otherwise false

parseAdvice

public void parseAdvice(Element element)

Parses the advice element to extract the Security Assertion.

Parameters:

element - the Advice Element.

getDiscoveryCredential

public List getDiscoveryCredential()

Returns the discovery service credentials from the boot strap.

Returns:

the discovery service credentials from the boot strap.