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: AudienceRestriction.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.assertion;
031
032import java.util.List;
033import com.sun.identity.saml2.common.SAML2Exception;
034
035/**
036 * The <code>AudienceRestriction</code> specifies that the assertion
037 * is addressed to one or more specific <code>Audience</code>s.
038 * @supported.all.api
039 */
040public interface AudienceRestriction extends ConditionAbstract {
041
042    /**
043     * Returns a list of <code>String</code> represented audiences
044     *
045     * @return a list of <code>String</code> represented audiences 
046     */
047    public List getAudience();
048
049    /**
050     * Sets the audiences
051     *
052     * @param audiences List of audiences as URI strings
053     * @exception SAML2Exception if the object is immutable
054     */
055    public void setAudience(List audiences) throws SAML2Exception;
056
057   /**
058    * Returns a String representation
059    * @param includeNSPrefix Determines whether or not the namespace 
060    *        qualifier is prepended to the Element when converted
061    * @param declareNS Determines whether or not the namespace is declared
062    *        within the Element.
063    * @return A String representation
064    * @exception SAML2Exception if something is wrong during conversion
065     */
066    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
067     throws SAML2Exception;
068
069   /**
070    * Returns a String representation
071    *
072    * @return A String representation
073    * @exception SAML2Exception if something is wrong during conversion
074    */
075    public String toXMLString() throws SAML2Exception;
076
077   /**
078    * Makes the object immutable
079    */
080    public void makeImmutable();
081
082   /**
083    * Returns true if the object is mutable
084    *
085    * @return true if the object is mutable
086    */
087    public boolean isMutable();
088
089}