All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.api.server.SDDocument Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy