01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.server;
38:
39: import javax.xml.stream.XMLStreamException;
40: import javax.xml.stream.XMLStreamWriter;
41: import java.io.IOException;
42:
43: /**
44: * Provides a way to filter {@link SDDocument} infoset while writing it. These
45: * filter objects can be added to {@link ServiceDefinition} using
46: * {@link ServiceDefinition#addFilter(SDDocumentFilter)}
47: *
48: * @author Kohsuke Kawaguchi
49: * @author Jitendra Kotamraju
50: */
51: public interface SDDocumentFilter {
52: /**
53: * Returns a wrapped XMLStreamWriter on top of passed-in XMLStreamWriter.
54: * It works like any filtering API for e.g. {@link java.io.FilterOutputStream}.
55: * The method returns a XMLStreamWriter that calls the same methods on original
56: * XMLStreamWriter with some modified events. The end result is some infoset
57: * is filtered before it reaches the original writer and the infoset writer
58: * doesn't have to change any code to incorporate this filter.
59: *
60: * @param doc gives context for the filter. This should only be used to query
61: * read-only information. Calling doc.writeTo() may result in infinite loop.
62: * @param w Original XMLStreamWriter
63: * @return Filtering {@link XMLStreamWriter}
64: */
65: XMLStreamWriter filter(SDDocument doc, XMLStreamWriter w)
66: throws XMLStreamException, IOException;
67: }
|