/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: SubjectImpl.java,v 1.3 2008/06/25 05:48:13 qcheng Exp $
*
*/
/**
* The <code>Subject</code> element specifies information about a
* subject of the <code>Request</code> context by listing a
* sequence of <code>Attribute</code> elements associated with the
* subject. A subject is an entity associated with the access request.
* <p>
* <pre>
* <xs:complexType name="SubjectType">
* <xs:sequence>
* <xs:element ref="xacml-context:Attribute" minOccurs="0"
* maxOccurs="unbounded"/>
* <xs:sequence>
* <xs:attribute name="SubjectCategory" type="xs:anyURI"
* default="urn:oasis:names:tc:xacml:1.0:subject-category:access-subject"/>
* <xs:complexType>
* </pre>
*@supported.all.api
*/
private boolean isMutable = true;
private boolean needToCreateSubjectCategory = false;
/**
* Default constructor
*/
public SubjectImpl() {
}
/**
* This constructor is used to build <code>Subject</code> object from a
* XML string.
*
* @param xml A <code>java.lang.String</code> representing
* a <code>Subject</code> object
* @exception XACMLException if it could not process the XML string
*/
} else {
"SubjectImpl.processElement(): invalid XML input");
"errorObtainingElement"));
}
}
/**
* This constructor is used to build <code>Subject</code> object from a
* block of existing XML that has already been built into a DOM.
*
* @param element A <code>org.w3c.dom.Element</code> representing
* DOM tree for <code>Subject</code> object
* @exception XACMLException if it could not process the Element
*/
}
"SubjectImpl.processElement(): invalid root element");
"invalid_element"));
}
"SubjectImpl.processElement(): local name missing");
"missing_local_name"));
}
"SubjectImpl.processElement(): invalid local name " +
elemName);
"invalid_local_name"));
}
// starts processing subelements
if (numOfNodes >= 1) {
// The child nodes should be <Attribute>
// or <SubjectCategory>
if (this.attributes == null) {
this.attributes = new ArrayList();
}
} else if (attrChildName.equals(
try {
} catch ( Exception e) {
throw new XACMLException(
"attribute_not_uri"));
}
} else {
+"processElement(): Invalid element :"
throw new XACMLException(
"invalid_element"));
}
}
}
}
}
/**
* Returns zero to many <code>Attribute</code> elements of this object
* If no attributes and present, empty <code>List</code> will be returned.
* Typically a <code>Subject</code> element will contain an <code>
* Attribute</code> with an <code>AttributeId</code> of
* "urn:oasis:names:tc:xacml:1.0:subject:subject-id", containing
* the identity of the <code>Subject</code>
*
* @return the <code>Attribute</code> elements of this object
*/
return attributes;
}
/**
* Sets the <code>Attribute</code> elements of this object
*
* @param attributes <code>Attribute</code> elements of this object
* attributes could be an empty <code>List</code>, if no attributes
* are present.
*
* @exception XACMLException if the object is immutable
* An object is considered <code>immutable</code> if <code>
* makeImmutable()</code> has been invoked on it. It can
* be determined by calling <code>isMutable</code> on the object.
*/
if (!isMutable) {
"objectImmutable"));
}
if (this.attributes == null) {
this.attributes = new ArrayList();
}
}
}
/**
* Returns the <code>SubjectCategory</code> of this object.
* This is optional so could be null if not defined.
* This attribute indicates the role that the parent <code>Subject</code>
* played in the formation of the access request. If this attribute is not
* present in the <code>Subject</code> element, then the
* default value of
* urn:oasis:names:tc:xacml:1.0:subject-category:access-subject SHALL be
* used, indicating that the <code>Subject</code> represents the entity
* ultimately responsible for initiating the access request.
*
* @return <code>URI</code> representing the
* <code>SubjectCategory</code> of this object.
*/
try {
if (subjectCategory == null) {
}
} catch (Exception e) { // cant do anything, return null
}
return subjectCategory;
}
/**
* Sets the <code>SubjectCategory</code> of this object
*
* @param subjectCategory <code>URI</code>
*
* @exception XACMLException if the object is immutable
* An object is considered <code>immutable</code> if <code>
* makeImmutable()</code> has been invoked on it. It can
* be determined by calling <code>isMutable</code> on the object.
*/
{
if (!isMutable) {
"objectImmutable"));
}
if (subjectCategory != null) {
this.subjectCategory = subjectCategory;
} /*else {
needToCreateSubjectCategory = true;
try {
subjectCategory = new URI(SUBJECT_CATEGORY_DEFAULT);
List values = new ArrayList();
values.add(subjectCategory.toString());
subjectCategoryAttribute =
XACMLSDKUtils.createAttribute(values, new URI(
SUBJECT_CATEGORY_ID), new URI(URI_DATATYPE), null);
} catch ( Exception e) {
throw new XACMLException(e);
}
}*/
}
/**
* Returns a <code>String</code> representation of this object
* @param includeNSPrefix Determines whether or not the namespace qualifier
* is prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return a string representation of this object
* @exception XACMLException if conversion fails for any reason
*/
throws XACMLException
{
//TODO: remove the 2 following line
includeNSPrefix = false;
declareNS = false;
if (declareNS) {
}
if (includeNSPrefix) {
}
if (subjectCategory != null) {
}
int length = 0;
if (attributes != null) {
for (int i = 0; i < length; i++) {
}
}
/* if (needToCreateSubjectCategory && subjectCategoryAttribute != null) {
sb.append(subjectCategoryAttribute.toXMLString(
includeNSPrefix, false));
}// its already covered in the previous list of attrs.
*/
}
/**
* Returns a string representation of this object
*
* @return a string representation of this object
* @exception XACMLException if conversion fails for any reason
*/
return toXMLString(true, false);
}
/**
* Makes the object immutable
*/
public void makeImmutable() {}
/**
* Checks if the object is mutable
*
* @return <code>true</code> if the object is mutable,
* <code>false</code> otherwise
*/
public boolean isMutable() {
return isMutable;
}
}