| java.lang.Object
 javax.xml.ws.spi.Provider
| Provider | | abstract public class Provider (Code) | | Service provider for ServiceDelegate and
Endpoint objects.
since:
JAX-WS 2.0 |
| Field Summary | |
| final public static String | JAXWSPROVIDER_PROPERTY
A constant representing the property used to lookup the
name of a Provider implementation
class. |
| Constructor Summary | |
| protected | Provider()
|
| Method Summary | |
| abstract public 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/protocolto use. | | abstract public 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. | | abstract public ServiceDelegate | createServiceDelegate(java.net.URL wsdlDocumentLocation, QName serviceName, Class serviceClass)
Creates a service delegate object.
Parameters:
wsdlDocumentLocation - A URL pointing to the WSDL documentfor the service, or null if there isn't one.
Parameters:
serviceName - The qualified name of the service.
Parameters:
serviceClass - The service class, which MUST be eitherjavax.xml.ws.Service or a subclass thereof. | | abstract public W3CEndpointReference | createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> 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. | | abstract public T | getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features)
The getPort method returns a proxy. | | public static Provider | provider()
Creates a new provider object. | | abstract public EndpointReference | readEndpointReference(javax.xml.transform.Source eprInfoset)
read an EndpointReference from the infoset contained in
eprInfoset.
the EndpointReference unmarshalled fromeprInfoset. |
| JAXWSPROVIDER_PROPERTY | | final public static String JAXWSPROVIDER_PROPERTY(Code) | | A constant representing the property used to lookup the
name of a Provider implementation
class.
|
| Provider | | protected Provider()(Code) | | Creates a new instance of Provider
|
| createAndPublishEndpoint | | abstract public Endpoint createAndPublishEndpoint(String address, Object implementor)(Code) | | Creates and publishes an endpoint object with the specified
address and implementation object.
Parameters:
address - A URI specifying the address and transport/protocolto use. A http: URI MUST result in the SOAP 1.1/HTTPbinding being used. Implementations may support otherURI schemes.
Parameters:
implementor - A service implementation object to whichincoming requests will be dispatched. The correspondingclass MUST be annotated with all the necessary Web serviceannotations. The newly created endpoint. |
| createEndpoint | | abstract public Endpoint createEndpoint(String bindingId, Object implementor)(Code) | | Creates an endpoint object with the provided binding and implementation
object.
Parameters:
bindingId - A URI specifying the desired binding (e.g. SOAP/HTTP)
Parameters:
implementor - A service implementation object to whichincoming requests will be dispatched. The correspondingclass MUST be annotated with all the necessary Web serviceannotations. The newly created endpoint. |
| createServiceDelegate | | abstract public ServiceDelegate createServiceDelegate(java.net.URL wsdlDocumentLocation, QName serviceName, Class serviceClass)(Code) | | Creates a service delegate object.
Parameters:
wsdlDocumentLocation - A URL pointing to the WSDL documentfor the service, or null if there isn't one.
Parameters:
serviceName - The qualified name of the service.
Parameters:
serviceClass - The service class, which MUST be eitherjavax.xml.ws.Service or a subclass thereof. The newly created service delegate. |
| createW3CEndpointReference | | abstract public W3CEndpointReference createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters)(Code) | | 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
Parameters:
serviceName - Qualified name of the service in the WSDL.
Parameters:
portName - Qualified name of the endpoint in the WSDL.
Parameters:
metadata - A list of elements that should be added to the W3CEndpointReference instances wsa:metadata element.
Parameters:
wsdlDocumentLocation - URL for the WSDL document location for the service.
Parameters:
referenceParameters - Reference parameters to be associated with the returned EndpointReference instance. the W3CEndpointReference created from serviceName, portName,metadata, wsdlDocumentLocation and referenceParameters. This methodnever returns null.
throws:
java.lang.IllegalStateException - - If the
address, serviceName andportName are all null. - If the
serviceName service is null and theportName> is NOT null.- If the
address property is null andthe serviceName and portName do notspecify a valid endpoint published by the same Java EEapplication. - If the
serviceNameis NOT nulland is not present in the specified WSDL. - If the
portName port is not null and itis not present in serviceName service in the WSDL.- If the
wsdlDocumentLocation is NOT nulland does not represent a valid WSDL.
throws:
WebServiceException - If an error occurs while creating the W3CEndpointReference.
since:
JAX-WS 2.1 |
| getPort | | abstract public T getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features)(Code) | | 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 willbe invoked by the returned proxy.
Parameters:
serviceEndpointInterface - Service endpoint interface
Parameters:
features - A list of WebServiceFeatures to configure on theproxy. Supported features not in the features parameter will have their default values. Object Proxy instance that supports thespecified service endpoint interface
throws:
WebServiceException - - If there is an error during creationof the proxy
- If there is any missing WSDL metadataas required by this method}
- If this
endpointReferenceis illegal - If an illegal
serviceEndpointInterfaceis specified - If a feature is enabled that is not compatible withthis port or is unsupported.
See Also: WebServiceFeature
since:
JAX-WS 2.1 |
| provider | | public static Provider provider()(Code) | | 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 | | abstract public EndpointReference readEndpointReference(javax.xml.transform.Source eprInfoset)(Code) | | read an EndpointReference from the infoset contained in
eprInfoset.
the EndpointReference unmarshalled fromeprInfoset. This method never returns null.
throws:
WebServiceException - If there is an error creating theEndpointReference from the specified eprInfoset.
throws:
NullPointerException - If the nulleprInfoset value is given.
since:
JAX-WS 2.1 |
|
|