com.sun.identity.saml2.assertion.impl

Class AssertionImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.AssertionImpl

All Implemented Interfaces:

Assertion

public class AssertionImpl
extends Object
implements Assertion

The Assertion element is a package of information that supplies one or more Statement made by an issuer. There are three kinds of assertions: Authentication, Authorization Decision, and Attribute assertions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSERTION_ADVICE
static String	ASSERTION_ATTRIBUTESTATEMENT
static String	ASSERTION_AUTHNSTATEMENT
static String	ASSERTION_AUTHZDECISIONSTATEMENT
static String	ASSERTION_CONDITIONS
static String	ASSERTION_ELEMENT
static String	ASSERTION_ID_ATTR
static String	ASSERTION_ISSUEINSTANT_ATTR
static String	ASSERTION_ISSUER
static String	ASSERTION_SIGNATURE
static String	ASSERTION_STATEMENT
static String	ASSERTION_SUBJECT
static String	ASSERTION_VERSION_ATTR
static String	XSI_TYPE_ATTR

Constructor Summary

Constructors

Constructor and Description
AssertionImpl() Default constructor
AssertionImpl(Element element) This constructor is used to build Assertion object from a block of existing XML that has already been built into a DOM.
AssertionImpl(String xml) This constructor is used to build Assertion object from a XML string.

Method Summary

Modifier and Type	Method and Description
EncryptedAssertion	encrypt(Key recipientPublicKey, String dataEncAlgorithm, int dataEncStrength, String recipientEntityID) Returns an EncryptedAssertion object.
Advice	getAdvice() Returns the advice of the assertion
List<AttributeStatement>	getAttributeStatements() Returns the attribute statements of the assertion
List<AuthnStatement>	getAuthnStatements() Returns the Authn statements of the assertion
List<AuthzDecisionStatement>	getAuthzDecisionStatements() Returns the AuthzDecisionStatements of the assertion
Conditions	getConditions() Returns the conditions of the assertion
String	getID() Returns the id of the assertion
Date	getIssueInstant() Returns the time when the assertion was issued
Issuer	getIssuer() Returns the issuer of the assertion
String	getSignature() Returns the signature of the assertion
List<Object>	getStatements() Returns the statements of the assertion
Subject	getSubject() Returns the subject of the assertion
String	getVersion() Returns the version number of the assertion.
boolean	isMutable() Returns true if the object is mutable
boolean	isSignatureValid(Set<X509Certificate> verificationCerts) Return whether the signature is valid or not.
boolean	isSigned() Return whether the assertion is signed
boolean	isTimeValid() Gets the validity of the assertion evaluating its conditions if specified.
void	makeImmutable() Makes the object immutable
void	setAdvice(Advice advice) Sets the advice of the assertion
void	setAttributeStatements(List<AttributeStatement> statements) Sets the attribute statements of the assertion
void	setAuthnStatements(List<AuthnStatement> statements) Sets the AuthnStatements of the assertion
void	setAuthzDecisionStatements(List<AuthzDecisionStatement> statements) Sets the AuthzDecisionStatements of the assertion
void	setConditions(Conditions conditions) Sets the conditions of the assertion
void	setID(String id) Sets the id of the assertion
void	setIssueInstant(Date issueInstant) Set the time when the assertion was issued
void	setIssuer(Issuer issuer) Sets the issuer of the assertion
void	setStatements(List<Object> statements) Sets the statements of the assertion
void	setSubject(Subject subject) Sets the subject of the assertion
void	setVersion(String version) Sets the version number of the assertion.
void	sign(PrivateKey privateKey, X509Certificate cert) Sign the Assertion.
String	toXMLString() Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Methods inherited from class java.lang.Object

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

Field Detail

ASSERTION_ELEMENT

public static String ASSERTION_ELEMENT

ASSERTION_VERSION_ATTR

public static String ASSERTION_VERSION_ATTR

ASSERTION_ID_ATTR

public static String ASSERTION_ID_ATTR

ASSERTION_ISSUEINSTANT_ATTR

public static String ASSERTION_ISSUEINSTANT_ATTR

XSI_TYPE_ATTR

public static String XSI_TYPE_ATTR

ASSERTION_ISSUER

public static String ASSERTION_ISSUER

ASSERTION_SIGNATURE

public static String ASSERTION_SIGNATURE

