jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentFilter.java@9c07ef4934dd

     1 /*

     2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.xml.internal.ws.api.server;

    28 import javax.xml.stream.XMLStreamException;

    29 import javax.xml.stream.XMLStreamWriter;

    30 import java.io.IOException;

    32 /**

    33  * Provides a way to filter {@link SDDocument} infoset while writing it. These

    34  * filter objects can be added to {@link ServiceDefinition} using

    35  * {@link ServiceDefinition#addFilter(SDDocumentFilter)}

    36  *

    37  * @author Kohsuke Kawaguchi

    38  * @author Jitendra Kotamraju

    39  */

    40 public interface SDDocumentFilter {

    41     /**

    42      * Returns a wrapped XMLStreamWriter on top of passed-in XMLStreamWriter.

    43      * It works like any filtering API for e.g. {@link java.io.FilterOutputStream}.

    44      * The method returns a XMLStreamWriter that calls the same methods on original

    45      * XMLStreamWriter with some modified events. The end result is some infoset

    46      * is filtered before it reaches the original writer and the infoset writer

    47      * doesn't have to change any code to incorporate this filter.

    48      *

    49      * @param doc gives context for the filter. This should only be used to query

    50      *  read-only information. Calling doc.writeTo() may result in infinite loop.

    51      * @param w Original XMLStreamWriter

    52      * @return Filtering {@link XMLStreamWriter}

    53      */

    54     XMLStreamWriter filter(SDDocument doc, XMLStreamWriter w) throws XMLStreamException, IOException;

    55 }

Mercurial > jdk8-mips64-public > jaxws / file revision