com.sun.identity.liberty.ws.paos.PAOSRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openam-federation-library Show documentation
Show all versions of openam-federation-library Show documentation
OpenAM Federation Library Components
/**
* 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
* 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: PAOSRequest.java,v 1.3 2008/06/25 05:47:20 qcheng Exp $
*
*/
package com.sun.identity.liberty.ws.paos;
import com.sun.identity.liberty.ws.soapbinding.Utils;
import com.sun.identity.shared.xml.XMLUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* The PAOSRequest class is used by a web application on
* HTTP server side to construct a PAOS request message and send
* it via an HTTP response to the user agent side.
*
*
*/
public class PAOSRequest {
private String responseConsumerURL;
private String service;
private String messageID;
private Boolean mustUnderstand;
private String actor;
/**
* Constructs the PAOSRequest Object.
*
* @param responseConsumerURL the value of the responseConsumerURL
* attribute
* @param service the value of the service attribute
* @param messageID the value of the messageID attribute
* @param mustUnderstand the value of the mustUnderstand attribute
* @param actor the value of the actor attribute
* @throws PAOSException if PAOSRequest cannot be created.
*/
public PAOSRequest(String responseConsumerURL, String service,
String messageID, Boolean mustUnderstand, String actor)
throws PAOSException {
this.responseConsumerURL = responseConsumerURL;
this.service = service;
this.messageID = messageID;
this.mustUnderstand = mustUnderstand;
this.actor = actor;
validateData();
}
/**
* Constructs the PAOSRequest Object.
*
* @param element the Document Element of PAOS Request object.
* @throws PAOSException if PAOSRequest cannot be created.
*/
public PAOSRequest(Element element) throws PAOSException {
parseElement(element);
}
/**
* Constructs the PAOSRequest Object.
*
* @param xmlString the XML String representation of this object.
* @throws PAOSException if PAOSRequest cannot be created.
*/
public PAOSRequest(String xmlString) throws PAOSException {
Document xmlDocument =
XMLUtils.toDOMDocument(xmlString, PAOSUtils.debug);
if (xmlDocument == null) {
throw new PAOSException(
PAOSUtils.bundle.getString("errorPAOSRequestElement"));
}
parseElement(xmlDocument.getDocumentElement());
}
/**
* Returns the value of the responseConsumerURL attribute.
*
* @return the value of the responseConsumerURL attribute.
* @see #setResponseConsumerURL(String)
*/
public String getResponseConsumerURL() {
return responseConsumerURL;
}
/**
* Sets the value of the responseConsumerURL attribute.
*
* @param responseConsumerURL the value of the responseConsumerURL
* attribute
* @see #getResponseConsumerURL
*/
public void setResponseConsumerURL(String responseConsumerURL) {
this.responseConsumerURL = responseConsumerURL;
}
/**
* Returns the value of the service attribute.
*
* @return the value of the service attribute.
* @see #setService(String)
*/
public String getService() {
return service;
}
/**
* Sets the value of the service attribute.
*
* @param service the value of the service attribute
* @see #getService
*/
public void setService(String service) {
this.service = service;
}
/**
* Returns the value of the messageID attribute.
*
* @return the value of the messageID attribute.
* @see #setMessageID(String)
*/
public String getMessageID() {
return messageID;
}
/**
* Sets the value of the messageID attribute.
*
* @param messageID the value of the messageID attribute
* @see #getMessageID
*/
public void setMessageID(String messageID) {
this.messageID = messageID;
}
/**
* Returns value of mustUnderstand attribute.
*
* @return value of mustUnderstand attribute.
*/
public Boolean isMustUnderstand() {
return mustUnderstand;
}
/**
* Sets the value of the mustUnderstand attribute.
*
* @param mustUnderstand the value of mustUnderstand
* attribute.
*/
public void setMustUnderstand(Boolean mustUnderstand) {
this.mustUnderstand = mustUnderstand;
}
/**
* Returns value of actor attribute.
*
* @return value of actor attribute
*/
public String getActor() {
return actor;
}
/**
* Sets the value of actor attribute.
*
* @param actor the value of actor attribute
*/
public void setActor(String actor) {
this.actor = actor;
}
/**
* Returns a String representation of this Object.
* @return a String representation of this Object.
* @exception PAOSException if it could not create String object
*/
public String toXMLString() throws PAOSException {
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 of this Object.
* @exception PAOSException ,if it could not create String object.
*/
public String toXMLString(boolean includeNSPrefix,boolean declareNS)
throws PAOSException {
validateData();
StringBuffer xml = new StringBuffer(300);
xml.append("<");
if (includeNSPrefix) {
xml.append(PAOSConstants.PAOS_PREFIX).append(":");
}
xml.append(PAOSConstants.REQUEST);
if (declareNS) {
xml.append(" xmlns:").append(PAOSConstants.PAOS_PREFIX)
.append("=\"").append(PAOSConstants.PAOS_NAMESPACE)
.append("\" xmlns:").append(PAOSConstants.SOAP_ENV_PREFIX)
.append("=\"").append(PAOSConstants.SOAP_ENV_NAMESPACE)
.append("\"");
}
xml.append(" ").append(PAOSConstants.RESPONSE_CONSUMER_URL)
.append("=\"").append(responseConsumerURL).append("\"")
.append(" ").append(PAOSConstants.SERVICE).append("=\"")
.append(service).append("\"");
if (messageID != null) {
xml.append(" ").append(PAOSConstants.MESSAGE_ID).append("=\"")
.append(messageID).append("\"");
}
xml.append(" ").append(PAOSConstants.SOAP_ENV_PREFIX).append(":")
.append(PAOSConstants.MUST_UNDERSTAND).append("=\"")
.append(mustUnderstand.toString()).append("\"")
.append(" ").append(PAOSConstants.SOAP_ENV_PREFIX).append(":")
.append(PAOSConstants.ACTOR).append("=\"")
.append(actor).append("\">");
return xml.toString();
}
private void parseElement(Element element) throws PAOSException {
if (element == null) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.parseElement:" +
" Input is null.");
}
throw new PAOSException(
PAOSUtils.bundle.getString("nullInput"));
}
String localName = element.getLocalName();
if (!PAOSConstants.REQUEST.equals(localName)) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.parseElement:" +
" element local name should be " + PAOSConstants.REQUEST);
}
throw new PAOSException(
PAOSUtils.bundle.getString("invalidPAOSRequest"));
}
String namespaceURI = element.getNamespaceURI();
if (!PAOSConstants.PAOS_NAMESPACE.equals(namespaceURI)) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.parseElement:" +
" element namespace should be " +
PAOSConstants.PAOS_NAMESPACE);
}
throw new PAOSException(
PAOSUtils.bundle.getString("invalidPAOSNamesapce"));
}
responseConsumerURL = XMLUtils.getNodeAttributeValue(element,
PAOSConstants.RESPONSE_CONSUMER_URL);
service = XMLUtils.getNodeAttributeValue(element,
PAOSConstants.SERVICE);
messageID = XMLUtils.getNodeAttributeValue(element,
PAOSConstants.MESSAGE_ID);
String str = XMLUtils.getNodeAttributeValueNS(element,
PAOSConstants.SOAP_ENV_NAMESPACE, PAOSConstants.MUST_UNDERSTAND);
try {
mustUnderstand = Utils.StringToBoolean(str);
} catch (Exception ex) {
throw new PAOSException(PAOSUtils.bundle.getString(
"invalidValueMustUnderstand"));
}
actor = XMLUtils.getNodeAttributeValueNS(element,
PAOSConstants.SOAP_ENV_NAMESPACE, PAOSConstants.ACTOR);
validateData();
}
private void validateData() throws PAOSException {
if (responseConsumerURL == null) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.validateData: " +
"responseConsumerURL is missing in the paos:Request");
}
throw new PAOSException(PAOSUtils.bundle.getString(
"missingResponseConsumerURLPAOSRequest"));
}
if (service == null) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.validateData: " +
"service is missing in the paos:Request");
}
throw new PAOSException(PAOSUtils.bundle.getString(
"missingServicePAOSRequest"));
}
if (mustUnderstand == null) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.validateData: " +
"mustUnderstand is missing in the paos:Request");
}
throw new PAOSException(PAOSUtils.bundle.getString(
"missingMustUnderstandPAOSRequest"));
}
if (actor == null) {
if (PAOSUtils.debug.messageEnabled()) {
PAOSUtils.debug.message("PAOSRequest.validateData: " +
"actor is missing in the paos:Request");
}
throw new PAOSException(PAOSUtils.bundle.getString(
"missingActorPAOSRequest"));
}
}
}