ohair@286: /* alanb@368: * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. ohair@286: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. ohair@286: * ohair@286: * This code is free software; you can redistribute it and/or modify it ohair@286: * under the terms of the GNU General Public License version 2 only, as ohair@286: * published by the Free Software Foundation. Oracle designates this ohair@286: * particular file as subject to the "Classpath" exception as provided ohair@286: * by Oracle in the LICENSE file that accompanied this code. ohair@286: * ohair@286: * This code is distributed in the hope that it will be useful, but WITHOUT ohair@286: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or ohair@286: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License ohair@286: * version 2 for more details (a copy is included in the LICENSE file that ohair@286: * accompanied this code). ohair@286: * ohair@286: * You should have received a copy of the GNU General Public License version ohair@286: * 2 along with this work; if not, write to the Free Software Foundation, ohair@286: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. ohair@286: * ohair@286: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@286: * or visit www.oracle.com if you need additional information or have any ohair@286: * questions. ohair@286: */ ohair@286: ohair@286: package com.sun.xml.internal.ws.util.pipe; ohair@286: ohair@286: import com.sun.xml.internal.ws.api.message.Packet; ohair@286: import com.sun.xml.internal.ws.api.pipe.NextAction; ohair@286: import com.sun.xml.internal.ws.api.pipe.Pipe; ohair@286: import com.sun.xml.internal.ws.api.pipe.Tube; ohair@286: import com.sun.xml.internal.ws.api.pipe.TubeCloner; ohair@286: import com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterTubeImpl; ohair@286: import com.sun.xml.internal.ws.api.pipe.helper.AbstractTubeImpl; ohair@286: ohair@286: import javax.xml.stream.XMLOutputFactory; ohair@286: import javax.xml.stream.XMLStreamException; ohair@286: import javax.xml.stream.XMLStreamWriter; ohair@286: import java.io.PrintStream; ohair@286: import java.lang.reflect.Constructor; ohair@286: ohair@286: /** ohair@286: * {@link Pipe} that dumps messages that pass through. ohair@286: * ohair@286: * @author Kohsuke Kawaguchi ohair@286: */ ohair@286: public class DumpTube extends AbstractFilterTubeImpl { ohair@286: ohair@286: private final String name; ohair@286: ohair@286: private final PrintStream out; ohair@286: ohair@286: private final XMLOutputFactory staxOut; ohair@286: ohair@286: /** ohair@286: * @param name ohair@286: * Specify the name that identifies this {@link DumpTube} ohair@286: * instance. This string will be printed when this pipe ohair@286: * dumps messages, and allows people to distinguish which ohair@286: * pipe instance is dumping a message when multiple ohair@286: * {@link DumpTube}s print messages out. ohair@286: * @param out ohair@286: * The output to send dumps to. ohair@286: * @param next ohair@286: * The next {@link Tube} in the pipeline. ohair@286: */ ohair@286: public DumpTube(String name, PrintStream out, Tube next) { ohair@286: super(next); ohair@286: this.name = name; ohair@286: this.out = out; ohair@286: this.staxOut = XMLOutputFactory.newInstance(); ohair@286: //staxOut.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES,true); ohair@286: } ohair@286: ohair@286: /** ohair@286: * Copy constructor. ohair@286: */ ohair@286: protected DumpTube(DumpTube that, TubeCloner cloner) { ohair@286: super(that,cloner); ohair@286: this.name = that.name; ohair@286: this.out = that.out; ohair@286: this.staxOut = that.staxOut; ohair@286: } ohair@286: ohair@286: @Override ohair@286: public NextAction processRequest(Packet request) { ohair@286: dump("request",request); ohair@286: return super.processRequest(request); ohair@286: } ohair@286: ohair@286: @Override ohair@286: public NextAction processResponse(Packet response) { ohair@286: dump("response",response); ohair@286: return super.processResponse(response); ohair@286: } ohair@286: ohair@286: protected void dump(String header, Packet packet) { ohair@286: out.println("====["+name+":"+header+"]===="); ohair@286: if(packet.getMessage()==null) ohair@286: out.println("(none)"); ohair@286: else ohair@286: try { ohair@286: XMLStreamWriter writer = staxOut.createXMLStreamWriter(new PrintStream(out) { ohair@286: @Override ohair@286: public void close() { ohair@286: // noop ohair@286: } ohair@286: }); ohair@286: writer = createIndenter(writer); ohair@286: packet.getMessage().copy().writeTo(writer); ohair@286: writer.close(); ohair@286: } catch (XMLStreamException e) { ohair@286: e.printStackTrace(out); ohair@286: } ohair@286: out.println("============"); ohair@286: } ohair@286: ohair@286: /** ohair@286: * Wraps {@link XMLStreamWriter} by an indentation engine if possible. ohair@286: * ohair@286: *

ohair@286: * We can do this only when we have stax-utils.jar in the classpath. ohair@286: */ ohair@286: private XMLStreamWriter createIndenter(XMLStreamWriter writer) { ohair@286: try { ohair@286: Class clazz = getClass().getClassLoader().loadClass("javanet.staxutils.IndentingXMLStreamWriter"); ohair@286: Constructor c = clazz.getConstructor(XMLStreamWriter.class); ohair@286: writer = (XMLStreamWriter)c.newInstance(writer); ohair@286: } catch (Exception e) { ohair@286: // if stax-utils.jar is not in the classpath, this will fail ohair@286: // so, we'll just have to do without indentation ohair@286: if(!warnStaxUtils) { ohair@286: warnStaxUtils = true; ohair@286: out.println("WARNING: put stax-utils.jar to the classpath to indent the dump output"); ohair@286: } ohair@286: } ohair@286: return writer; ohair@286: } ohair@286: ohair@286: ohair@286: public AbstractTubeImpl copy(TubeCloner cloner) { ohair@286: return new DumpTube(this,cloner); ohair@286: } ohair@286: ohair@286: private static boolean warnStaxUtils; ohair@286: }