Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentFilter.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentFilter.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
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.api.server; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.stream.XMLStreamException; |
| aoqi@0 | 29 | import javax.xml.stream.XMLStreamWriter; |
| aoqi@0 | 30 | import java.io.IOException; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * Provides a way to filter {@link SDDocument} infoset while writing it. These |
| aoqi@0 | 34 | * filter objects can be added to {@link ServiceDefinition} using |
| aoqi@0 | 35 | * {@link ServiceDefinition#addFilter(SDDocumentFilter)} |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 38 | * @author Jitendra Kotamraju |
| aoqi@0 | 39 | */ |
| aoqi@0 | 40 | public interface SDDocumentFilter { |
| aoqi@0 | 41 | /** |
| aoqi@0 | 42 | * Returns a wrapped XMLStreamWriter on top of passed-in XMLStreamWriter. |
| aoqi@0 | 43 | * It works like any filtering API for e.g. {@link java.io.FilterOutputStream}. |
| aoqi@0 | 44 | * The method returns a XMLStreamWriter that calls the same methods on original |
| aoqi@0 | 45 | * XMLStreamWriter with some modified events. The end result is some infoset |
| aoqi@0 | 46 | * is filtered before it reaches the original writer and the infoset writer |
| aoqi@0 | 47 | * doesn't have to change any code to incorporate this filter. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * @param doc gives context for the filter. This should only be used to query |
| aoqi@0 | 50 | * read-only information. Calling doc.writeTo() may result in infinite loop. |
| aoqi@0 | 51 | * @param w Original XMLStreamWriter |
| aoqi@0 | 52 | * @return Filtering {@link XMLStreamWriter} |
| aoqi@0 | 53 | */ |
| aoqi@0 | 54 | XMLStreamWriter filter(SDDocument doc, XMLStreamWriter w) throws XMLStreamException, IOException; |
| aoqi@0 | 55 | } |
