StatusMessageImpl.java revision a688bcbb4bcff5398fdd29b86f83450257dc0df4
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: StatusMessageImpl.java,v 1.3 2008/06/25 05:48:13 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.common.XACMLSDKUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.xacml.context.StatusMessage;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>StatusMessage</code> element is a container of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * one or more <code>StatusMessage</code>s issuded by authorization authority.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <xs:element name="StatusMessage" type="xs:string"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class StatusMessageImpl implements StatusMessage {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private boolean mutable = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>StatusMessage</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public StatusMessageImpl() throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>StatusMessage</code> object from an XML string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param xml string representing a <code>StatusMessage</code> object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if the XML string could not be processed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public StatusMessageImpl(String xml) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Document document = XMLUtils.toDOMDocument(xml, XACMLSDKUtils.debug);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Element rootElement = document.getDocumentElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "StatusMessageImpl.processElement(): invalid XML input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "errorObtainingElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Constructs a <code>StatusMessage</code> object from an XML DOM element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param element XML DOM element representing a <code>StatusMessage</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAMLException if the DOM element could not be processed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public StatusMessageImpl(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>value</code> of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the <code>value</code> of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the <code>value</code> of this object
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setValue(String value) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.xacmlResourceBundle.getString("objectImmutable"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid")); //i18n
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!XACMLSDKUtils.isValidStatusMessage(value)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.xacmlResourceBundle.getString("invalid_value")); //i18n
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a string representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return toXMLString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a string representation
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
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception XACMLException if conversion fails for any reason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster nsDeclaration = XACMLConstants.CONTEXT_NS_DECLARATION;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster nsPrefix = XACMLConstants.CONTEXT_NS_PREFIX + ":";
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
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public boolean isMutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void makeImmutable() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private void processElement(Element element) throws XACMLException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "StatusMessageImpl.processElement(): invalid root element");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalid_element"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "StatusMessageImpl.processElement(): local name missing");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "missing_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!elemName.equals(XACMLConstants.STATUS_MESSAGE)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "StatusMessageImpl.processElement(): invalid local name "
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throw new XACMLException(XACMLSDKUtils.xacmlResourceBundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster "invalid_local_name"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String elementValue = element.getTextContent();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster XACMLSDKUtils.xacmlResourceBundle.getString("null_not_valid"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (!XACMLSDKUtils.isValidStatusMessage(elementValue.trim())) {