Provider (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

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
  javax.xml.ws.spi.Provider

public abstract class Provider
extends Object
extends Object

Service provider for ServiceDelegate and Endpoint objects.

Since:: JAX-WS 2.0

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.

static Provider provider()
          Creates a new provider object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.
`static Provider`	`provider()` Creates a new provider object.

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.

See Also:: Constant Field Values

Constructor Detail

Provider

protected Provider()

Creates a new instance of Provider

Method Detail

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.

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.

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.

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.