• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentFilter.java@0989ad8c0860 (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentFilter.java

Tue, 09 Apr 2013 14:51:13 +0100

author

alanb

date

Tue, 09 Apr 2013 14:51:13 +0100

changeset 368

0989ad8c0860

parent 286

f50545b5e2f1

child 637

9c07ef4934dd

permissions

-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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.api.server;
ohair@286	27
ohair@286	28	import javax.xml.stream.XMLStreamException;
ohair@286	29	import javax.xml.stream.XMLStreamWriter;
ohair@286	30	import java.io.IOException;
ohair@286	31
ohair@286	32	/**
ohair@286	33	* Provides a way to filter {@link SDDocument} infoset while writing it. These
ohair@286	34	* filter objects can be added to {@link ServiceDefinition} using
ohair@286	35	* {@link ServiceDefinition#addFilter(SDDocumentFilter)}
ohair@286	36	*
ohair@286	37	* @author Kohsuke Kawaguchi
ohair@286	38	* @author Jitendra Kotamraju
ohair@286	39	*/
ohair@286	40	public interface SDDocumentFilter {
ohair@286	41	/**
ohair@286	42	* Returns a wrapped XMLStreamWriter on top of passed-in XMLStreamWriter.
ohair@286	43	* It works like any filtering API for e.g. {@link java.io.FilterOutputStream}.
ohair@286	44	* The method returns a XMLStreamWriter that calls the same methods on original
ohair@286	45	* XMLStreamWriter with some modified events. The end result is some infoset
ohair@286	46	* is filtered before it reaches the original writer and the infoset writer
ohair@286	47	* doesn't have to change any code to incorporate this filter.
ohair@286	48	*
ohair@286	49	* @param doc gives context for the filter. This should only be used to query
ohair@286	50	* read-only information. Calling doc.writeTo() may result in infinite loop.
ohair@286	51	* @param w Original XMLStreamWriter
ohair@286	52	* @return Filtering {@link XMLStreamWriter}
ohair@286	53	*/
ohair@286	54	XMLStreamWriter filter(SDDocument doc, XMLStreamWriter w) throws XMLStreamException, IOException;
ohair@286	55	}