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: Request.java,v 1.2 2008/06/25 05:48:11 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Request</code> element is the top-level element in the XACML
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * context scehema. Its an abstraction layer used by the policy language.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * It contains <code>Subject</code>, <code>Resource</code>, <code>Action
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </code> and <code>Environment<code> elements.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType name="RequestType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Subject" maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Resource" maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Action"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Environment"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the one to many <code>Subject</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Subject</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the one to many <code>Subject</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subjects the one to many <code>Subject</code> elements of this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An object is considered <code>immutable</code> if <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * makeImmutable()</code> has been invoked on it. It can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * be determined by calling <code>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setSubjects(List subjects) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the one to many <code>Resource</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Resource</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the one to many <code>Resource</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param resources the one to many <code>Resource</code> elements of this
4a48635cccc646ac479830fd4df0ee8e10c5bd8djeff.schenk * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An object is considered <code>immutable</code> if <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * makeImmutable()</code> has been invoked on it. It can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * be determined by calling <code>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setResources(List resources) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the instance of <code>Action</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return instance of <code>Action</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the instance of <code>Action</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param action instance of <code>Action</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An object is considered <code>immutable</code> if <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * makeImmutable()</code> has been invoked on it. It can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * be determined by calling <code>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAction(Action action) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the instance of <code>Environment</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the instance of <code>Environment</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the instance of <code>Environment</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param env instance of <code>Environment</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * An object is considered <code>immutable</code> if <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * makeImmutable()</code> has been invoked on it. It can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * be determined by calling <code>isMutable</code> on the object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setEnvironment(Environment env) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a <code>String</code> representation of this object
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 of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string representation of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Checks if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>true</code> if the object is mutable,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>false</code> otherwise