jaxws/src/share/classes/com/sun/xml/internal/ws/server/WSDLPatcher.java - platform/libcore - Git at Google

 /*
  * Copyright 2005-2006 Sun Microsystems, Inc.  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.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */
 package com.sun.xml.internal.ws.server;

 import com.sun.xml.internal.ws.api.server.PortAddressResolver;
 import com.sun.xml.internal.ws.api.server.WSEndpoint;
 import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
 import com.sun.xml.internal.ws.api.server.DocumentAddressResolver;
 import com.sun.xml.internal.ws.api.server.SDDocument;
 import com.sun.xml.internal.ws.util.xml.XMLStreamReaderToXMLStreamWriter;
 import com.sun.xml.internal.ws.wsdl.parser.WSDLConstants;
 import com.sun.xml.internal.ws.addressing.W3CAddressingConstants;
 import com.sun.istack.internal.Nullable;

 import javax.xml.namespace.QName;
 import javax.xml.stream.XMLStreamException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.logging.Logger;

 /**
  * Patches WSDL with the correct endpoint address and the relative paths
  * to other documents.
  *
  * @author Jitendra Kotamraju
  * @author Kohsuke Kawaguchi
  */
 final class WSDLPatcher extends XMLStreamReaderToXMLStreamWriter {

     private static final String NS_XSD = "http://www.w3.org/2001/XMLSchema";
     private static final QName SCHEMA_INCLUDE_QNAME = new QName(NS_XSD, "include");
     private static final QName SCHEMA_IMPORT_QNAME = new QName(NS_XSD, "import");

     private static final Logger logger = Logger.getLogger(
             com.sun.xml.internal.ws.util.Constants.LoggingDomain + ".wsdl.patcher");

     /**
      * {@link WSEndpoint} that owns the WSDL we are patching right now.
      */
     private final WSEndpointImpl<?> endpoint;

     /**
      * Document that is being patched.
      */
     private final SDDocumentImpl current;

     private final DocumentAddressResolver resolver;
     private final PortAddressResolver portAddressResolver;


     //
     // fields accumulated as we parse through documents
     //
     private String targetNamespace;
     private QName serviceName;
     private QName portName;

     private enum EPR_ADDRESS_STATE {IN, OUT, DONE}
     private EPR_ADDRESS_STATE eprAddressState = EPR_ADDRESS_STATE.OUT;

     /**
      * Creates a {@link WSDLPatcher} for patching WSDL.
      *
      * @param endpoint
      *      The endpoint that we are patchinig WSDL for. This object is consulted
      *      to check other {@link SDDocument}s. Must not be null.
      * @param current
      *      The document that we are patching. Must not be null.
      * @param portAddressResolver
      *      address of the endpoint is resolved using this resolver.
      * @param resolver
      *      Consulted to generate references among  {@link SDDocument}s.
      *      Must not be null.
      */
     public WSDLPatcher(WSEndpointImpl<?> endpoint, SDDocumentImpl current,
             PortAddressResolver portAddressResolver, DocumentAddressResolver resolver) {
         this.endpoint = endpoint;
         this.current = current;
         this.portAddressResolver = portAddressResolver;
         this.resolver = resolver;
     }

     @Override
     protected void handleAttribute(int i) throws XMLStreamException {
         QName name = in.getName();
         String attLocalName = in.getAttributeLocalName(i);

         if((name.equals(SCHEMA_INCLUDE_QNAME) && attLocalName.equals("schemaLocation"))
         || (name.equals(SCHEMA_IMPORT_QNAME)  && attLocalName.equals("schemaLocation"))
         || (name.equals(WSDLConstants.QNAME_IMPORT)  && attLocalName.equals("location"))) {
             // patch this attribute value.

             String relPath = in.getAttributeValue(i);
             String actualPath = getPatchedImportLocation(relPath);
             if (actualPath == null) {
                 return; // skip this attribute to leave it up to "implicit reference".
             }

             logger.fine("Fixing the relative location:"+relPath
                     +" with absolute location:"+actualPath);
             writeAttribute(i, actualPath);
             return;
         }

         if (name.equals(WSDLConstants.NS_SOAP_BINDING_ADDRESS) ||
             name.equals(WSDLConstants.NS_SOAP12_BINDING_ADDRESS)) {

             if(attLocalName.equals("location")) {
                 String value = getAddressLocation();
                 if (value != null) {
                     logger.fine("Fixing service:"+serviceName+ " port:"+portName
                             + " address with "+value);
                     writeAttribute(i, value);
                     return;
                 }
             }
         }

         super.handleAttribute(i);
     }

     /**
      * Writes out an {@code i}-th attribute but with a different value.
      * @param i attribute index
      * @param value attribute value
      * @throws XMLStreamException when an error encountered while writing attribute
      */
     private void writeAttribute(int i, String value) throws XMLStreamException {
         String nsUri = in.getAttributeNamespace(i);
         if(nsUri!=null)
             out.writeAttribute( in.getAttributePrefix(i), nsUri, in.getAttributeLocalName(i), value );
         else
             out.writeAttribute( in.getAttributeLocalName(i), value );
     }

     @Override
     protected void handleStartElement() throws XMLStreamException {
         QName name = in.getName();

         if (name.equals(WSDLConstants.QNAME_DEFINITIONS)) {
             //String value = in.getAttributeValue("","targetNamespace");
             String value = in.getAttributeValue(null,"targetNamespace");
             if (value != null) {
                 targetNamespace = value;
             }
         } else if (name.equals(WSDLConstants.QNAME_SERVICE)) {
             //String value = in.getAttributeValue("","name");
             String value = in.getAttributeValue(null,"name");
             if (value != null) {
                 serviceName = new QName(targetNamespace, value);
             }
         } else if (name.equals(WSDLConstants.QNAME_PORT)) {
             //String value = in.getAttributeValue("","name");
             String value = in.getAttributeValue(null,"name");
             if (value != null) {
                 portName = new QName(targetNamespace,value);
             }
         } else if (name.equals(W3CAddressingConstants.WSA_ADDRESS_QNAME)) {
             eprAddressState = EPR_ADDRESS_STATE.IN;
         }
         super.handleStartElement();
     }

     @Override
     protected void handleEndElement() throws XMLStreamException {
         QName name = in.getName();
         if (name.equals(W3CAddressingConstants.WSA_ADDRESS_QNAME)) {
             eprAddressState = EPR_ADDRESS_STATE.OUT;
         }
         super.handleEndElement();
     }

     @Override
     protected void handleCharacters() throws XMLStreamException {
         // handleCharacters() may be called multiple times. To take care of this,
         // EPR_ADDRESS_STATE is used.
         if (eprAddressState == EPR_ADDRESS_STATE.IN) {
             String value = getAddressLocation();
             if (value != null) {
                 logger.fine("Fixing EPR Address for service:"+serviceName+ " port:"+portName
                             + " address with "+value);
                 out.writeCharacters(value);
                 eprAddressState = EPR_ADDRESS_STATE.DONE;
             }
         }
         if (eprAddressState != EPR_ADDRESS_STATE.DONE) {
             super.handleCharacters();
         }
     }

     /**
      * Returns the location to be placed into the generated document.
      *
      * @param relPath relative URI to be resolved
      * @return
      *      null to leave it to the "implicit reference".
      */
     private @Nullable String getPatchedImportLocation(String relPath) {
         try {
             ServiceDefinitionImpl def = endpoint.getServiceDefinition();
             assert def !=null; // this code is only used by ServieDefinitionImpl, so this must not be null.

             URL ref = new URL(current.getURL(), relPath);
             SDDocument refDoc = def.getBySystemId(ref);
             if(refDoc==null)
                 return relPath;  // not something we know. just leave it as is.

             return resolver.getRelativeAddressFor(current,refDoc);
         } catch(MalformedURLException mue) {
             return null;
         }
     }

     /**
      * For the given service, port names it matches the correct endpoint and
      * reutrns its endpoint address
      *
      * @return returns the resolved endpoint address
      */
     private String getAddressLocation() {
         return (portAddressResolver == null || portName == null)
                 ? null : portAddressResolver.getAddressFor(serviceName, portName.getLocalPart());
     }
 }
	/*
	* Copyright 2005-2006 Sun Microsystems, Inc. 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. Sun designates this
	* particular file as subject to the "Classpath" exception as provided
	* by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
	* CA 95054 USA or visit www.sun.com if you need additional information or
	* have any questions.
	*/
	package com.sun.xml.internal.ws.server;

	import com.sun.xml.internal.ws.api.server.PortAddressResolver;
	import com.sun.xml.internal.ws.api.server.WSEndpoint;
	import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
	import com.sun.xml.internal.ws.api.server.DocumentAddressResolver;
	import com.sun.xml.internal.ws.api.server.SDDocument;
	import com.sun.xml.internal.ws.util.xml.XMLStreamReaderToXMLStreamWriter;
	import com.sun.xml.internal.ws.wsdl.parser.WSDLConstants;
	import com.sun.xml.internal.ws.addressing.W3CAddressingConstants;
	import com.sun.istack.internal.Nullable;

	import javax.xml.namespace.QName;
	import javax.xml.stream.XMLStreamException;
	import java.net.MalformedURLException;
	import java.net.URL;
	import java.util.logging.Logger;

	/**
	* Patches WSDL with the correct endpoint address and the relative paths
	* to other documents.
	*
	* @author Jitendra Kotamraju
	* @author Kohsuke Kawaguchi
	*/
	final class WSDLPatcher extends XMLStreamReaderToXMLStreamWriter {

	private static final String NS_XSD = "http://www.w3.org/2001/XMLSchema";
	private static final QName SCHEMA_INCLUDE_QNAME = new QName(NS_XSD, "include");
	private static final QName SCHEMA_IMPORT_QNAME = new QName(NS_XSD, "import");

	private static final Logger logger = Logger.getLogger(
	com.sun.xml.internal.ws.util.Constants.LoggingDomain + ".wsdl.patcher");

	/**
	* {@link WSEndpoint} that owns the WSDL we are patching right now.
	*/
	private final WSEndpointImpl<?> endpoint;

	/**
	* Document that is being patched.
	*/
	private final SDDocumentImpl current;

	private final DocumentAddressResolver resolver;
	private final PortAddressResolver portAddressResolver;


	//
	// fields accumulated as we parse through documents
	//
	private String targetNamespace;
	private QName serviceName;
	private QName portName;

	private enum EPR_ADDRESS_STATE {IN, OUT, DONE}
	private EPR_ADDRESS_STATE eprAddressState = EPR_ADDRESS_STATE.OUT;

	/**
	* Creates a {@link WSDLPatcher} for patching WSDL.
	*
	* @param endpoint
	* The endpoint that we are patchinig WSDL for. This object is consulted
	* to check other {@link SDDocument}s. Must not be null.
	* @param current
	* The document that we are patching. Must not be null.
	* @param portAddressResolver
	* address of the endpoint is resolved using this resolver.
	* @param resolver
	* Consulted to generate references among {@link SDDocument}s.
	* Must not be null.
	*/
	public WSDLPatcher(WSEndpointImpl<?> endpoint, SDDocumentImpl current,
	PortAddressResolver portAddressResolver, DocumentAddressResolver resolver) {
	this.endpoint = endpoint;
	this.current = current;
	this.portAddressResolver = portAddressResolver;
	this.resolver = resolver;
	}

	@Override
	protected void handleAttribute(int i) throws XMLStreamException {
	QName name = in.getName();
	String attLocalName = in.getAttributeLocalName(i);

	if((name.equals(SCHEMA_INCLUDE_QNAME) && attLocalName.equals("schemaLocation"))
	\|\| (name.equals(SCHEMA_IMPORT_QNAME) && attLocalName.equals("schemaLocation"))
	\|\| (name.equals(WSDLConstants.QNAME_IMPORT) && attLocalName.equals("location"))) {
	// patch this attribute value.

	String relPath = in.getAttributeValue(i);
	String actualPath = getPatchedImportLocation(relPath);
	if (actualPath == null) {
	return; // skip this attribute to leave it up to "implicit reference".
	}

	logger.fine("Fixing the relative location:"+relPath
	+" with absolute location:"+actualPath);
	writeAttribute(i, actualPath);
	return;
	}

	if (name.equals(WSDLConstants.NS_SOAP_BINDING_ADDRESS) \|\|
	name.equals(WSDLConstants.NS_SOAP12_BINDING_ADDRESS)) {

	if(attLocalName.equals("location")) {
	String value = getAddressLocation();
	if (value != null) {
	logger.fine("Fixing service:"+serviceName+ " port:"+portName
	+ " address with "+value);
	writeAttribute(i, value);
	return;
	}
	}
	}

	super.handleAttribute(i);
	}

	/**
	* Writes out an {@code i}-th attribute but with a different value.
	* @param i attribute index
	* @param value attribute value
	* @throws XMLStreamException when an error encountered while writing attribute
	*/
	private void writeAttribute(int i, String value) throws XMLStreamException {
	String nsUri = in.getAttributeNamespace(i);
	if(nsUri!=null)
	out.writeAttribute( in.getAttributePrefix(i), nsUri, in.getAttributeLocalName(i), value );
	else
	out.writeAttribute( in.getAttributeLocalName(i), value );
	}

	@Override
	protected void handleStartElement() throws XMLStreamException {
	QName name = in.getName();

	if (name.equals(WSDLConstants.QNAME_DEFINITIONS)) {
	//String value = in.getAttributeValue("","targetNamespace");
	String value = in.getAttributeValue(null,"targetNamespace");
	if (value != null) {
	targetNamespace = value;
	}
	} else if (name.equals(WSDLConstants.QNAME_SERVICE)) {
	//String value = in.getAttributeValue("","name");
	String value = in.getAttributeValue(null,"name");
	if (value != null) {
	serviceName = new QName(targetNamespace, value);
	}
	} else if (name.equals(WSDLConstants.QNAME_PORT)) {
	//String value = in.getAttributeValue("","name");
	String value = in.getAttributeValue(null,"name");
	if (value != null) {
	portName = new QName(targetNamespace,value);
	}
	} else if (name.equals(W3CAddressingConstants.WSA_ADDRESS_QNAME)) {
	eprAddressState = EPR_ADDRESS_STATE.IN;
	}
	super.handleStartElement();
	}

	@Override
	protected void handleEndElement() throws XMLStreamException {
	QName name = in.getName();
	if (name.equals(W3CAddressingConstants.WSA_ADDRESS_QNAME)) {
	eprAddressState = EPR_ADDRESS_STATE.OUT;
	}
	super.handleEndElement();
	}

	@Override
	protected void handleCharacters() throws XMLStreamException {
	// handleCharacters() may be called multiple times. To take care of this,
	// EPR_ADDRESS_STATE is used.
	if (eprAddressState == EPR_ADDRESS_STATE.IN) {
	String value = getAddressLocation();
	if (value != null) {
	logger.fine("Fixing EPR Address for service:"+serviceName+ " port:"+portName
	+ " address with "+value);
	out.writeCharacters(value);
	eprAddressState = EPR_ADDRESS_STATE.DONE;
	}
	}
	if (eprAddressState != EPR_ADDRESS_STATE.DONE) {
	super.handleCharacters();
	}
	}

	/**
	* Returns the location to be placed into the generated document.
	*
	* @param relPath relative URI to be resolved
	* @return
	* null to leave it to the "implicit reference".
	*/
	private @Nullable String getPatchedImportLocation(String relPath) {
	try {
	ServiceDefinitionImpl def = endpoint.getServiceDefinition();
	assert def !=null; // this code is only used by ServieDefinitionImpl, so this must not be null.

	URL ref = new URL(current.getURL(), relPath);
	SDDocument refDoc = def.getBySystemId(ref);
	if(refDoc==null)
	return relPath; // not something we know. just leave it as is.

	return resolver.getRelativeAddressFor(current,refDoc);
	} catch(MalformedURLException mue) {
	return null;
	}
	}

	/**
	* For the given service, port names it matches the correct endpoint and
	* reutrns its endpoint address
	*
	* @return returns the resolved endpoint address
	*/
	private String getAddressLocation() {
	return (portAddressResolver == null \|\| portName == null)
	? null : portAddressResolver.getAddressFor(serviceName, portName.getLocalPart());
	}
	}