This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.xml.ws.spi
class Provider

java.lang.Object extended by javax.xml.ws.spi.Provider 
public abstract class Provider
extends Object

Service provider for ServiceDelegate and Endpoint objects.

Field Summary
static String JAXWSPROVIDER_PROPERTY
          A constant representing the property used to lookup the name of a Provider implementation class.
 
Constructor Summary
protected
Provider()

          Creates a new instance of Provider
 
Method Summary
abstract Endpoint
createAndPublishEndpoint(String address, Object implementor)

          Creates and publishes an endpoint object with the specified address and implementation object.
abstract Endpoint
createEndpoint(String bindingId, Object implementor)

          Creates an endpoint object with the provided binding and implementation object.
abstract ServiceDelegate
createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class serviceClass)

          Creates a service delegate object.
abstract W3CEndpointReference
createW3CEndpointReference(String address, QName serviceName, QName portName, List metadata, String wsdlDocumentLocation, List referenceParameters)

          Factory method to create a W3CEndpointReference.
abstract Object
getPort(EndpointReference endpointReference, Class serviceEndpointInterface, WebServiceFeature[] features)

          The getPort method returns a proxy.
static Provider
provider()

          Creates a new provider object.
abstract EndpointReference
readEndpointReference(Source eprInfoset)

          read an EndpointReference from the infoset contained in eprInfoset.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JAXWSPROVIDER_PROPERTY

public static final String JAXWSPROVIDER_PROPERTY
A constant representing the property used to lookup the name of a Provider implementation class.
Constructor Detail

Provider

protected Provider()
Creates a new instance of Provider

Method Detail

createAndPublishEndpoint

public abstract Endpoint createAndPublishEndpoint(String address,
                                                  Object implementor)
Creates and publishes an endpoint object with the specified address and implementation object.

Parameters:
address - A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.
implementor - A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.
Returns:
The newly created endpoint.

createEndpoint

public abstract Endpoint createEndpoint(String bindingId,
                                        Object implementor)
Creates an endpoint object with the provided binding and implementation object.

Parameters:
bindingId - A URI specifying the desired binding (e.g. SOAP/HTTP)
implementor - A service implementation object to which incoming requests will be dispatched. The corresponding class MUST be annotated with all the necessary Web service annotations.
Returns:
The newly created endpoint.

createServiceDelegate

public abstract ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation,
                                                      QName serviceName,
                                                      Class serviceClass)
Creates a service delegate object.

Parameters:
wsdlDocumentLocation - A URL pointing to the WSDL document for the service, or null if there isn't one.
serviceName - The qualified name of the service.
serviceClass - The service class, which MUST be either javax.xml.ws.Service or a subclass thereof.
Returns:
The newly created service delegate.

createW3CEndpointReference

public abstract W3CEndpointReference createW3CEndpointReference(String address,
                                                                QName serviceName,
                                                                QName portName,
                                                                List metadata,
                                                                String wsdlDocumentLocation,
                                                                List referenceParameters)
Factory method to create a W3CEndpointReference.

This method can be used to create a W3CEndpointReference for any endpoint by specifying the address property along with any other desired properties. This method can also be used to create a W3CEndpointReference for an endpoint that is published by the same Java EE application. To do so the address property can be provided or this method can automatically determine the address of an endpoint that is published by the same Java EE application and is identified by the serviceName and portName propeties. If the address is null and the serviceName and portName do not identify an endpoint published by the same Java EE application, a javax.lang.IllegalStateException MUST be thrown.

Parameters:
address - Specifies the address of the target endpoint
serviceName - Qualified name of the service in the WSDL.
portName - Qualified name of the endpoint in the WSDL.
metadata - A list of elements that should be added to the W3CEndpointReference instances wsa:metadata element.
wsdlDocumentLocation - URL for the WSDL document location for the service.
referenceParameters - Reference parameters to be associated with the returned EndpointReference instance.
Returns:
the W3CEndpointReference created from serviceName, portName, metadata, wsdlDocumentLocation and referenceParameters. This method never returns null.

getPort

public abstract Object getPort(EndpointReference endpointReference,
                               Class serviceEndpointInterface,
                               WebServiceFeature[] features)
The getPort method returns a proxy. If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. The parameter endpointReference specifies the endpoint that will be invoked by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly from the WSDL metadata of the serviceEndpointInterface and the EndpointReference. For this method to successfully return a proxy, WSDL metadata MUST be available and the endpointReference MUST contain an implementation understood serviceName metadata.

Parameters:
endpointReference - the EndpointReference that will be invoked by the returned proxy.
serviceEndpointInterface - Service endpoint interface
features - A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.
Returns:
Object Proxy instance that supports the specified service endpoint interface

provider

public static Provider provider()
Creates a new provider object.

The algorithm used to locate the provider subclass to use consists of the following steps:

  • If a resource with the name of META-INF/services/javax.xml.ws.spi.Provider exists, then its first line, if present, is used as the UTF-8 encoded name of the implementation class.
  • If the $java.home/lib/jaxws.properties file exists and it is readable by the java.util.Properties.load(InputStream) method and it contains an entry whose key is javax.xml.ws.spi.Provider, then the value of that entry is used as the name of the implementation class.
  • If a system property with the name javax.xml.ws.spi.Provider is defined, then its value is used as the name of the implementation class.
  • Finally, a default implementation class name is used.

readEndpointReference

public abstract EndpointReference readEndpointReference(Source eprInfoset)
read an EndpointReference from the infoset contained in eprInfoset.

Parameters:
eprInfoset
Returns:
the EndpointReference unmarshalled from eprInfoset. This method never returns null.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.