Package com.sun.xml.ws.developer
Interface WSBindingProvider
-
- All Superinterfaces:
AutoCloseable
,jakarta.xml.ws.BindingProvider
,Closeable
,Component
,ComponentRegistry
- All Known Implementing Classes:
DataSourceDispatch
,DispatchImpl
,JAXBDispatch
,MessageDispatch
,PacketDispatch
,SEIStub
,SOAPMessageDispatch
,Stub
public interface WSBindingProvider extends jakarta.xml.ws.BindingProvider, Closeable, ComponentRegistry
BindingProvider
with JAX-WS RI's extension methods.- Since:
- 2.1EA3
- Author:
- Kohsuke Kawaguchi, Jitendra Kotamraju
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<Header>
getInboundHeaders()
org.glassfish.gmbal.ManagedObjectManager
getManagedObjectManager()
Get the ManagedObjectManager for this provider.WSPortInfo
getPortInfo()
WSEndpointReference
getWSEndpointReference()
Similar to {link BindingProvider#getEndpointReference(}, but returns WSEndpointReference that has more convenience methodsvoid
setAddress(String address)
Sets the endpoint address for all the invocations that happen fromBindingProvider
.void
setOutboundHeaders(Header... headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.void
setOutboundHeaders(Object... headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.void
setOutboundHeaders(List<Header> headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.-
Methods inherited from interface jakarta.xml.ws.BindingProvider
getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext
-
Methods inherited from interface com.sun.xml.ws.api.ComponentRegistry
getComponents
-
-
-
-
Method Detail
-
setOutboundHeaders
void setOutboundHeaders(List<Header> headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.Calling this method would discard any out-bound headers that were previously set.
A new
Header
object can be created by using one of the methods onHeaders
.- Parameters:
headers
- The headers to be added to the future request messages. To clear the outbound headers, pass in either null or empty list.- Throws:
IllegalArgumentException
- if the list contains null item.
-
setOutboundHeaders
void setOutboundHeaders(Header... headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.Works like
setOutboundHeaders(List)
except that it accepts a var arg array.- Parameters:
headers
- Can be null or empty.
-
setOutboundHeaders
void setOutboundHeaders(Object... headers)
Sets the out-bound headers to be added to messages sent from thisBindingProvider
.Each object must be a JAXB-bound object that is understood by the
JAXBContext
object known by thisWSBindingProvider
(that is, if this is aDispatch
with JAXB, thenJAXBContext
given toService.createDispatch(QName,JAXBContext,Mode)
and if this is a typed proxy, thenJAXBContext
implicitly created by the JAX-WS RI.)- Parameters:
headers
- Can be null or empty.- Throws:
UnsupportedOperationException
- If thisWSBindingProvider
is aDispatch
that does not use JAXB.
-
setAddress
void setAddress(String address)
Sets the endpoint address for all the invocations that happen fromBindingProvider
. Instead of doing the following((BindingProvider)proxy).getRequestContext().put( BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "...")
you could do this:
((WSBindingProvider)proxy).setAddress("...");
- Parameters:
address
- Address of the service
-
getWSEndpointReference
WSEndpointReference getWSEndpointReference()
Similar to {link BindingProvider#getEndpointReference(}, but returns WSEndpointReference that has more convenience methods- Returns:
- WSEndpointReference of the target servcie endpoint
- Since:
- JAX-WS 2.2
-
getPortInfo
WSPortInfo getPortInfo()
- Returns:
- WSPortInfo object that captures the port information for which the stub is created.
- Since:
- JAX-WS 2.2
-
getManagedObjectManager
@NotNull org.glassfish.gmbal.ManagedObjectManager getManagedObjectManager()
Get the ManagedObjectManager for this provider.
-
-