ASSERTION_SUBJECT

public static String ASSERTION_SUBJECT

ASSERTION_CONDITIONS

public static String ASSERTION_CONDITIONS

ASSERTION_ADVICE

public static String ASSERTION_ADVICE

ASSERTION_STATEMENT

public static String ASSERTION_STATEMENT

ASSERTION_AUTHNSTATEMENT

public static String ASSERTION_AUTHNSTATEMENT

ASSERTION_AUTHZDECISIONSTATEMENT

public static String ASSERTION_AUTHZDECISIONSTATEMENT

ASSERTION_ATTRIBUTESTATEMENT

public static String ASSERTION_ATTRIBUTESTATEMENT

Constructor Detail

AssertionImpl

public AssertionImpl()

Default constructor

AssertionImpl

public AssertionImpl(String xml)
              throws SAML2Exception

This constructor is used to build Assertion object from a XML string.

Parameters:

xml - A java.lang.String representing a Assertion object

Throws:

SAML2Exception - if it could not process the XML string

AssertionImpl

public AssertionImpl(Element element)
              throws SAML2Exception

This constructor is used to build Assertion object from a block of existing XML that has already been built into a DOM.

Parameters:

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

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getVersion

public String getVersion()

Returns the version number of the assertion.

Specified by:

getVersion in interface Assertion

Returns:

The version number of the assertion.

setVersion

public void setVersion(String version)
                throws SAML2Exception

Sets the version number of the assertion.

Specified by:

setVersion in interface Assertion

Parameters:

version - the version number.

Throws:

SAML2Exception - if the object is immutable

getIssueInstant

public Date getIssueInstant()

Returns the time when the assertion was issued

Specified by:

getIssueInstant in interface Assertion

Returns:

the time of the assertion issued

setIssueInstant

public void setIssueInstant(Date issueInstant)
                     throws SAML2Exception

Set the time when the assertion was issued

Specified by:

setIssueInstant in interface Assertion

Parameters:

issueInstant - the issue time of the assertion

Throws:

SAML2Exception - if the object is immutable

getSubject

public Subject getSubject()

Returns the subject of the assertion

Specified by:

getSubject in interface Assertion

Returns:

the subject of the assertion

setSubject

public void setSubject(Subject subject)
                throws SAML2Exception

Sets the subject of the assertion

Specified by:

setSubject in interface Assertion

Parameters:

subject - the subject of the assertion

Throws:

SAML2Exception - if the object is immutable

getAdvice

public Advice getAdvice()

Returns the advice of the assertion

Specified by:

getAdvice in interface Assertion

Returns:

the advice of the assertion

setAdvice

public void setAdvice(Advice advice)
               throws SAML2Exception

Sets the advice of the assertion

Specified by:

setAdvice in interface Assertion

Parameters:

advice - the advice of the assertion

Throws:

SAML2Exception - if the object is immutable

getSignature

public String getSignature()

Returns the signature of the assertion

Specified by:

getSignature in interface Assertion

Returns:

the signature of the assertion

getConditions

public Conditions getConditions()

Returns the conditions of the assertion

Specified by:

getConditions in interface Assertion

Returns:

the conditions of the assertion

setConditions

public void setConditions(Conditions conditions)
                   throws SAML2Exception

Sets the conditions of the assertion

Specified by:

setConditions in interface Assertion

Parameters:

conditions - the conditions of the assertion

Throws:

SAML2Exception - if the object is immutable

getID

public String getID()

Returns the id of the assertion

Specified by:

getID in interface Assertion

Returns:

the id of the assertion

setID

public void setID(String id)
           throws SAML2Exception

Sets the id of the assertion

Specified by:

setID in interface Assertion

Parameters:

id - the id of the assertion

Throws:

SAML2Exception - if the object is immutable

getStatements

public List<Object> getStatements()

Returns the statements of the assertion

Specified by:

getStatements in interface Assertion

Returns:

the statements of the assertion

getAuthnStatements

public List<AuthnStatement> getAuthnStatements()

Returns the Authn statements of the assertion

Specified by:

getAuthnStatements in interface Assertion

Returns:

the Authn statements of the assertion

getAuthzDecisionStatements

public List<AuthzDecisionStatement> getAuthzDecisionStatements()

Returns the AuthzDecisionStatements of the assertion

