FileDocCategorySizeDatePackage
BindingProvider.javaAPI DocJava SE 6 API5974Tue Jun 10 00:27:14 BST 2008javax.xml.ws

BindingProvider

public interface BindingProvider
The BindingProvider interface provides access to the protocol binding and associated context objects for request and response message processing.
since
JAX-WS 2.0
see
javax.xml.ws.Binding

Fields Summary
public static final String
USERNAME_PROPERTY
Standard property: User name for authentication.

Type: java.lang.String

public static final String
PASSWORD_PROPERTY
Standard property: Password for authentication.

Type: java.lang.String

public static final String
ENDPOINT_ADDRESS_PROPERTY
Standard property: Target service endpoint address. The URI scheme for the endpoint address specification MUST correspond to the protocol/transport binding for the binding in use.

Type: java.lang.String

public static final String
SESSION_MAINTAIN_PROPERTY
Standard property: This boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false.

Type: java.lang.Boolean

public static final String
SOAPACTION_USE_PROPERTY
Standard property for SOAPAction. This boolean property indicates whether or not the value of the javax.xml.ws.soap.http.soapaction.uri property is used for the value of the SOAPAction. The default value of this property is false indicating that the javax.xml.ws.soap.http.soapaction.uri property is not used for the value of the SOAPAction, however, if WS-Addressing is enabled, the default value is true.

Type: java.lang.Boolean

public static final String
SOAPACTION_URI_PROPERTY
Standard property for SOAPAction. Indicates the SOAPAction URI if the javax.xml.ws.soap.http.soapaction.use property is set to true. If WS-Addressing is enabled, this value will also be used for the value of the WS-Addressing Action header. If this property is not set, the default SOAPAction and WS-Addressing Action will be sent.

Type: java.lang.String

Constructors Summary
Methods Summary
public javax.xml.ws.BindinggetBinding()
Get the Binding for this binding provider.

return
The Binding for this binding provider.

public javax.xml.ws.EndpointReferencegetEndpointReference()
Returns the EndpointReference associated with this BindingProvider instance.

If the Binding for this bindingProvider is either SOAP1.1/HTTP or SOAP1.2/HTTP, then a W3CEndpointReference MUST be returned.

return
EndpointReference of the target endpoint associated with this BindingProvider instance.
throws
java.lang.UnsupportedOperationException If this BindingProvider uses the XML/HTTP binding.
see
W3CEndpointReference
since
JAX-WS 2.1

public TgetEndpointReference(java.lang.Class clazz)
Returns the EndpointReference associated with this BindingProvider instance. The instance returned will be of type clazz.

param
clazz Specifies the type of EndpointReference that MUST be returned.
return
EndpointReference of the target endpoint associated with this BindingProvider instance. MUST be of type clazz.
throws
WebServiceException If the Class clazz is not supported by this implementation.
throws
java.lang.UnsupportedOperationException If this BindingProvider uses the XML/HTTP binding.
since
JAX-WS 2.1

public java.util.MapgetRequestContext()
Get the context that is used to initialize the message context for request messages. Modifications to the request context do not affect the message context of either synchronous or asynchronous operations that have already been started.

return
The context that is used in processing request messages.

public java.util.MapgetResponseContext()
Get the context that resulted from processing a response message. The returned context is for the most recently completed synchronous operation. Subsequent synchronous operation invocations overwrite the response context. Asynchronous operations return their response context via the Response interface.

return
The context that resulted from processing the latest response messages.