JAX-WS API 2.3.1 · javax.xml.ws.BindingProvider

Field Summary

Modifier and Type	Field and Description
public static final String	ENDPOINT_ADDRESS_PROPERTY Standard property: Target service endpoint address.
public static final String	PASSWORD_PROPERTY Standard property: Password for authentication.
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.
public static final String	SOAPACTION_URI_PROPERTY Standard property for SOAPAction.
public static final String	SOAPACTION_USE_PROPERTY Standard property for SOAPAction.
public static final String	USERNAME_PROPERTY Standard property: User name for authentication.

Method Summary

Modifier and Type	Method and Description
public Binding	Returns: The Binding for this binding provider. getBinding() Get the Binding for this binding provider.
public EndpointReference	Returns: EndpointReference of the target endpoint associated with this `BindingProvider` instance. getEndpointReference() Returns the `EndpointReference` associated with this `BindingProvider` instance.
public < the type of `EndpointReference` T extends EndpointReference> T	Returns: EndpointReference of the target endpoint associated with this `BindingProvider` instance. MUST be of type `clazz`. getEndpointReference(Class<T> Specifies the type of `EndpointReference` that MUST be returned. clazz) Returns the `EndpointReference` associated with this `BindingProvider` instance.
public Map<String, Object>	Returns: The context that is used in processing request messages. getRequestContext() Get the context that is used to initialize the message context for request messages.
public Map<String, Object>	Returns: The context that resulted from processing the latest response messages. getResponseContext() Get the context that resulted from processing a response message.

Field Detail

ENDPOINT_ADDRESS_PROPERTY back to summary

ENDPOINT_ADDRESS_PROPERTY	back to summary
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 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

PASSWORD_PROPERTY back to summary

PASSWORD_PROPERTY	back to summary
public static final String PASSWORD_PROPERTY Standard property: Password for authentication. Type: `java.lang.String`

public static final String PASSWORD_PROPERTY

Standard property: Password for authentication.

Type: java.lang.String

SESSION_MAINTAIN_PROPERTY back to summary

SESSION_MAINTAIN_PROPERTY	back to summary
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 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

SOAPACTION_URI_PROPERTY back to summary

SOAPACTION_URI_PROPERTY	back to summary
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`

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

SOAPACTION_USE_PROPERTY back to summary

SOAPACTION_USE_PROPERTY	back to summary
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_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

USERNAME_PROPERTY back to summary

USERNAME_PROPERTY	back to summary
public static final String USERNAME_PROPERTY Standard property: User name for authentication. Type: `java.lang.String`

public static final String USERNAME_PROPERTY

Standard property: User name for authentication.

Type: java.lang.String

Method Detail

getBinding	back to summary
public Binding getBinding() Get the Binding for this binding provider. Returns:Binding The Binding for this binding provider.

getBinding

back to summary

public Binding getBinding()

Get the Binding for this binding provider.

Returns:Binding: The Binding for this binding provider.

getEndpointReference back to summary

getEndpointReference	back to summary
public EndpointReference getEndpointReference() 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. Returns:EndpointReference EndpointReference of the target endpoint associated with this `BindingProvider` instance. Exceptions UnsupportedOperationException: If this `BindingProvider` uses the XML/HTTP binding. Since 1.6, JAX-WS 2.1 See Also `W3CEndpointReference`

public EndpointReference getEndpointReference()

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.

Returns:EndpointReference

EndpointReference of the target endpoint associated with this BindingProvider instance.

Exceptions

UnsupportedOperationException:: If this BindingProvider uses the XML/HTTP binding.

Since

1.6, JAX-WS 2.1

See Also

W3CEndpointReference

getEndpointReference back to summary

getEndpointReference	back to summary
public <T extends EndpointReference> T getEndpointReference(Class<T> clazz) Returns the `EndpointReference` associated with this `BindingProvider` instance. The instance returned will be of type `clazz`. Parameters <T> the type of `EndpointReference` clazz:Class<T> Specifies the type of `EndpointReference` that MUST be returned. Returns:T EndpointReference of the target endpoint associated with this `BindingProvider` instance. MUST be of type `clazz`. Exceptions WebServiceException: If the Class `clazz` is not supported by this implementation. UnsupportedOperationException: If this `BindingProvider` uses the XML/HTTP binding. Since 1.6, JAX-WS 2.1

public <T extends EndpointReference> T getEndpointReference(Class<T> clazz)

Returns the EndpointReference associated with this BindingProvider instance. The instance returned will be of type clazz.

Parameters

<T>: the type of EndpointReference
clazz:Class<T>: Specifies the type of EndpointReference that MUST be returned.

Returns:T

EndpointReference of the target endpoint associated with this BindingProvider instance. MUST be of type clazz.

Exceptions

WebServiceException:: If the Class clazz is not supported by this implementation.
UnsupportedOperationException:: If this BindingProvider uses the XML/HTTP binding.

Since

1.6, JAX-WS 2.1

getRequestContext	back to summary
public Map<String, Object> getRequestContext() 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. Returns:Map<String, Object> The context that is used in processing request messages.

getRequestContext

back to summary

public Map<String, Object> getRequestContext()

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.

Returns:Map<String, Object>: The context that is used in processing request messages.

getResponseContext	back to summary
public Map<String, Object> getResponseContext() 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. Returns:Map<String, Object> The context that resulted from processing the latest response messages.

getResponseContext

back to summary

public Map<String, Object> getResponseContext()

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.

Returns:Map<String, Object>: The context that resulted from processing the latest response messages.

public Interface BindingProvider

Field Summary

Method Summary

Field Detail

Method Detail