Specified by:

getAuthzDecisionStatements in interface Assertion

Returns:

the AuthzDecisionStatements of the assertion

getAttributeStatements

public List<AttributeStatement> getAttributeStatements()

Returns the attribute statements of the assertion

Specified by:

getAttributeStatements in interface Assertion

Returns:

the attribute statements of the assertion

setStatements

public void setStatements(List<Object> statements)
                   throws SAML2Exception

Sets the statements of the assertion

Specified by:

setStatements in interface Assertion

Parameters:

statements - the statements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAuthnStatements

public void setAuthnStatements(List<AuthnStatement> statements)
                        throws SAML2Exception

Sets the AuthnStatements of the assertion

Specified by:

setAuthnStatements in interface Assertion

Parameters:

statements - the AuthnStatements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAuthzDecisionStatements

public void setAuthzDecisionStatements(List<AuthzDecisionStatement> statements)
                                throws SAML2Exception

Sets the AuthzDecisionStatements of the assertion

Specified by:

setAuthzDecisionStatements in interface Assertion

Parameters:

statements - the AuthzDecisionStatements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAttributeStatements

public void setAttributeStatements(List<AttributeStatement> statements)
                            throws SAML2Exception

Sets the attribute statements of the assertion

Specified by:

setAttributeStatements in interface Assertion

Parameters:

statements - the attribute statements of the assertion

Throws:

SAML2Exception - if the object is immutable

getIssuer

public Issuer getIssuer()

Returns the issuer of the assertion

Specified by:

getIssuer in interface Assertion

Returns:

the issuer of the assertion

setIssuer

public void setIssuer(Issuer issuer)
               throws SAML2Exception

Sets the issuer of the assertion

Specified by:

setIssuer in interface Assertion

Parameters:

issuer - the issuer of the assertion

Throws:

SAML2Exception - if the object is immutable

isSigned

public boolean isSigned()

Return whether the assertion is signed

Specified by:

isSigned in interface Assertion

Returns:

true if the assertion is signed; false otherwise.

isSignatureValid

public boolean isSignatureValid(Set<X509Certificate> verificationCerts)
                         throws SAML2Exception

Description copied from interface: Assertion

Return whether the signature is valid or not.

Specified by:

isSignatureValid in interface Assertion

Parameters:

verificationCerts - Certificates containing the public keys which may be used for signature verification; This certificate may also may be used to check against the certificate included in the signature.

Returns:

true if the signature is valid; false otherwise.

Throws:

SAML2Exception - if the signature could not be verified

sign

public void sign(PrivateKey privateKey,
                 X509Certificate cert)
          throws SAML2Exception

Sign the Assertion.

Specified by:

sign in interface Assertion

Parameters:

privateKey - Signing key

cert - Certificate which contain the public key correlated to the signing key; It if is not null, then the signature will include the certificate; Otherwise, the signature will not include any certificate

Throws:

SAML2Exception - if it could not sign the assertion.

encrypt

public EncryptedAssertion encrypt(Key recipientPublicKey,
                                  String dataEncAlgorithm,
                                  int dataEncStrength,
                                  String recipientEntityID)
                           throws SAML2Exception

Returns an EncryptedAssertion object.

Specified by:

encrypt in interface Assertion

Parameters:

recipientPublicKey - Public key used to encrypt the data encryption (secret) key, it is the public key of the recipient of the XML document to be encrypted.

dataEncAlgorithm - Data encryption algorithm.

dataEncStrength - Data encryption strength.

recipientEntityID - Unique identifier of the recipient, it is used as the index to the cached secret key so that the key can be reused for the same recipient; It can be null in which case the secret key will be generated every time and will not be cached and reused. Note that the generation of a secret key is a relatively expensive operation.

Returns:

EncryptedAssertion object

Throws:

SAML2Exception - if error occurs during the encryption process.

isTimeValid

public boolean isTimeValid()

Gets the validity of the assertion evaluating its conditions if specified.

Specified by:

isTimeValid in interface Assertion

Returns:

false if conditions is invalid based on it lying between NotBefore (current time inclusive) and NotOnOrAfter (current time exclusive) values and true otherwise or if no conditions specified.

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Assertion

Parameters:

includeNSPrefix - 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 representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Assertion

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface Assertion

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface Assertion

Returns:

true if the object is mutable