com.sun.identity.saml2.assertion
Interface Advice


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
 java.util.List getAdditionalInfo()
          Returns a list of additional information
 java.util.List getAssertionIDRefs()
          Returns a list of AssertionIDRef
 java.util.List getAssertions()
          Returns a list of Assertion
 java.util.List getAssertionURIRefs()
          Returns a list of AssertionURIRef
 java.util.List getEncryptedAssertions()
          Returns a list of EncryptedAssertion
 boolean isMutable()
          Returns true if the object is mutable
 void makeImmutable()
          Makes the object immutable
 void setAdditionalInfo(java.util.List info)
          Sets a list of additional information
 void setAssertionIDRefs(java.util.List idRefs)
          Sets a list of AssertionIDRef
 void setAssertions(java.util.List assertions)
          Sets a list of Assertion
 void setAssertionURIRefs(java.util.List uriRefs)
          Sets a list of AssertionURIRef
 void setEncryptedAssertions(java.util.List encryptedAssertions)
          Sets a list of EncryptedAssertion
 java.lang.String toXMLString()
          Returns a String representation
 java.lang.String toXMLString(boolean includeNSPrefix, boolean declareNS)
          Returns a String representation
 

Method Detail

getAssertions

public java.util.List getAssertions()
Returns a list of Assertion

Returns:
a list of Assertion

setAssertions

public void setAssertions(java.util.List assertions)
                   throws SAML2Exception
Sets a list of Assertion

Parameters:
assertions - a list of Assertion
Throws:
SAML2Exception - if the object is immutable

getAssertionIDRefs

public java.util.List getAssertionIDRefs()
Returns a list of AssertionIDRef

Returns:
a list of AssertionIDRef

setAssertionIDRefs

public void setAssertionIDRefs(java.util.List idRefs)
                        throws SAML2Exception
Sets a list of AssertionIDRef

Parameters:
idRefs - a list of AssertionIDRef
Throws:
SAML2Exception - if the object is immutable

getAssertionURIRefs

public java.util.List getAssertionURIRefs()
Returns a list of AssertionURIRef

Returns:
a list of AssertionURIRef

setAssertionURIRefs

public void setAssertionURIRefs(java.util.List uriRefs)
                         throws SAML2Exception
Sets a list of AssertionURIRef

Parameters:
uriRefs - a list of AssertionURIRef
Throws:
SAML2Exception - if the object is immutable

getEncryptedAssertions

public java.util.List getEncryptedAssertions()
Returns a list of EncryptedAssertion

Returns:
a list of EncryptedAssertion

setEncryptedAssertions

public void setEncryptedAssertions(java.util.List encryptedAssertions)
                            throws SAML2Exception
Sets a list of EncryptedAssertion

Parameters:
encryptedAssertions - a list of EncryptedAssertion
Throws:
SAML2Exception - if the object is immutable

getAdditionalInfo

public java.util.List getAdditionalInfo()
Returns a list of additional information

Returns:
a list of additional information

setAdditionalInfo

public void setAdditionalInfo(java.util.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

public java.lang.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

public java.lang.String toXMLString()
                             throws SAML2Exception
Returns a String representation

Returns:
A String representation
Throws:
SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()
Makes the object immutable


isMutable

public boolean isMutable()
Returns true if the object is mutable

Returns:
true if the object is mutable


Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.