com.sun.xml.ws.api.server.SDDocument Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api.server;
import com.sun.istack.Nullable;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.stream.XMLStreamException;
import javax.xml.namespace.QName;
import java.io.OutputStream;
import java.io.IOException;
import java.net.URL;
import java.util.Set;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedData;
/**
* Represents an individual document that forms a {@link ServiceDefinition}.
*
*
* TODO:
* how does those documents refer to each other?
*
*
*
* @author Jitendra Kotamraju
*/
@ManagedData
public interface SDDocument {
/**
* Gets the root tag name of this document.
*
*
* This can be used to identify a kind of document quickly
* (such as schema, WSDL, ...)
*
* @return
* always non-null.
*/
@ManagedAttribute
QName getRootName();
/**
* Returns true if this document is WSDL.
*/
@ManagedAttribute
boolean isWSDL();
/**
* Returns true if this document is schema.
*/
@ManagedAttribute
boolean isSchema();
/**
* returns the referenced documents
*/
@ManagedAttribute
Set getImports();
/**
* Gets the system ID of the document where it's taken from. Generated documents
* use a fake URL that can be used to resolve relative URLs. So donot use this URL
* for reading or writing.
*/
@ManagedAttribute
URL getURL();
/**
* Writes the document to the given {@link OutputStream}.
*
*
* Since {@link ServiceDefinition} doesn't know which endpoint address
* {@link Adapter} is serving to, (and often it serves multiple URLs
* simultaneously), this method takes the PortAddressResolver as a parameter,
* so that it can produce the corret address information in the generated WSDL.
*
* @param portAddressResolver
* An endpoint address resolver that gives endpoint address for a WSDL
* port. Can be null.
* @param resolver
* Used to resolve relative references among documents.
* @param os
* The {@link OutputStream} that receives the generated document.
*
* @throws IOException
* if there was a failure reported from the {@link OutputStream}.
*/
void writeTo(@Nullable PortAddressResolver portAddressResolver,
DocumentAddressResolver resolver, OutputStream os) throws IOException;
/**
* Writes the document to the given {@link XMLStreamWriter}.
*
*
* The same as {@link #writeTo(PortAddressResolver,DocumentAddressResolver,OutputStream)} except
* it writes to an {@link XMLStreamWriter}.
*
*
* The implementation must not call {@link XMLStreamWriter#writeStartDocument()}
* nor {@link XMLStreamWriter#writeEndDocument()}. Those are the caller's
* responsibility.
*
* @throws XMLStreamException
* if the {@link XMLStreamWriter} reports an error.
*/
void writeTo(PortAddressResolver portAddressResolver,
DocumentAddressResolver resolver, XMLStreamWriter out) throws XMLStreamException, IOException;
/**
* {@link SDDocument} that represents an XML Schema.
*/
interface Schema extends SDDocument {
/**
* Gets the target namepsace of this schema.
*/
@ManagedAttribute
String getTargetNamespace();
}
/**
* {@link SDDocument} that represents a WSDL.
*/
interface WSDL extends SDDocument {
/**
* Gets the target namepsace of this schema.
*/
@ManagedAttribute
String getTargetNamespace();
/**
* This WSDL has a portType definition
* that matches what {@link WSEndpoint} is serving.
*
* TODO: does this info needs to be exposed?
*/
@ManagedAttribute
boolean hasPortType();
/**
* This WSDL has a service definition
* that matches the {@link WSEndpoint}.
*
* TODO: does this info need to be exposed?
*/
@ManagedAttribute
boolean hasService();
/**
* All <service> names that were in this WSDL, or empty set if there was none.
* Used for error diagnostics.
*/
@ManagedAttribute
Set getAllServices();
}
}