com.sun.identity.federation.message
クラス 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.

フィールドの概要

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.

クラス com.sun.identity.saml.assertion.AssertionBase から継承されたフィールド

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

コンストラクタの概要

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.

メソッドの概要

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.

クラス com.sun.identity.saml.assertion.Assertion から継承されたメソッド

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

クラス com.sun.identity.saml.assertion.AssertionBase から継承されたメソッド

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

フィールドの詳細

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.

コンストラクタの詳細

FSAssertion

public FSAssertion(Element assertionElement)
            throws FSMsgException,
                   SAMLException

Constructor to create an FSAssertion object from the Document Element.

パラメータ:

assertionElement - the Assertion Document Element.

例外:

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.

パラメータ:

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.

例外:

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.

パラメータ:

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.

例外:

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.

パラメータ:

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.

例外:

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

SAMLException - if the SAML Assertion version is incorrect.

メソッドの詳細

getID

public String getID()

Returns value of id attribute.

戻り値:

value of id attribute.

関連項目:

FSAssertion.setID(String)

setID

public void setID(String id)

Sets value of id attribute.

パラメータ:

id - value of id attribute.

関連項目:

FSAssertion.getID()

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion attribute.

オーバーライド:

クラス AssertionBase 内の getMinorVersion

戻り値:

the MinorVersion attribute.

関連項目:

FSAssertion.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the MinorVersion attribute.

オーバーライド:

クラス AssertionBase 内の setMinorVersion

パラメータ:

version - the MinorVersion attribute.

関連項目:

FSAssertion.getMinorVersion()

getDOMElement

public Element getDOMElement()

Returns the Document Element for this object.

戻り値:

the Document Element for this object.

getInResponseTo

public String getInResponseTo()

Returns the value of InResponseTo attribute.

戻り値:

the value of InResponseTo attribute.

関連項目:

FSAssertion.setInResponseTo(String)

setInResponseTo

public void setInResponseTo(String inResponseTo)

Sets the value of InResponseTo attribute.

パラメータ:

inResponseTo - value of InResponseTo attribute.

関連項目:

FSAssertion.getInResponseTo()

getSignedXMLString

public String getSignedXMLString()

Returns Signed XML String.

戻り値:

Signed XML String.

getSignatureString

public String getSignatureString()

Returns the Signature string.

戻り値:

the Signature string.

isTimeValid

public boolean isTimeValid()

Checks validity of time in the assertion.

オーバーライド:

クラス AssertionBase 内の isTimeValid

戻り値:

true if time is valid otherwise false.

addStatement

public boolean addStatement(Statement statement)

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

オーバーライド:

クラス AssertionBase 内の addStatement

パラメータ:

statement - the Statement object.

戻り値:

false if statement is null else true.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a XML String representation of this object.

戻り値:

a String representation of this Object.

例外:

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.

パラメータ:

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.

戻り値:

a string containing the valid XML for this object.

例外:

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

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the Assertion.

オーバーライド:

クラス Assertion 内の signXML

パラメータ:

certAlias - the alias/name of the certificate.

例外:

SAMLException - if FSAssertion cannot be signed.

setSignature

public boolean setSignature(Element elem)

Sets the Element's signature.

オーバーライド:

クラス AssertionBase 内の setSignature

パラメータ:

elem - the Element object

戻り値:

true if signature is set otherwise false

parseAdvice

public void parseAdvice(Element element)

Parses the advice element to extract the Security Assertion.

パラメータ:

element - the Advice Element.

getDiscoveryCredential

public List getDiscoveryCredential()

Returns the discovery service credentials from the boot strap.

戻り値:

the discovery service credentials from the boot strap.