All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.wsdl.parser.W3CAddressingWSDLParserExtension Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.ws.wsdl.parser;

import com.sun.xml.ws.api.addressing.AddressingVersion;
import com.sun.xml.ws.api.model.wsdl.WSDLFeaturedObject;
import static com.sun.xml.ws.api.model.wsdl.WSDLBoundOperation.ANONYMOUS;
import com.sun.xml.ws.api.model.wsdl.editable.*;
import com.sun.xml.ws.api.wsdl.parser.WSDLParserExtension;
import com.sun.xml.ws.api.wsdl.parser.WSDLParserExtensionContext;
import com.sun.xml.ws.streaming.XMLStreamReaderUtil;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import jakarta.xml.ws.WebServiceException;
import jakarta.xml.ws.soap.AddressingFeature;

/**
 * W3C WS-Addressing Runtime WSDL parser extension
 *
 * @author Arun Gupta
 */
public class W3CAddressingWSDLParserExtension extends WSDLParserExtension {
    @Override
    public boolean bindingElements(EditableWSDLBoundPortType binding, XMLStreamReader reader) {
        return addressibleElement(reader, binding);
    }

    @Override
    public boolean portElements(EditableWSDLPort 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(EditableWSDLBoundOperation operation, XMLStreamReader reader) {
        EditableWSDLBoundOperation edit = (EditableWSDLBoundOperation) 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")) {
                    edit.setAnonymous(ANONYMOUS.optional);
                } else if (value.equals("required")) {
                    edit.setAnonymous(ANONYMOUS.required);
                } else if (value.equals("prohibited")) {
                    edit.setAnonymous(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;
    }

    public void portTypeOperationInputAttributes(EditableWSDLInput input, XMLStreamReader reader) {
       String action = ParserUtil.getAttribute(reader, getWsdlActionTag());
       if (action != null) {
            input.setAction(action);
            input.setDefaultAction(false);
        }
    }


    public void portTypeOperationOutputAttributes(EditableWSDLOutput output, XMLStreamReader reader) {
       String action = ParserUtil.getAttribute(reader, getWsdlActionTag());
       if (action != null) {
            output.setAction(action);
            output.setDefaultAction(false);
        }
    }


    public void portTypeOperationFaultAttributes(EditableWSDLFault fault, XMLStreamReader reader) {
        String action = ParserUtil.getAttribute(reader, getWsdlActionTag());
        if (action != null) {
            fault.setAction(action);
            fault.setDefaultAction(false);
        }
    }

    /**
     * Process wsdl:portType operation after the entire WSDL model has been populated.
     * The task list includes: 

*

    *
  • Patch the value of UsingAddressing in wsdl:port and wsdl:binding
  • *
  • Populate actions for the messages that do not have an explicit wsaw:Action
  • *
  • Patch the default value of wsaw:Anonymous=optional if none is specified
  • *
* @param context */ @Override public void finished(WSDLParserExtensionContext context) { EditableWSDLModel model = context.getWSDLModel(); for (EditableWSDLService service : model.getServices().values()) { for (EditableWSDLPort port : service.getPorts()) { EditableWSDLBoundPortType 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; } protected QName getWsdlActionTag() { return AddressingVersion.W3C.wsdlActionTag; } /** * Populate all the Actions * * @param binding soapbinding:operation */ private void populateActions(EditableWSDLBoundPortType binding) { EditableWSDLPortType porttype = binding.getPortType(); for (EditableWSDLOperation o : porttype.getOperations()) { // TODO: this may be performance intensive. Alternatively default action // TODO: can be calculated when the operation is actually invoked. EditableWSDLBoundOperation 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; for (EditableWSDLFault f : o.getFaults()) { if (f.getAction() == null || f.getAction().equals("")) { f.setAction(defaultFaultAction(f.getName(), o)); } } } } /** * Patch the default value of wsaw:Anonymous=optional if none is specified * * @param binding WSDLBoundPortTypeImpl */ protected void patchAnonymousDefault(EditableWSDLBoundPortType binding) { for (EditableWSDLBoundOperation wbo : binding.getBindingOperations()) { if (wbo.getAnonymous() == null) wbo.setAnonymous(ANONYMOUS.optional); } } private String defaultInputAction(EditableWSDLOperation o) { return buildAction(o.getInput().getName(), o, false); } private String defaultOutputAction(EditableWSDLOperation o) { return buildAction(o.getOutput().getName(), o, false); } private String defaultFaultAction(String name, EditableWSDLOperation o) { return buildAction(name, o, true); } protected static final String buildAction(String name, EditableWSDLOperation 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 = "/"; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy