com.sun.identity.saml2.assertion

Interface Assertion

public interface 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.

Method Summary

Modifier and Type	Method and Description
EncryptedAssertion	encrypt(EncryptionConfig encryptionConfig, 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 AuthnStatements 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 true if 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) Sets 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) Signs the Assertion.
String	toXMLString() Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Method Detail

getVersion

String getVersion()

Returns the version number of the assertion.

Returns:

The version number of the assertion.

setVersion

void setVersion(String version)
         throws SAML2Exception

Sets the version number of the assertion.

Parameters:

version - the version number.

Throws:

SAML2Exception - if the object is immutable

getIssueInstant

Date getIssueInstant()

Returns the time when the assertion was issued

Returns:

the time of the assertion issued

setIssueInstant

void setIssueInstant(Date issueInstant)
              throws SAML2Exception

Sets the time when the assertion was issued

Parameters:

issueInstant - the issue time of the assertion

Throws:

SAML2Exception - if the object is immutable

getSubject

Subject getSubject()

Returns the subject of the assertion

Returns:

the subject of the assertion

setSubject

void setSubject(Subject subject)
         throws SAML2Exception

Sets the subject of the assertion

Parameters:

subject - the subject of the assertion

Throws:

SAML2Exception - if the object is immutable

getAdvice

Advice getAdvice()

Returns the advice of the assertion

Returns:

the advice of the assertion

setAdvice

void setAdvice(Advice advice)
        throws SAML2Exception

Sets the advice of the assertion

Parameters:

advice - the advice of the assertion

Throws:

SAML2Exception - if the object is immutable

getSignature

String getSignature()

Returns the signature of the assertion

Returns:

the signature of the assertion

getConditions

Conditions getConditions()

Returns the conditions of the assertion

Returns:

the conditions of the assertion

setConditions

void setConditions(Conditions conditions)
            throws SAML2Exception

Sets the conditions of the assertion

Parameters:

conditions - the conditions of the assertion

Throws:

SAML2Exception - if the object is immutable

getID

String getID()

Returns the id of the assertion

Returns:

the id of the assertion

setID

void setID(String id)
    throws SAML2Exception

Sets the id of the assertion

Parameters:

id - the id of the assertion

Throws:

SAML2Exception - if the object is immutable

getStatements

List<Object> getStatements()

Returns the statements of the assertion

Returns:

the statements of the assertion

getAuthnStatements

List<AuthnStatement> getAuthnStatements()

Returns the AuthnStatements of the assertion

Returns:

the AuthnStatements of the assertion

getAuthzDecisionStatements

List<AuthzDecisionStatement> getAuthzDecisionStatements()

Returns the AuthzDecisionStatements of the assertion

Returns:

the AuthzDecisionStatements of the assertion

getAttributeStatements

List<AttributeStatement> getAttributeStatements()

Returns the attribute statements of the assertion

Returns:

the attribute statements of the assertion

setStatements

void setStatements(List<Object> statements)
            throws SAML2Exception

Sets the statements of the assertion

Parameters:

statements - the statements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAuthnStatements

void setAuthnStatements(List<AuthnStatement> statements)
                 throws SAML2Exception

Sets the AuthnStatements of the assertion

Parameters:

statements - the AuthnStatements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAuthzDecisionStatements

void setAuthzDecisionStatements(List<AuthzDecisionStatement> statements)
                         throws SAML2Exception

Sets the AuthzDecisionStatements of the assertion

Parameters:

statements - the AuthzDecisionStatements of the assertion

Throws:

SAML2Exception - if the object is immutable

setAttributeStatements

void setAttributeStatements(List<AttributeStatement> statements)
                     throws SAML2Exception

Sets the attribute statements of the assertion

Parameters:

statements - the attribute statements of the assertion

Throws:

SAML2Exception - if the object is immutable

getIssuer

Issuer getIssuer()

Returns the issuer of the assertion

Returns:

the issuer of the assertion

setIssuer

void setIssuer(Issuer issuer)
        throws SAML2Exception

Sets the issuer of the assertion

Parameters:

issuer - the issuer of the assertion

Throws:

SAML2Exception - if the object is immutable

isSigned

boolean isSigned()

Return true if the assertion is signed

Returns:

true if the assertion is signed

isSignatureValid

boolean isSignatureValid(Set<X509Certificate> verificationCerts)
                  throws SAML2Exception

Return whether the signature is valid or not.

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

isTimeValid

boolean isTimeValid()

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

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.

sign

void sign(PrivateKey privateKey,
          X509Certificate cert)
   throws SAML2Exception

Signs the 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

EncryptedAssertion encrypt(EncryptionConfig encryptionConfig,
                           String recipientEntityID)
                    throws SAML2Exception

Returns an EncryptedAssertion object.

Parameters:

encryptionConfig - The encryption config.

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.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation

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

String toXMLString()
            throws SAML2Exception

Returns a String representation

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Returns true if the object is mutable

Returns:

true if the object is mutable