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