/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 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
* https://opensso.dev.java.net/public/CDDLv1.0.html or
* opensso/legal/CDDLv1.0.txt
* 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: StatusImpl.java,v 1.3 2008/06/25 05:48:13 qcheng Exp $
*
*/
package com.sun.identity.xacml.context.impl;
import com.sun.identity.shared.xml.XMLUtils;
import com.sun.identity.xacml.common.XACMLConstants;
import com.sun.identity.xacml.common.XACMLException;
import com.sun.identity.xacml.common.XACMLSDKUtils;
import com.sun.identity.xacml.context.ContextFactory;
import com.sun.identity.xacml.context.Status;
import com.sun.identity.xacml.context.StatusCode;
import com.sun.identity.xacml.context.StatusMessage;
import com.sun.identity.xacml.context.StatusDetail;
import java.util.ArrayList;
import java.util.List;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* The Status element is a container of
* one or more Statuss issuded by authorization authority.
* @supported.all.api
*
*
*
* Schema:
* <xs:complexType name="StatusType">
* <xs:sequence>
* <xs:element ref="xacml-context:StatusCode"/>
* <xs:element ref="xacml-context:StatusMessage" minOccurs="0"/>
* <xs:element ref="xacml-context:StatusDetail" minOccurs="0"/>
* <xs:sequence>
* <xs:complexType>
*/
public class StatusImpl implements Status {
private StatusCode statusCode;
private StatusMessage statusMessage;
private StatusDetail statusDetail;
private boolean mutable = true;
/**
* Constructs a Status object
*/
public StatusImpl() throws XACMLException {
}
/**
* Constructs a Status object from an XML string
*
* @param xml string representing a Status object
* @throws SAMLException if the XML string could not be processed
*/
public StatusImpl(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(
"StatusImpl.processElement(): invalid XML input");
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"errorObtainingElement"));
}
}
/**
* Constructs a Status object from an XML DOM element
*
* @param element XML DOM element representing a Status
* object
*
* @throws SAMLException if the DOM element could not be processed
*/
public StatusImpl(Element element) throws XACMLException {
processElement(element);
makeImmutable();
}
/**
* Returns the StatusCode of this object
*
* @return the StatusCode of this object
*/
public StatusCode getStatusCode() {
return statusCode;
}
/**
* Sets the StatusCode of this object
*
* @exception XACMLException if the object is immutable
*/
public void setStatusCode(StatusCode statusCode) throws XACMLException {
if (!mutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("objectImmutable"));
}
if (statusCode == null) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid"));
}
this.statusCode = statusCode;
}
/**
* Returns the StatusMessage of this object
*
* @return the StatusMessage of this object
*/
public StatusMessage getStatusMessage() {
return statusMessage;
}
/**
* Sets the StatusMessage of this object
*
* @exception XACMLException if the object is immutable
*/
public void setStatusMessage(StatusMessage statusMessage) throws XACMLException {
if (!mutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("objectImmutable"));
}
this.statusMessage = statusMessage;
}
/**
* Returns the StatusDetail of this object
*
* @return the StatusDetail of this object
*/
public StatusDetail getStatusDetail() {
return statusDetail;
}
/**
* Sets the StatusDetail of this object
*
* @exception XACMLException if the object is immutable
*/
public void setStatusDetail(StatusDetail statusDetail) throws XACMLException {
if (!mutable) {
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString("objectImmutable"));
}
this.statusDetail = statusDetail;
}
/**
* Returns a string representation
*
* @return a string representation
* @exception XACMLException if conversion fails for any reason
*/
public String toXMLString() throws XACMLException {
return toXMLString(true, false);
}
/**
* Returns a string representation
* @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
* @exception XACMLException if conversion fails for any reason
*/
public String toXMLString(boolean includeNSPrefix, boolean declareNS)
throws XACMLException {
StringBuffer sb = new StringBuffer(2000);
String nsPrefix = "";
String nsDeclaration = "";
if (includeNSPrefix) {
nsPrefix = XACMLConstants.CONTEXT_NS_PREFIX + ":";
}
if (declareNS) {
nsDeclaration = XACMLConstants.CONTEXT_NS_DECLARATION;
}
sb.append("<").append(nsPrefix).append(XACMLConstants.STATUS).
append(nsDeclaration).append(">\n");
if (statusCode != null) {
sb.append(statusCode.toXMLString(includeNSPrefix, false));
}
if (statusMessage != null) {
sb.append(statusMessage.toXMLString(includeNSPrefix, false));
}
if (statusDetail != null) {
sb.append(statusDetail.toXMLString(includeNSPrefix, false));
}
sb.append("\n");
return sb.toString();
}
/**
* Checks if the object is mutable
*
* @return true if the object is mutable,
* false otherwise
*/
public boolean isMutable() {
return mutable;
}
/**
* Makes the object immutable
*/
public void makeImmutable() {
if (mutable) {
if (statusCode != null) {
statusCode.makeImmutable();
}
if (statusMessage != null) {
statusMessage.makeImmutable();
}
if (statusDetail != null) {
statusDetail.makeImmutable();
}
mutable = false;
}
}
private void processElement(Element element) throws XACMLException {
if (element == null) {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid root element");
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_element"));
}
String elemName = element.getLocalName();
if (elemName == null) {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): local name missing");
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"missing_local_name"));
}
if (!elemName.equals(XACMLConstants.STATUS)) {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid local name " + elemName);
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_local_name"));
}
NodeList nodes = element.getChildNodes();
int numOfNodes = nodes.getLength();
List childElements = new ArrayList();
int i = 0;
while (i < numOfNodes) {
Node child = (Node) nodes.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE) {
childElements.add(child);
}
i++;
}
int childCount = childElements.size();
if (childCount < 1) {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid child element count: "
+ childCount);
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_child_count")); //FIXME: add i18n key
} else if (childCount > 3) {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid child element count: "
+ childCount);
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_child_count")); //FIXME: add i18n key
}
Element firstChild = (Element)childElements.get(0);
String firstChildName = firstChild.getLocalName();
if (firstChildName.equals(XACMLConstants.STATUS_CODE)) {
statusCode = ContextFactory.getInstance()
.createStatusCode(firstChild);
} else {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid first child element: "
+ firstChildName);
throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_first_child")); //FIXME: add i18n key
}
//process statusMessage element
if (childCount > 1) {
Element secondChild = (Element)childElements.get(1);
String secondChildName = secondChild.getLocalName();
if (secondChildName.equals(
XACMLConstants.STATUS_MESSAGE)) {
statusMessage = ContextFactory.getInstance()
.createStatusMessage(secondChild);
} else if (secondChildName.equals(
XACMLConstants.STATUS_DETAIL)) {
if (childCount == 2) {
statusDetail = ContextFactory.getInstance()
.createStatusDetail(secondChild);
} else {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): "
+ "invalid second child element: "
+ secondChildName);
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_second_child")); //FIXME: add i18n key
}
}
if (childCount > 2) {
Element thirdChild = (Element)childElements.get(2);
String thirdChildName = thirdChild.getLocalName();
if (thirdChildName.equals(
XACMLConstants.STATUS_DETAIL)) {
statusDetail = ContextFactory.getInstance()
.createStatusDetail(thirdChild);
} else {
XACMLSDKUtils.debug.error(
"StatusImpl.processElement(): invalid third child element: "
+ thirdChildName);
throw new XACMLException(
XACMLSDKUtils.xacmlResourceBundle.getString(
"invalid_third_child")); //FIXME: add i18n key
}
}
}
}
}