src/share/jaxws_classes/com/sun/xml/internal/ws/util/pipe/DumpTube.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.util.pipe;
ohair@286 27
ohair@286 28 import com.sun.xml.internal.ws.api.message.Packet;
ohair@286 29 import com.sun.xml.internal.ws.api.pipe.NextAction;
ohair@286 30 import com.sun.xml.internal.ws.api.pipe.Pipe;
ohair@286 31 import com.sun.xml.internal.ws.api.pipe.Tube;
ohair@286 32 import com.sun.xml.internal.ws.api.pipe.TubeCloner;
ohair@286 33 import com.sun.xml.internal.ws.api.pipe.helper.AbstractFilterTubeImpl;
ohair@286 34 import com.sun.xml.internal.ws.api.pipe.helper.AbstractTubeImpl;
ohair@286 35
ohair@286 36 import javax.xml.stream.XMLOutputFactory;
ohair@286 37 import javax.xml.stream.XMLStreamException;
ohair@286 38 import javax.xml.stream.XMLStreamWriter;
ohair@286 39 import java.io.PrintStream;
ohair@286 40 import java.lang.reflect.Constructor;
ohair@286 41
ohair@286 42 /**
ohair@286 43 * {@link Pipe} that dumps messages that pass through.
ohair@286 44 *
ohair@286 45 * @author Kohsuke Kawaguchi
ohair@286 46 */
ohair@286 47 public class DumpTube extends AbstractFilterTubeImpl {
ohair@286 48
ohair@286 49 private final String name;
ohair@286 50
ohair@286 51 private final PrintStream out;
ohair@286 52
ohair@286 53 private final XMLOutputFactory staxOut;
ohair@286 54
ohair@286 55 /**
ohair@286 56 * @param name
ohair@286 57 * Specify the name that identifies this {@link DumpTube}
ohair@286 58 * instance. This string will be printed when this pipe
ohair@286 59 * dumps messages, and allows people to distinguish which
ohair@286 60 * pipe instance is dumping a message when multiple
ohair@286 61 * {@link DumpTube}s print messages out.
ohair@286 62 * @param out
ohair@286 63 * The output to send dumps to.
ohair@286 64 * @param next
ohair@286 65 * The next {@link Tube} in the pipeline.
ohair@286 66 */
ohair@286 67 public DumpTube(String name, PrintStream out, Tube next) {
ohair@286 68 super(next);
ohair@286 69 this.name = name;
ohair@286 70 this.out = out;
ohair@286 71 this.staxOut = XMLOutputFactory.newInstance();
ohair@286 72 //staxOut.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES,true);
ohair@286 73 }
ohair@286 74
ohair@286 75 /**
ohair@286 76 * Copy constructor.
ohair@286 77 */
ohair@286 78 protected DumpTube(DumpTube that, TubeCloner cloner) {
ohair@286 79 super(that,cloner);
ohair@286 80 this.name = that.name;
ohair@286 81 this.out = that.out;
ohair@286 82 this.staxOut = that.staxOut;
ohair@286 83 }
ohair@286 84
ohair@286 85 @Override
ohair@286 86 public NextAction processRequest(Packet request) {
ohair@286 87 dump("request",request);
ohair@286 88 return super.processRequest(request);
ohair@286 89 }
ohair@286 90
ohair@286 91 @Override
ohair@286 92 public NextAction processResponse(Packet response) {
ohair@286 93 dump("response",response);
ohair@286 94 return super.processResponse(response);
ohair@286 95 }
ohair@286 96
ohair@286 97 protected void dump(String header, Packet packet) {
ohair@286 98 out.println("====["+name+":"+header+"]====");
ohair@286 99 if(packet.getMessage()==null)
ohair@286 100 out.println("(none)");
ohair@286 101 else
ohair@286 102 try {
ohair@286 103 XMLStreamWriter writer = staxOut.createXMLStreamWriter(new PrintStream(out) {
ohair@286 104 @Override
ohair@286 105 public void close() {
ohair@286 106 // noop
ohair@286 107 }
ohair@286 108 });
ohair@286 109 writer = createIndenter(writer);
ohair@286 110 packet.getMessage().copy().writeTo(writer);
ohair@286 111 writer.close();
ohair@286 112 } catch (XMLStreamException e) {
ohair@286 113 e.printStackTrace(out);
ohair@286 114 }
ohair@286 115 out.println("============");
ohair@286 116 }
ohair@286 117
ohair@286 118 /**
ohair@286 119 * Wraps {@link XMLStreamWriter} by an indentation engine if possible.
ohair@286 120 *
ohair@286 121 * <p>
ohair@286 122 * We can do this only when we have <tt>stax-utils.jar</tt> in the classpath.
ohair@286 123 */
ohair@286 124 private XMLStreamWriter createIndenter(XMLStreamWriter writer) {
ohair@286 125 try {
ohair@286 126 Class clazz = getClass().getClassLoader().loadClass("javanet.staxutils.IndentingXMLStreamWriter");
ohair@286 127 Constructor c = clazz.getConstructor(XMLStreamWriter.class);
ohair@286 128 writer = (XMLStreamWriter)c.newInstance(writer);
ohair@286 129 } catch (Exception e) {
ohair@286 130 // if stax-utils.jar is not in the classpath, this will fail
ohair@286 131 // so, we'll just have to do without indentation
ohair@286 132 if(!warnStaxUtils) {
ohair@286 133 warnStaxUtils = true;
ohair@286 134 out.println("WARNING: put stax-utils.jar to the classpath to indent the dump output");
ohair@286 135 }
ohair@286 136 }
ohair@286 137 return writer;
ohair@286 138 }
ohair@286 139
ohair@286 140
ohair@286 141 public AbstractTubeImpl copy(TubeCloner cloner) {
ohair@286 142 return new DumpTube(this,cloner);
ohair@286 143 }
ohair@286 144
ohair@286 145 private static boolean warnStaxUtils;
ohair@286 146 }

mercurial