001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: Advice.java,v 1.2 2008/06/25 05:47:39 qcheng Exp $
026 *
027 */
028package com.sun.identity.saml2.assertion;
029
030import java.util.List;
031import com.sun.identity.saml2.common.SAML2Exception;
032
033/** 
034 * The <code>Advice</code> contains any additional information that the 
035 * SAML authority wishes to provide.  This information may be ignored 
036 * by applications without affecting either the semantics or the 
037 * validity of the assertion. An <code>Advice</code> contains a mixture
038 * of zero or more <code>Assertion</code>, <code>EncryptedAssertion</code>,
039 * <code>AssertionIDRef</code>, and <code>AssertionURIRef</code>.
040 *
041 * @supported.all.api
042 */
043public interface Advice {
044
045    /** 
046     *  Returns a list of <code>Assertion</code>
047     * 
048     *  @return a list of <code>Assertion</code>
049     */
050    public List getAssertions();
051
052    /** 
053     *  Sets a list of <code>Assertion</code>
054     * 
055     *  @param assertions a list of <code>Assertion</code>
056     *  @exception SAML2Exception if the object is immutable
057     */
058    public void setAssertions(List assertions) throws SAML2Exception;
059
060    /** 
061     *  Returns a list of <code>AssertionIDRef</code>
062     * 
063     *  @return a list of <code>AssertionIDRef</code>
064     */
065    public List getAssertionIDRefs();
066
067    /** 
068     *  Sets a list of <code>AssertionIDRef</code>
069     * 
070     *  @param idRefs a list of <code>AssertionIDRef</code>
071     *  @exception SAML2Exception if the object is immutable
072     */
073    public void setAssertionIDRefs(List idRefs) throws SAML2Exception;
074
075    /** 
076     *  Returns a list of <code>AssertionURIRef</code>  
077     * 
078     *  @return a list of <code>AssertionURIRef</code>
079     */
080    public List getAssertionURIRefs();
081
082    /** 
083     *  Sets a list of <code>AssertionURIRef</code>  
084     * 
085     *  @param uriRefs a list of <code>AssertionURIRef</code>
086     *  @exception SAML2Exception if the object is immutable
087     */
088    public void setAssertionURIRefs(List uriRefs) throws SAML2Exception;
089
090    /** 
091     *  Returns a list of <code>EncryptedAssertion</code>
092     * 
093     *  @return a list of <code>EncryptedAssertion</code>
094     */
095    public List getEncryptedAssertions();
096
097    /** 
098     *  Sets a list of <code>EncryptedAssertion</code>
099     * 
100     *  @param encryptedAssertions a list of <code>EncryptedAssertion</code>
101     *  @exception SAML2Exception if the object is immutable
102     */
103    public void setEncryptedAssertions(List encryptedAssertions) 
104        throws SAML2Exception;
105
106    /** 
107     *  Returns a list of additional information
108     * 
109     *  @return a list of additional information
110     */
111    public List getAdditionalInfo();
112
113    /** 
114     *  Sets a list of additional information
115     * 
116     *  @param info a list of additional information
117     *  @exception SAML2Exception if the object is immutable
118     */
119    public void setAdditionalInfo(List info) throws SAML2Exception;
120
121   /**
122    * Returns a String representation
123    * @param includeNSPrefix Determines whether or not the namespace qualifier
124    *        is prepended to the Element when converted.
125    * @param declareNS Determines whether or not the namespace is declared
126    *        within the Element.
127    * @return A String representation
128    * @exception SAML2Exception if something is wrong during conversion
129    */
130    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
131     throws SAML2Exception;
132
133   /**
134    * Returns a String representation
135    *
136    * @return A String representation
137    * @exception SAML2Exception if something is wrong during conversion
138    */
139    public String toXMLString() throws SAML2Exception;
140
141   /**
142    * Makes the object immutable
143    */
144    public void makeImmutable();
145
146   /**
147    * Returns true if the object is mutable
148    *
149    * @return true if the object is mutable
150    */
151    public boolean isMutable();
152
153}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.