Request element is the top-level element in the XACML
* context schema. Its an abstraction layer used by the policy language.
* It contains Subject, Resource, Action
* and Environment elements.
*
*
* <xs:complexType name="RequestType">
* <xs:sequence>
* <xs:element ref="xacml-context:Subject" maxOccurs="unbounded"/>
* <xs:element ref="xacml-context:Resource" maxOccurs="unbounded"/>
* <xs:element ref="xacml-context:Action"/>
* <xs:element ref="xacml-context:Environment"/>
* <xs:sequence>
* <xs:complexType>
*
*@supported.all.api
*/
public class RequestImpl implements Request {
private List subjects = new ArrayList();
private List resources = new ArrayList();
private Action action = null;
private Environment env = null;
private boolean isMutable = true;
private static Set supportedSubjectCategory = new HashSet();
static {
supportedSubjectCategory.add(XACMLConstants.ACCESS_SUBJECT);
supportedSubjectCategory.add(XACMLConstants.
INTERMEDIARY_SUBJECT);
};
/**
* Default constructor
*/
public RequestImpl() {
}
/**
* This constructor is used to build Request object from a
* XML string.
*
* @param xml A java.lang.String representing
* a Request object
* @exception XACMLException if it could not process the XML string
*/
public RequestImpl(String xml) throws XACMLException {
Document document = XMLUtils.toDOMDocument(xml, XACMLSDKUtils.debug);
if (document != null) {
Element rootElement = document.getDocumentElement();
processElement(rootElement);
makeImmutable();
} else {
XACMLSDKUtils.debug.error(
"RequestImpl.processElement(): invalid XML input");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"errorObtainingElement"));
}
}
/**
* This constructor is used to build Request object from a
* block of existing XML that has already been built into a DOM.
*
* @param element A org.w3c.dom.Element representing
* DOM tree for Request object
* @exception XACML2Exception if it could not process the Element
*/
public RequestImpl(Element element) throws XACMLException {
processElement(element);
makeImmutable();
}
private void processElement(Element element) throws XACMLException {
if (element == null) {
XACMLSDKUtils.debug.error(
"RequestImpl.processElement(): invalid root element");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_element"));
}
String elemName = element.getLocalName();
if (elemName == null) {
XACMLSDKUtils.debug.error(
"RequestImpl.processElement(): local name missing");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_local_name"));
}
if (!elemName.equals(XACMLConstants.REQUEST)) {
XACMLSDKUtils.debug.error(
"RequestImpl.processElement(): invalid local name " +
elemName);
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_local_name"));
}
// starts processing subelements
NodeList nodes = element.getChildNodes();
int numOfNodes = nodes.getLength();
if (numOfNodes < 1) {
XACMLSDKUtils.debug.error(
"RequestImpl.processElement(): request has no subelements");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_subelements"));
}
ContextFactory factory = ContextFactory.getInstance();
List children = new ArrayList();
int i = 0;
Node child;
while ( i < numOfNodes) {
child = (Node)nodes.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE) {
children.add(child);
}
i++;
}
if (children.isEmpty()) {
XACMLSDKUtils.debug.error("RequestImpl.processElement():"
+ " request has no subelements");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_subelements"));
}
child = (Node)children.get(0);
// The first subelement should be
String childName = child.getLocalName();
if ((childName == null) || (!childName.
equals(XACMLConstants.SUBJECT))) {
XACMLSDKUtils.debug.error("RequestImpl.processElement():"+
" the first element is not ");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_subelement_subject"));
}
Subject subject = factory.getInstance().createSubject((Element)child);
if (!supportedSubjectCategory.contains(
subject.getSubjectCategory().toString()))
{
XACMLSDKUtils.debug.error("RequestImpl.processElement():subject "
+"category in subject not supported");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"unsupported_subject_category"));
}
subjects.add(subject);
boolean resourceFound = false;
boolean actionFound = false;
boolean envFound = false;
for ( int j = 1; j < children.size(); j++) {
child = (Node)children.get(j);
// so far is not encountered
// Go through next sub elements for and
// The next subelement may be or
childName = child.getLocalName();
if ((childName != null) &&
(childName.equals(XACMLConstants.RESOURCE) || childName.
equals(XACMLConstants.SUBJECT))) {
if (resourceFound) {
if (childName.equals(XACMLConstants.SUBJECT)) {
// all should be before
XACMLSDKUtils.debug.error("RequestImpl."
+"processElement(): should be "
+ "before ");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"element_out_of_place"));
} else { // found another resource
Resource resource = factory.getInstance()
.createResource((
Element)child);
resources.add(resource);
}
} else if (childName.equals(XACMLConstants.SUBJECT)) {
subject = factory.getInstance().createSubject(
(Element)child);
subjects.add(subject);
} else { // childname is resource
resourceFound = true;
Resource resource = factory.getInstance()
.createResource((
Element)child);
resources.add(resource);
}
} else if ((childName != null) && (childName.
equals(XACMLConstants.ACTION))) {
if (!resourceFound) {
XACMLSDKUtils.debug.error("RequestImpl."
+"processElement(): should be "
+ "before ");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"element_out_of_place"));
} else {
actionFound = true;
action = factory.createAction((Element)child);
}
} else if ((childName != null) && (childName.
equals(XACMLConstants.ENVIRONMENT))) {
if (!resourceFound || !actionFound){
XACMLSDKUtils.debug.error("RequestImpl."
+"processElement(): and "
+"Action should be before ");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"element_out_of_place"));
} else {
envFound = true;
env = factory.createEnvironment((Element) child);
}
}
}
if (XACMLSDKUtils.debug.messageEnabled()) {
XACMLSDKUtils.debug.message("resourceFound:"+resourceFound);
XACMLSDKUtils.debug.message("actionFound:"+actionFound);
XACMLSDKUtils.debug.message("envFound:"+envFound);
}
if (!resourceFound || !actionFound || !envFound) {
XACMLSDKUtils.debug.error("RequestImpl.processElement(): Some"
+"of required elements are missing");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_subelements"));
}
}
/**
* Returns the one to many Subject elements of this object
*
* @return the Subject elements of this object
*/
public List getSubjects() {
return subjects;
}
/**
* Sets the one to many Subject elements of this object
*
* @param subjects the one to many Subject elements of this
* object
*
* @exception XACMLException if the object is immutable
* An object is considered immutable if
* makeImmutable() has been invoked on it. It can
* be determined by calling isMutable on the object.
*/
public void setSubjects(List subjects) throws XACMLException {
if (!isMutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"objectImmutable"));
}
if (subjects == null || subjects.isEmpty()) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"null_not_valid"));
}
this.subjects.addAll(subjects);
}
/**
* Returns the one to many Resource elements of this object
*
* @return the Resource elements of this object
*/
public List getResources() {
return resources;
}
/**
* Sets the one to many Resource elements of this object
*
* @param resources the one to many Resource elements of this
* object
*
* @exception XACMLException if the object is immutable
* An object is considered immutable if
* makeImmutable() has been invoked on it. It can
* be determined by calling isMutable on the object.
*/
public void setResources(List resources) throws XACMLException {
if (!isMutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"objectImmutable"));
}
if (resources == null || resources.isEmpty()) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid"));
}
this.resources.addAll(resources);
}
/**
* Returns the instance of Action element
*
* @return the instance of Action.
*/
public Action getAction() {
return action;
}
/**
* Sets the instance of Action
*
* @param argAction instance of Action.
*
* @exception XACMLException if the object is immutable
* An object is considered immutable if
* makeImmutable() has been invoked on it. It can
* be determined by calling isMutable on the object.
*/
public void setAction(Action argAction) throws XACMLException {
if (!isMutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"objectImmutable"));
}
if (argAction == null) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid"));
}
action = argAction;
}
/**
* Returns the instance of Environment element.
*
* @return the instance of Environment.
*/
public Environment getEnvironment() {
return env;
}
/**
* Sets the instance of the Environment
*
* @param argEnv instance of Environment.
* @throws XACMLException if the object is immutable
* An object is considered immutable if
* makeImmutable() has been invoked on it. It can
* be determined by calling isMutable on the object.
*/
public void setEnvironment(Environment argEnv) throws XACMLException {
if (!isMutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"objectImmutable"));
}
if (argEnv == null ) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid"));
}
env = argEnv;
}
/**
* Returns a String 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
*/
public String toXMLString(boolean includeNSPrefix, boolean declareNS)
throws XACMLException {
StringBuffer sb = new StringBuffer(2000);
StringBuffer namespaceBuffer = new StringBuffer(100);
String nsDeclaration = "";
if (declareNS) {
namespaceBuffer.append(XACMLConstants.CONTEXT_NS_DECLARATION).
append(XACMLConstants.SPACE);
namespaceBuffer.append(XACMLConstants.XSI_NS_URI).
append(XACMLConstants.SPACE).append(XACMLConstants.
CONTEXT_SCHEMA_LOCATION);
}
if (includeNSPrefix) {
nsDeclaration = XACMLConstants.CONTEXT_NS_PREFIX + ":";
}
sb.append("\n<").append(nsDeclaration).append(XACMLConstants.REQUEST).
append(namespaceBuffer).append(">\n");
int length = 0;
if (subjects != null && !subjects.isEmpty()) {
length = subjects.size();
for (int i = 0; i < length; i++) {
Subject sub = (Subject)subjects.get(i);
sb.append(sub.toXMLString(includeNSPrefix, false));
}
}
if (resources != null && !resources.isEmpty()) {
length = resources.size();
for (int i = 0; i < length; i++) {
Resource resource = (Resource)resources.get(i);
sb.append(resource.toXMLString(includeNSPrefix, false));
}
}
if (action != null) {
sb.append(action.toXMLString(includeNSPrefix, false));
}
if (env != null) {
sb.append(env.toXMLString(includeNSPrefix, false));
}
sb.append("\n");
return sb.toString();
}
/**
* Returns a string representation of this object
*
* @return a string representation of this object
* @exception XACMLException if conversion fails for any reason
*/
public String toXMLString() throws XACMLException {
return this.toXMLString(true, false);
}
/**
* Makes the object immutable
*/
public void makeImmutable() {}
/**
* Checks if the object is mutable
*
* @return true if the object is mutable,
* false otherwise
*/
public boolean isMutable() {
return isMutable;
}
}