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: AudienceRestrictionCondition.java,v 1.2 2008/06/25 05:47:31 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtilsCommon;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLRequesterException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *This is an implementation of the abstract <code>Condition</code> class, which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *specifes that the assertion this AuthenticationCondition is part of, is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *addressed to one or more specific audience.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class AudienceRestrictionCondition extends Condition {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _audience is a list of all the audience this condition is addressed to.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Its implemented as a list of <code>String</code> objects each of them
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster containing an audience ( String). This list needs to have at least one
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster audience specified. An audience is actually a URI. The URI MAY identify a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster document that describes the terms and conditions of audience membership
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private java.util.Vector _audience = new Vector();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs an <code>AudienceRestrictionCondition</code> element from an
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * existing XML block.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param audienceRestrictionConditionElement A
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>org.w3c.dom.Element</code> representing DOM tree for
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AudienceRestrictionCondition</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAMLException if it could not process the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>org.w3c.dom.Element</code> properly, implying that there
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is an error in the sender or in the element definition.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster org.w3c.dom.Element audienceRestrictionConditionElement)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Element elt = (Element)audienceRestrictionConditionElement;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("AudienceRestrictionCondition: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "null condition ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "nullInput"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!(eltName.equals("AudienceRestrictionCondition"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "AudienceRestrictionCondition: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "unsupported condition ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "unsupportedCondition"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (eltName.equals("Condition")) { // seems like extension type
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!(type.equals("AudienceRestrictionCondition"))) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "AudienceRestrictionCondition: invalid condition");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalidElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("AudienceRestrictionCondition: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "no Audience in this Element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("noElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (child.getNodeType() != Node.ELEMENT_NODE) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster _audience.add(XMLUtils.getElementValue((Element)child));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "AudienceRestrictionCondition:"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster +" invalid element found");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.bundle.getString("invalidElement")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Constructs <code>AudienceRestrictionCondition</code> with a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *<code>List</code> of audience for this condition, each of them
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *being a String.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@param audience A List of audience to be included within this condition
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@exception SAMLException if the <code>List</code> is empty or if there is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *some error in processing the contents of the <code>List</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public AudienceRestrictionCondition(List audience) throws SAMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster SAMLUtilsCommon.debug.message("AudienceRestrictionCondition: "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster + "null input specified");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new SAMLRequesterException(SAMLUtilsCommon.bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "nullInput")) ;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Adds an audience to this Condition element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@param audience audience to be added
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@return boolean indicating success or failure of operation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean addAudience(java.lang.String audience) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((audience != null) && !(audience.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Adds a <code>List</code> of audience held within this Condition element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@param audience A <code>List</code> of audience to be included within
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *this condition
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@return boolean indicating success or failure of operation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *Returns list of Audience held within this Condition element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@return An the <code>List</code> of Audience within this Condition element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns true if a particular audience string is contained within this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>AudienceRestrictionCondition</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param audience audience to be checked
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the audience exists.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean containsAudience(String audience) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((audience != null) && !(audience.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Removes an audience from the <code>List</code> within this Condition
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param audience A string representing the value of the Audience
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return boolean true/false representing success or failure of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the operation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean removeAudience(java.lang.String audience) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if ((audience != null) && !(audience.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else return false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * By default name space name is prepended to the element name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * example <code><saml:AudienceRestrictionCondition></code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // call toString() with includeNS true by default and declareNS false
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code><AudienceRestrictionCondition></code> element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNS Determines whether or not the namespace qualifier is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * 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 containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public java.lang.String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String o = SAMLUtilsCommon.makeStartElementTagXML(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "AudienceRestrictionCondition", includeNS, declareNS);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster o = SAMLUtilsCommon.makeEndElementTagXML("Audience",includeNS);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Evaluates this condition
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This method can be overridden by a plug-in which provides
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * means of evaluating this condition
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return evaluation status.