com.sun.identity.saml2.assertion

Interface Advice

All Known Implementing Classes:

AdviceImpl

public interface Advice

The Advice contains any additional information that the SAML authority wishes to provide. This information may be ignored by applications without affecting either the semantics or the validity of the assertion. An Advice contains a mixture of zero or more Assertion, EncryptedAssertion, AssertionIDRef, and AssertionURIRef.

Method Summary

Modifier and Type	Method and Description
List	getAdditionalInfo() Returns a list of additional information
List	getAssertionIDRefs() Returns a list of AssertionIDRef
List	getAssertions() Returns a list of Assertion
List	getAssertionURIRefs() Returns a list of AssertionURIRef
List	getEncryptedAssertions() Returns a list of EncryptedAssertion
boolean	isMutable() Returns true if the object is mutable
void	makeImmutable() Makes the object immutable
void	setAdditionalInfo(List info) Sets a list of additional information
void	setAssertionIDRefs(List idRefs) Sets a list of AssertionIDRef
void	setAssertions(List assertions) Sets a list of Assertion
void	setAssertionURIRefs(List uriRefs) Sets a list of AssertionURIRef
void	setEncryptedAssertions(List encryptedAssertions) Sets a list of EncryptedAssertion
String	toXMLString() Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Method Detail

getAssertions

List getAssertions()

Returns a list of Assertion

Returns:

a list of Assertion

setAssertions

void setAssertions(List assertions)
            throws SAML2Exception

Sets a list of Assertion

Parameters:

assertions - a list of Assertion

Throws:

SAML2Exception - if the object is immutable

getAssertionIDRefs

List getAssertionIDRefs()

Returns a list of AssertionIDRef

Returns:

a list of AssertionIDRef

setAssertionIDRefs

void setAssertionIDRefs(List idRefs)
                 throws SAML2Exception

Sets a list of AssertionIDRef

Parameters:

idRefs - a list of AssertionIDRef

Throws:

SAML2Exception - if the object is immutable

getAssertionURIRefs

List getAssertionURIRefs()

Returns a list of AssertionURIRef

Returns:

a list of AssertionURIRef

setAssertionURIRefs

void setAssertionURIRefs(List uriRefs)
                  throws SAML2Exception

Sets a list of AssertionURIRef

Parameters:

uriRefs - a list of AssertionURIRef

Throws:

SAML2Exception - if the object is immutable

getEncryptedAssertions

List getEncryptedAssertions()

Returns a list of EncryptedAssertion

Returns:

a list of EncryptedAssertion

setEncryptedAssertions

void setEncryptedAssertions(List encryptedAssertions)
                     throws SAML2Exception

Sets a list of EncryptedAssertion

Parameters:

encryptedAssertions - a list of EncryptedAssertion

Throws:

SAML2Exception - if the object is immutable

getAdditionalInfo

List getAdditionalInfo()

Returns a list of additional information

Returns:

a list of additional information

setAdditionalInfo

void setAdditionalInfo(List info)
                throws SAML2Exception

Sets a list of additional information

Parameters:

info - a list of additional information

Throws:

SAML2Exception - if the object is immutable

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