/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.xml.internal.ws.wsdl.parser;
import com.sun.xml.internal.ws.api.addressing.AddressingVersion;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLBoundOperation;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLBoundPortType;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLFault;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLFeaturedObject;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLModel;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLOperation;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
import com.sun.xml.internal.ws.api.model.wsdl.WSDLService;
import com.sun.xml.internal.ws.api.wsdl.parser.WSDLParserExtension;
import com.sun.xml.internal.ws.api.wsdl.parser.WSDLParserExtensionContext;
import com.sun.xml.internal.ws.model.wsdl.WSDLBoundOperationImpl;
import com.sun.xml.internal.ws.model.wsdl.WSDLBoundPortTypeImpl;
import com.sun.xml.internal.ws.model.wsdl.WSDLOperationImpl;
import com.sun.xml.internal.ws.model.wsdl.WSDLPortImpl;
import com.sun.xml.internal.ws.model.wsdl.WSDLPortTypeImpl;
import com.sun.xml.internal.ws.streaming.XMLStreamReaderUtil;
import com.sun.xml.internal.ws.resources.AddressingMessages;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.ws.WebServiceException;
import javax.xml.ws.soap.AddressingFeature;
import java.util.Map;
/**
* W3C WS-Addressing Runtime WSDL parser extension
*
* @author Arun Gupta
*/
public class W3CAddressingWSDLParserExtension extends WSDLParserExtension {
@Override
public boolean bindingElements(WSDLBoundPortType binding, XMLStreamReader reader) {
return addressibleElement(reader, binding);
}
@Override
public boolean portElements(WSDLPort port, XMLStreamReader reader) {
return addressibleElement(reader, port);
}
private boolean addressibleElement(XMLStreamReader reader, WSDLFeaturedObject binding) {
QName ua = reader.getName();
if (ua.equals(AddressingVersion.W3C.wsdlExtensionTag)) {
String required = reader.getAttributeValue(WSDLConstants.NS_WSDL, "required");
binding.addFeature(new AddressingFeature(true, Boolean.parseBoolean(required)));
XMLStreamReaderUtil.skipElement(reader);
return true; // UsingAddressing is consumed
}
return false;
}
@Override
public boolean bindingOperationElements(WSDLBoundOperation operation, XMLStreamReader reader) {
WSDLBoundOperationImpl impl = (WSDLBoundOperationImpl)operation;
QName anon = reader.getName();
if (anon.equals(AddressingVersion.W3C.wsdlAnonymousTag)) {
try {
String value = reader.getElementText();
if (value == null || value.trim().equals("")) {
throw new WebServiceException("Null values not permitted in wsaw:Anonymous.");
// TODO: throw exception only if wsdl:required=true
// TODO: is this the right exception ?
} else if (value.equals("optional")) {
impl.setAnonymous(WSDLBoundOperation.ANONYMOUS.optional);
} else if (value.equals("required")) {
impl.setAnonymous(WSDLBoundOperation.ANONYMOUS.required);
} else if (value.equals("prohibited")) {
impl.setAnonymous(WSDLBoundOperation.ANONYMOUS.prohibited);
} else {
throw new WebServiceException("wsaw:Anonymous value \"" + value + "\" not understood.");
// TODO: throw exception only if wsdl:required=true
// TODO: is this the right exception ?
}
} catch (XMLStreamException e) {
throw new WebServiceException(e); // TODO: is this the correct behavior ?
}
return true; // consumed the element
}
return false;
}
@Override
public boolean portTypeOperationInput(WSDLOperation o, XMLStreamReader reader) {
WSDLOperationImpl impl = (WSDLOperationImpl)o;
String action = ParserUtil.getAttribute(reader, AddressingVersion.W3C.wsdlActionTag);
if (action != null) {
impl.getInput().setAction(action);
impl.getInput().setDefaultAction(false);
}
return false;
}
@Override
public boolean portTypeOperationOutput(WSDLOperation o, XMLStreamReader reader) {
WSDLOperationImpl impl = (WSDLOperationImpl)o;
String action = ParserUtil.getAttribute(reader, AddressingVersion.W3C.wsdlActionTag);
if (action != null) {
impl.getOutput().setAction(action);
}
return false;
}
@Override
public boolean portTypeOperationFault(WSDLOperation o, XMLStreamReader reader) {
WSDLOperationImpl impl = (WSDLOperationImpl)o;
String action = ParserUtil.getAttribute(reader, AddressingVersion.W3C.wsdlActionTag);
if (action != null) {
String name = ParserUtil.getMandatoryNonEmptyAttribute(reader, "name");
impl.getFaultActionMap().put(name, action);
}
return false;
}
/**
* Process wsdl:portType operation after the entire WSDL model has been populated.
* The task list includes: <p>
* <ul>
* <li>Patch the value of UsingAddressing in wsdl:port and wsdl:binding</li>
* <li>Populate actions for the messages that do not have an explicit wsaw:Action</li>
* <li>Patch the default value of wsaw:Anonymous=optional if none is specified</li>
* </ul>
* @param context
*/
@Override
public void finished(WSDLParserExtensionContext context) {
WSDLModel model = context.getWSDLModel();
for (WSDLService service : model.getServices().values()) {
for (WSDLPort wp : service.getPorts()) {
WSDLPortImpl port = (WSDLPortImpl)wp;
WSDLBoundPortTypeImpl binding = port.getBinding();
// populate actions for the messages that do not have an explicit wsaw:Action
populateActions(binding);
// patch the default value of wsaw:Anonymous=optional if none is specified
patchAnonymousDefault(binding);
}
}
}
protected String getNamespaceURI() {
return AddressingVersion.W3C.wsdlNsUri;
}
/**
* Populate all the Actions
*
* @param binding soapbinding:operation
*/
private void populateActions(WSDLBoundPortTypeImpl binding) {
WSDLPortTypeImpl porttype = binding.getPortType();
for (WSDLOperationImpl o : porttype.getOperations()) {
// TODO: this may be performance intensive. Alternatively default action
// TODO: can be calculated when the operation is actually invoked.
WSDLBoundOperationImpl wboi = binding.get(o.getName());
if (wboi == null) {
//If this operation is unbound set the action to default
o.getInput().setAction(defaultInputAction(o));
continue;
}
String soapAction = wboi.getSOAPAction();
if (o.getInput().getAction() == null || o.getInput().getAction().equals("")) {
// explicit wsaw:Action is not specified
if (soapAction != null && !soapAction.equals("")) {
// if soapAction is non-empty, use that
o.getInput().setAction(soapAction);
} else {
// otherwise generate default Action
o.getInput().setAction(defaultInputAction(o));
}
}
// skip output and fault processing for one-way methods
if (o.getOutput() == null)
continue;
if (o.getOutput().getAction() == null || o.getOutput().getAction().equals("")) {
o.getOutput().setAction(defaultOutputAction(o));
}
if (o.getFaults() == null || !o.getFaults().iterator().hasNext())
continue;
Map<String,String> map = o.getFaultActionMap();
for (WSDLFault f : o.getFaults()) {
if (map.get(f.getName()) == null || map.get(f.getName()).equals(""))
map.put(f.getName(), defaultFaultAction(f.getName(), o));
}
}
}
/**
* Patch the default value of wsaw:Anonymous=optional if none is specified
*
* @param binding WSDLBoundPortTypeImpl
*/
protected void patchAnonymousDefault(WSDLBoundPortTypeImpl binding) {
for (WSDLBoundOperationImpl wbo : binding.getBindingOperations()) {
if (wbo.getAnonymous() == null)
wbo.setAnonymous(WSDLBoundOperation.ANONYMOUS.optional);
}
}
private String defaultInputAction(WSDLOperation o) {
return buildAction(o.getInput().getName(), o, false);
}
private String defaultOutputAction(WSDLOperation o) {
return buildAction(o.getOutput().getName(), o, false);
}
private String defaultFaultAction(String name, WSDLOperation o) {
return buildAction(name, o, true);
}
protected static final String buildAction(String name, WSDLOperation o, boolean isFault) {
String tns = o.getName().getNamespaceURI();
String delim = SLASH_DELIMITER;
// TODO: is this the correct way to find the separator ?
if (!tns.startsWith("http"))
delim = COLON_DELIMITER;
if (tns.endsWith(delim))
tns = tns.substring(0, tns.length()-1);
if (o.getPortTypeName() == null)
throw new WebServiceException("\"" + o.getName() + "\" operation's owning portType name is null.");
return tns +
delim +
o.getPortTypeName().getLocalPart() +
delim +
(isFault ? o.getName().getLocalPart() + delim + "Fault" + delim : "") +
name;
}
protected static final String COLON_DELIMITER = ":";
protected static final String SLASH_DELIMITER = "/";
}