Module com.sun.xml.ws
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

  • Field Summary

    Fields inherited from interface jakarta.xml.ws.BindingProvider

    ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

  • Method Summary

    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 methods
    void
    setAddress(String address)
    Sets the endpoint address for all the invocations that happen from BindingProvider.
    void
    setOutboundHeaders(Header... headers)
    Sets the out-bound headers to be added to messages sent from this BindingProvider.
    void
    setOutboundHeaders(Object... headers)
    Sets the out-bound headers to be added to messages sent from this BindingProvider.
    void
    setOutboundHeaders(List<Header> headers)
    Sets the out-bound headers to be added to messages sent from this BindingProvider.

    Methods inherited from interface jakarta.xml.ws.BindingProvider

    getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext

    Methods inherited from interface java.io.Closeable

    close

    Methods inherited from interface com.sun.xml.ws.api.Component

    getSPI

    Methods inherited from interface com.sun.xml.ws.api.ComponentRegistry

    getComponents

  • Method Details

    • setOutboundHeaders

      void setOutboundHeaders(List<Header> headers)
      Sets the out-bound headers to be added to messages sent from this BindingProvider.

      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 on Headers.

      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 this BindingProvider.

      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 this BindingProvider.

      Each object must be a JAXB-bound object that is understood by the JAXBContext object known by this WSBindingProvider (that is, if this is a Dispatch with JAXB, then JAXBContext given to Service.createDispatch(QName,JAXBContext,Mode) and if this is a typed proxy, then JAXBContext implicitly created by the JAX-WS RI.)

      Parameters:
      headers - Can be null or empty.
      Throws:
      UnsupportedOperationException - If this WSBindingProvider is a Dispatch that does not use JAXB.

    • getInboundHeaders

      List<Header> getInboundHeaders()

    • setAddress

      void setAddress(String address)
      Sets the endpoint address for all the invocations that happen from BindingProvider. 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.