/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.util.pipe;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.WSBinding;
import com.sun.xml.ws.api.message.Message;
import com.sun.xml.ws.api.message.Packet;
import com.sun.xml.ws.api.pipe.Tube;
import com.sun.xml.ws.api.pipe.TubeCloner;
import com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl;
import com.sun.xml.ws.api.server.DocumentAddressResolver;
import com.sun.xml.ws.api.server.SDDocument;
import com.sun.xml.ws.developer.SchemaValidationFeature;
import com.sun.xml.ws.developer.ValidationErrorHandler;
import com.sun.xml.ws.util.ByteArrayBuffer;
import com.sun.xml.ws.util.MetadataUtil;
import com.sun.xml.ws.util.xml.XmlUtil;
import com.sun.xml.ws.wsdl.parser.WSDLConstants;
import org.w3c.dom.*;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.NamespaceSupport;
import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Validator;
import javax.xml.ws.WebServiceException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;
/**
* {@link Tube} that does the schema validation.
*
* @author Jitendra Kotamraju
*/
public abstract class AbstractSchemaValidationTube extends AbstractFilterTubeImpl {
private static final Logger LOGGER = Logger.getLogger(AbstractSchemaValidationTube.class.getName());
protected static final String HONOUR_ALL_SCHEMA_LOCATIONS_ID = "http://apache.org/xml/features/honour-all-schemaLocations";
protected final WSBinding binding;
protected final SchemaValidationFeature feature;
protected final DocumentAddressResolver resolver = new ValidationDocumentAddressResolver();
public AbstractSchemaValidationTube(WSBinding binding, Tube next) {
super(next);
this.binding = binding;
feature = binding.getFeature(SchemaValidationFeature.class);
}
protected AbstractSchemaValidationTube(AbstractSchemaValidationTube that, TubeCloner cloner) {
super(that, cloner);
this.binding = that.binding;
this.feature = that.feature;
}
protected abstract Validator getValidator();
protected abstract boolean isNoValidation();
private static class ValidationDocumentAddressResolver implements DocumentAddressResolver {
@Nullable
public String getRelativeAddressFor(@NotNull SDDocument current, @NotNull SDDocument referenced) {
LOGGER.fine("Current = "+current.getURL()+" resolved relative="+referenced.getURL());
return referenced.getURL().toExternalForm();
}
}
protected Document createDOM(SDDocument doc) {
// Get infoset
ByteArrayBuffer bab = new ByteArrayBuffer();
try {
doc.writeTo(null, resolver, bab);
} catch (IOException ioe) {
throw new WebServiceException(ioe);
}
// Convert infoset to DOM
Transformer trans = XmlUtil.newTransformer();
Source source = new StreamSource(bab.newInputStream(), null); //doc.getURL().toExternalForm());
DOMResult result = new DOMResult();
try {
trans.transform(source, result);
} catch(TransformerException te) {
throw new WebServiceException(te);
}
return (Document)result.getNode();
}
/**
* Constructs list of schema documents as follows:
* - all <xsd:schema> fragements from all WSDL documents.
* - all schema documents in the application(from WAR etc)
*
* @param primary wsdl/schema document
* @param mdresolver resolves metadata documents
* @return list of root schema documents
*/
protected Source[] getSchemaSources(String primary, MetadataUtil.MetadataResolver mdresolver) {
Map<String, SDDocument> docs = MetadataUtil.getMetadataClosure(primary, mdresolver, true);
List<Source> list = new ArrayList<Source>();
List<Source> externalSchemas = new ArrayList<Source>();
for(Map.Entry<String, SDDocument> entry : docs.entrySet()) {
SDDocument doc = entry.getValue();
// Add all xsd:schema fragments from all WSDLs. That should form a closure of schemas.
if (doc.isWSDL()) {
Document dom = createDOM(doc);
// Get xsd:schema node from WSDL's DOM
addSchemaFragmentSource(dom, doc.getURL().toExternalForm(), list);
} else if (doc.isSchema()) {
// If there are multiple schemas with the same targetnamespace,
// JAXP works only with the first one. Above, all schema fragments may have the same targetnamespace,
// and that means it will not include all the schemas. Since we have a list of schemas, just add them.
Document dom = createDOM(doc);
externalSchemas.add(new DOMSource(dom, doc.getURL().toExternalForm()));
}
}
// "honour-all-schemaLocations" feature only applies today to multiple
// imports for the same namespace contained directly or indirectly from
// a root schema document. By adding wsdl schema fragments firs in the
// list may capture many root schema document.
list.addAll(externalSchemas);
return list.toArray(new Source[list.size()]) ;
}
/**
* Locates xsd:schema elements in the WSDL and creates DOMSource and adds them to the list
*
* @param doc WSDL document
* @param systemId systemId for WSDL document
* @param list xsd:schema DOMSource list
*/
protected @Nullable void addSchemaFragmentSource(Document doc, String systemId, List<Source> list) {
Element e = doc.getDocumentElement();
assert e.getNamespaceURI().equals(WSDLConstants.NS_WSDL);
assert e.getLocalName().equals("definitions");
NodeList typesList = e.getElementsByTagNameNS(WSDLConstants.NS_WSDL, "types");
for(int i=0; i < typesList.getLength(); i++) {
NodeList schemaList = ((Element)typesList.item(i)).getElementsByTagNameNS(WSDLConstants.NS_XMLNS, "schema");
for(int j=0; j < schemaList.getLength(); j++) {
Element elem = (Element)schemaList.item(j);
NamespaceSupport nss = new NamespaceSupport();
buildNamespaceSupport(nss, elem);
patchDOMFragment(nss, elem);
list.add(new DOMSource(elem, systemId+"#schema"+j));
}
}
}
/**
* Recursively visit ancestors and build up {@link org.xml.sax.helpers.NamespaceSupport} oject.
*/
private void buildNamespaceSupport(NamespaceSupport nss, Node node) {
if(node==null || node.getNodeType()!=Node.ELEMENT_NODE)
return;
buildNamespaceSupport( nss, node.getParentNode() );
nss.pushContext();
NamedNodeMap atts = node.getAttributes();
for( int i=0; i<atts.getLength(); i++ ) {
Attr a = (Attr)atts.item(i);
if( "xmlns".equals(a.getPrefix()) ) {
nss.declarePrefix( a.getLocalName(), a.getValue() );
continue;
}
if( "xmlns".equals(a.getName()) ) {
nss.declarePrefix( "", a.getValue() );
continue;
}
}
}
/**
* Adds inscope namespaces as attributes to <xsd:schema> fragment nodes.
*
* @param nss namespace context info
* @param elem that is patched with inscope namespaces
*/
private @Nullable void patchDOMFragment(NamespaceSupport nss, Element elem) {
NamedNodeMap atts = elem.getAttributes();
for( Enumeration en = nss.getPrefixes(); en.hasMoreElements(); ) {
String prefix = (String)en.nextElement();
for( int i=0; i<atts.getLength(); i++ ) {
Attr a = (Attr)atts.item(i);
if (!"xmlns".equals(a.getPrefix()) || !a.getLocalName().equals(prefix)) {
LOGGER.fine("Patching with xmlns:"+prefix+"="+nss.getURI(prefix));
elem.setAttributeNS(XMLConstants.XMLNS_ATTRIBUTE_NS_URI, "xmlns:"+prefix, nss.getURI(prefix));
}
}
}
}
// @Override
// public NextAction processRequest(Packet request) {
// if (isNoValidation() || !request.getMessage().hasPayload() || request.getMessage().isFault()) {
// return super.processRequest(request);
// }
// doProcess(request);
// return super.processRequest(request);
// }
//
// @Override
// public NextAction processResponse(Packet response) {
// if (isNoValidation() || response.getMessage() == null || !response.getMessage().hasPayload() || response.getMessage().isFault()) {
// return super.processResponse(response);
// }
// doProcess(response);
// return super.processResponse(response);
// }
protected void doProcess(Packet packet) throws SAXException {
getValidator().reset();
Class<? extends ValidationErrorHandler> handlerClass = feature.getErrorHandler();
ValidationErrorHandler handler;
try {
handler = handlerClass.newInstance();
} catch(Exception e) {
throw new WebServiceException(e);
}
handler.setPacket(packet);
getValidator().setErrorHandler(handler);
Message msg = packet.getMessage().copy();
Source source = msg.readPayloadAsSource();
try {
// Validator javadoc allows ONLY SAX, and DOM Sources
// But the impl seems to handle all kinds.
getValidator().validate(source);
} catch(IOException e) {
throw new WebServiceException(e);
}
}
protected DOMSource toDOMSource(Source source) {
if (source instanceof DOMSource) {
return (DOMSource)source;
}
Transformer trans = XmlUtil.newTransformer();
DOMResult result = new DOMResult();
try {
trans.transform(source, result);
} catch(TransformerException te) {
throw new WebServiceException(te);
}
return new DOMSource(result.getNode());
}
protected static void printDOM(DOMSource src) {
try {
ByteArrayBuffer bos = new ByteArrayBuffer();
StreamResult sr = new StreamResult(bos );
Transformer trans = TransformerFactory.newInstance().newTransformer();
trans.transform(src, sr);
LOGGER.info("**** src ******"+bos.toString());
bos.close();
} catch(Exception e) {
e.printStackTrace();
}
}
}