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

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocument.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocument.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 com.sun.istack.internal.Nullable;
aoqi@0	29	import javax.xml.stream.XMLStreamWriter;
aoqi@0	30	import javax.xml.stream.XMLStreamException;
aoqi@0	31	import javax.xml.namespace.QName;
aoqi@0	32	import java.io.OutputStream;
aoqi@0	33	import java.io.IOException;
aoqi@0	34	import java.net.URL;
aoqi@0	35	import java.util.Set;
aoqi@0	36
aoqi@0	37	import com.sun.org.glassfish.gmbal.ManagedAttribute;
aoqi@0	38	import com.sun.org.glassfish.gmbal.ManagedData;
aoqi@0	39
aoqi@0	40	/**
aoqi@0	41	* Represents an individual document that forms a {@link ServiceDefinition}.
aoqi@0	42	*
aoqi@0	43	* <pre>
aoqi@0	44	* TODO:
aoqi@0	45	* how does those documents refer to each other?
aoqi@0	46	*
aoqi@0	47	* </pre>
aoqi@0	48	*
aoqi@0	49	* @author Jitendra Kotamraju
aoqi@0	50	*/
aoqi@0	51	@ManagedData
aoqi@0	52	public interface SDDocument {
aoqi@0	53
aoqi@0	54	/**
aoqi@0	55	* Gets the root tag name of this document.
aoqi@0	56	*
aoqi@0	57	* <p>
aoqi@0	58	* This can be used to identify a kind of document quickly
aoqi@0	59	* (such as schema, WSDL, ...)
aoqi@0	60	*
aoqi@0	61	* @return
aoqi@0	62	* always non-null.
aoqi@0	63	*/
aoqi@0	64	@ManagedAttribute
aoqi@0	65	QName getRootName();
aoqi@0	66
aoqi@0	67	/**
aoqi@0	68	* Returns true if this document is WSDL.
aoqi@0	69	*/
aoqi@0	70	@ManagedAttribute
aoqi@0	71	boolean isWSDL();
aoqi@0	72
aoqi@0	73	/**
aoqi@0	74	* Returns true if this document is schema.
aoqi@0	75	*/
aoqi@0	76	@ManagedAttribute
aoqi@0	77	boolean isSchema();
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* returns the referenced documents
aoqi@0	81	*/
aoqi@0	82	@ManagedAttribute
aoqi@0	83	Set<String> getImports();
aoqi@0	84
aoqi@0	85	/**
aoqi@0	86	* Gets the system ID of the document where it's taken from. Generated documents
aoqi@0	87	* use a fake URL that can be used to resolve relative URLs. So donot use this URL
aoqi@0	88	* for reading or writing.
aoqi@0	89	*/
aoqi@0	90	@ManagedAttribute
aoqi@0	91	URL getURL();
aoqi@0	92
aoqi@0	93	/**
aoqi@0	94	* Writes the document to the given {@link OutputStream}.
aoqi@0	95	*
aoqi@0	96	* <p>
aoqi@0	97	* Since {@link ServiceDefinition} doesn't know which endpoint address
aoqi@0	98	* {@link Adapter} is serving to, (and often it serves multiple URLs
aoqi@0	99	* simultaneously), this method takes the PortAddressResolver as a parameter,
aoqi@0	100	* so that it can produce the corret address information in the generated WSDL.
aoqi@0	101	*
aoqi@0	102	* @param portAddressResolver
aoqi@0	103	* An endpoint address resolver that gives endpoint address for a WSDL
aoqi@0	104	* port. Can be null.
aoqi@0	105	* @param resolver
aoqi@0	106	* Used to resolve relative references among documents.
aoqi@0	107	* @param os
aoqi@0	108	* The {@link OutputStream} that receives the generated document.
aoqi@0	109	*
aoqi@0	110	* @throws IOException
aoqi@0	111	* if there was a failure reported from the {@link OutputStream}.
aoqi@0	112	*/
aoqi@0	113	void writeTo(@Nullable PortAddressResolver portAddressResolver,
aoqi@0	114	DocumentAddressResolver resolver, OutputStream os) throws IOException;
aoqi@0	115
aoqi@0	116	/**
aoqi@0	117	* Writes the document to the given {@link XMLStreamWriter}.
aoqi@0	118	*
aoqi@0	119	* <p>
aoqi@0	120	* The same as {@link #writeTo(PortAddressResolver,DocumentAddressResolver,OutputStream)} except
aoqi@0	121	* it writes to an {@link XMLStreamWriter}.
aoqi@0	122	*
aoqi@0	123	* <p>
aoqi@0	124	* The implementation must not call {@link XMLStreamWriter#writeStartDocument()}
aoqi@0	125	* nor {@link XMLStreamWriter#writeEndDocument()}. Those are the caller's
aoqi@0	126	* responsibility.
aoqi@0	127	*
aoqi@0	128	* @throws XMLStreamException
aoqi@0	129	* if the {@link XMLStreamWriter} reports an error.
aoqi@0	130	*/
aoqi@0	131	void writeTo(PortAddressResolver portAddressResolver,
aoqi@0	132	DocumentAddressResolver resolver, XMLStreamWriter out) throws XMLStreamException, IOException;
aoqi@0	133
aoqi@0	134	/**
aoqi@0	135	* {@link SDDocument} that represents an XML Schema.
aoqi@0	136	*/
aoqi@0	137	interface Schema extends SDDocument {
aoqi@0	138	/**
aoqi@0	139	* Gets the target namepsace of this schema.
aoqi@0	140	*/
aoqi@0	141	@ManagedAttribute
aoqi@0	142	String getTargetNamespace();
aoqi@0	143	}
aoqi@0	144
aoqi@0	145	/**
aoqi@0	146	* {@link SDDocument} that represents a WSDL.
aoqi@0	147	*/
aoqi@0	148	interface WSDL extends SDDocument {
aoqi@0	149	/**
aoqi@0	150	* Gets the target namepsace of this schema.
aoqi@0	151	*/
aoqi@0	152	@ManagedAttribute
aoqi@0	153	String getTargetNamespace();
aoqi@0	154
aoqi@0	155	/**
aoqi@0	156	* This WSDL has a portType definition
aoqi@0	157	* that matches what {@link WSEndpoint} is serving.
aoqi@0	158	*
aoqi@0	159	* TODO: does this info needs to be exposed?
aoqi@0	160	*/
aoqi@0	161	@ManagedAttribute
aoqi@0	162	boolean hasPortType();
aoqi@0	163
aoqi@0	164	/**
aoqi@0	165	* This WSDL has a service definition
aoqi@0	166	* that matches the {@link WSEndpoint}.
aoqi@0	167	*
aoqi@0	168	* TODO: does this info need to be exposed?
aoqi@0	169	*/
aoqi@0	170	@ManagedAttribute
aoqi@0	171	boolean hasService();
aoqi@0	172
aoqi@0	173	/**
aoqi@0	174	* All &lt;service> names that were in this WSDL, or empty set if there was none.
aoqi@0	175	* Used for error diagnostics.
aoqi@0	176	*/
aoqi@0	177	@ManagedAttribute
aoqi@0	178	Set<QName> getAllServices();
aoqi@0	179	}
aoqi@0	180	}