a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: Advice.java,v 1.2 2008/06/25 05:47:39 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Advice</code> contains any additional information that the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * SAML authority wishes to provide. This information may be ignored
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * by applications without affecting either the semantics or the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * validity of the assertion. An <code>Advice</code> contains a mixture
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of zero or more <code>Assertion</code>, <code>EncryptedAssertion</code>,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AssertionIDRef</code>, and <code>AssertionURIRef</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param assertions a list of <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAssertions(List assertions) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of <code>AssertionIDRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of <code>AssertionIDRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of <code>AssertionIDRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param idRefs a list of <code>AssertionIDRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAssertionIDRefs(List idRefs) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of <code>AssertionURIRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of <code>AssertionURIRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of <code>AssertionURIRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param uriRefs a list of <code>AssertionURIRef</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAssertionURIRefs(List uriRefs) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of <code>EncryptedAssertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of <code>EncryptedAssertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of <code>EncryptedAssertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param encryptedAssertions a list of <code>EncryptedAssertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setEncryptedAssertions(List encryptedAssertions)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of additional information
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of additional information
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of additional information
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param info a list of additional information
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAdditionalInfo(List info) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNSPrefix Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is prepended to the Element when converted.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns true if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the object is mutable