a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 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: Subject.java,v 1.2 2008/06/25 05:48:12 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>Subject</code> element specifies information about a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * subject of the <code>Request</code> context by listing a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * sequence of <code>Attribute</code> elements associated with the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * subject. A subject is an entity associated with the access request.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType name="SubjectType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element ref="xacml-context:Attribute" minOccurs="0"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * maxOccurs="unbounded"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:attribute name="SubjectCategory" type="xs:anyURI"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * default="urn:oasis:names:tc:xacml:1.0:subject-category:access-subject"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *@supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns zero to many <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If no attributes and present, empty <code>List</code> will be returned.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Typically a <code>Subject</code> element will contain an <code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Attribute</code> with an <code>AttributeId</code> of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "urn:oasis:names:tc:xacml:1.0:subject:subject-id", containing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the identity of the <code>Subject</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param attributes <code>Attribute</code> elements of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attributes could be an empty <code>List</code>, if no attributes
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * are present.
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 setAttributes(List attributes) throws XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>SubjectCategory</code> of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This is optional so could be null if not defined.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This attribute indicates the role that the parent <code>Subject</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * played in the formation of the access request. If this attribute is not
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * present in the <code>Subject</code> element, then the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * default value of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * urn:oasis:names:tc:xacml:1.0:subject-category:access-subject SHALL be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * used, indicating that the <code>Subject</code> represents the entity
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * ultimately responsible for initiating the access request.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>URI</code> representing the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectCategory</code> of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>SubjectCategory</code> of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param subjectCategory <code>URI</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 setSubjectCategory(URI subjectCategory) throws
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