Package org.apache.axis2.jaxws.spi

Class ServiceDelegate

java.lang.Object
jakarta.xml.ws.spi.ServiceDelegate
org.apache.axis2.jaxws.spi.ServiceDelegate
public class ServiceDelegate extends jakarta.xml.ws.spi.ServiceDelegate
The ServiceDelegate serves as the backing implementation for all of the methods in the Service API. This is the plug point for the client implementation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServiceDelegate(URL url, QName qname, Class clazz, jakarta.xml.ws.WebServiceFeature... features)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPort(QName portName, String bindingId, String endpointAddress)
     
    jakarta.xml.ws.Dispatch<Object>
    createDispatch(jakarta.xml.ws.EndpointReference jaxwsEPR, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
     
    <T> jakarta.xml.ws.Dispatch<T>
    createDispatch(jakarta.xml.ws.EndpointReference jaxwsEPR, Class<T> type, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
     
    jakarta.xml.ws.Dispatch<Object>
    createDispatch(QName portName, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode)
     
    jakarta.xml.ws.Dispatch<Object>
    createDispatch(QName portName, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
     
    <T> jakarta.xml.ws.Dispatch<T>
    createDispatch(QName portName, Class<T> type, jakarta.xml.ws.Service.Mode mode)
     
    <T> jakarta.xml.ws.Dispatch<T>
    createDispatch(QName portName, Class<T> type, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
     
    protected void
    finalize()
     
    Executor
    getExecutor()
     
    jakarta.xml.ws.handler.HandlerResolver
    getHandlerResolver()
     
    <T> T
    getPort(jakarta.xml.ws.EndpointReference jaxwsEPR, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
     
    <T> T
    getPort(Class<T> sei)
     
    <T> T
    getPort(Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
     
    <T> T
    getPort(QName portName, Class<T> sei)
     
    <T> T
    getPort(QName portName, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
     
    <T> T
    getPort(org.apache.axis2.addressing.EndpointReference axis2EPR, String addressingNamespace, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
     
    Iterator<QName>
    getPorts()
     
    org.apache.axis2.client.ServiceClient
    getServiceClient(QName portQName)
     
    org.apache.axis2.jaxws.description.ServiceDescription
    getServiceDescription()
    Get the ServiceDescription tree that this ServiceDelegate
    QName
    getServiceName()
     
    URL
    getWSDLDocumentLocation()
     
    static void
    releaseService(jakarta.xml.ws.Service service)
    PROPRIETARY METHOD TO RELEASE RESOUCES.
    void
    setExecutor(Executor e)
     
    void
    setHandlerResolver(jakarta.xml.ws.handler.HandlerResolver handlerresolver)
     
    static void
    setPortMetadata(org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite composite)
    NON-STANDARD SPI!
    static void
    setServiceMetadata(org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite composite)
    NON-STANDARD SPI!

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ServiceDelegate

      public ServiceDelegate(URL url, QName qname, Class clazz, jakarta.xml.ws.WebServiceFeature... features) throws jakarta.xml.ws.WebServiceException
      Throws:
      jakarta.xml.ws.WebServiceException

  • Method Details

    • setServiceMetadata

      public static void setServiceMetadata(org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite composite)
      NON-STANDARD SPI! Set any metadata to be used on the creation of the NEXT Service by this thread. NOTE that this uses ThreadLocal to store the metadata, and that ThreadLocal is cleared after it is used to create a Service. That means: 1) The thread that sets the metadata to use MUST be the thread that creates the Service 2) Creation of the Service should be the very next thing the thread does 3) The metadata will be set to null when the Service is created, so to create another service with the same metadata, it will need to be set again prior to creating the service 4) The metadata can be set prior to creating both generic Service and generated Service instances. This allows creating a generic Service (jakarta.xml.ws.Service) or a generated Service (subclass of jakarta.xml.ws.Service) specifying additional metadata via a sparse composite. This can be used by a runtime to create a Service for a requester using additional metadata such as might come from a deployment descriptor or from resource injection processing of @Resource or @WebServiceRef(s) annotations. Additional metadata may include things like @WebServiceClient.wsdlLocation or a @HandlerChain specification.
      Parameters:
      composite - Additional metadata (if any) to be used in creation of the service
      See Also:
      • Service.create(QName)
      • Service.create(URL, QName)

    • setPortMetadata

      public static void setPortMetadata(org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite composite)
      NON-STANDARD SPI! Set any metadata to be used on the creation of the NEXT Port by this thread. NOTE that this uses ThreadLocal to store the metadata, and that ThreadLocal is cleared after it is used to create a Port. That means: 1) The thread that sets the metadata to use MUST be the thread that creates the Port 2) Creation of the Port should be the very next thing the thread does 3) The metadata will be set to null when the Port is created, so to create another Port with the same metadata, it will need to be set again prior to creating the Port 4) The metadata can be set prior to creating Port which specifies a QName via Service.getPort(QName, Class) or one that only specifies the SEI class via Service.getPort(Class) 5) Metadata can not be specified for dynamic ports, i.e. those added via Service.addPort(...). 6) Metadata can not be specfied when creating a dispatch client, i.e. via Service.createDispatch(...) 7) The Service used to create the port can be the generic service or a generated service. This allows creating Port specifying additional metadata via a sparse composite. This can be used by a runtime to create a Port for a requester using additional metadata such as might come from a deployment descriptor or from resource injection processing. Additional metadata might include things like a @HandlerChain specification.
      Parameters:
      composite - Additional metadata (if any) to be used in creation of the port
      See Also:
      • Service.getPort(Class)
      • Service.getPort(QName, Class)

    • addPort

      public void addPort(QName portName, String bindingId, String endpointAddress) throws jakarta.xml.ws.WebServiceException
      Specified by:
      addPort in class jakarta.xml.ws.spi.ServiceDelegate
      Throws:
      jakarta.xml.ws.WebServiceException

    • createDispatch

      public <T> jakarta.xml.ws.Dispatch<T> createDispatch(QName portName, Class<T> type, jakarta.xml.ws.Service.Mode mode) throws jakarta.xml.ws.WebServiceException
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate
      Throws:
      jakarta.xml.ws.WebServiceException

    • createDispatch

      public jakarta.xml.ws.Dispatch<Object> createDispatch(QName portName, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode)
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate

    • createDispatch

      public <T> jakarta.xml.ws.Dispatch<T> createDispatch(jakarta.xml.ws.EndpointReference jaxwsEPR, Class<T> type, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate

    • createDispatch

      public jakarta.xml.ws.Dispatch<Object> createDispatch(jakarta.xml.ws.EndpointReference jaxwsEPR, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate

    • createDispatch

      public <T> jakarta.xml.ws.Dispatch<T> createDispatch(QName portName, Class<T> type, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate

    • createDispatch

      public jakarta.xml.ws.Dispatch<Object> createDispatch(QName portName, jakarta.xml.bind.JAXBContext context, jakarta.xml.ws.Service.Mode mode, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      createDispatch in class jakarta.xml.ws.spi.ServiceDelegate

    • getPort

      public <T> T getPort(Class<T> sei) throws jakarta.xml.ws.WebServiceException
      Specified by:
      getPort in class jakarta.xml.ws.spi.ServiceDelegate
      Throws:
      jakarta.xml.ws.WebServiceException

    • getPort

      public <T> T getPort(QName portName, Class<T> sei) throws jakarta.xml.ws.WebServiceException
      Specified by:
      getPort in class jakarta.xml.ws.spi.ServiceDelegate
      Throws:
      jakarta.xml.ws.WebServiceException

    • getPort

      public <T> T getPort(Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      getPort in class jakarta.xml.ws.spi.ServiceDelegate

    • getPort

      public <T> T getPort(jakarta.xml.ws.EndpointReference jaxwsEPR, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      getPort in class jakarta.xml.ws.spi.ServiceDelegate

    • getPort

      public <T> T getPort(QName portName, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)
      Specified by:
      getPort in class jakarta.xml.ws.spi.ServiceDelegate

    • getExecutor

      public Executor getExecutor()
      Specified by:
      getExecutor in class jakarta.xml.ws.spi.ServiceDelegate

    • getHandlerResolver

      public jakarta.xml.ws.handler.HandlerResolver getHandlerResolver()
      Specified by:
      getHandlerResolver in class jakarta.xml.ws.spi.ServiceDelegate

    • getPorts

      public Iterator<QName> getPorts()
      Specified by:
      getPorts in class jakarta.xml.ws.spi.ServiceDelegate

    • getServiceName

      public QName getServiceName()
      Specified by:
      getServiceName in class jakarta.xml.ws.spi.ServiceDelegate

    • getWSDLDocumentLocation

      public URL getWSDLDocumentLocation()
      Specified by:
      getWSDLDocumentLocation in class jakarta.xml.ws.spi.ServiceDelegate

    • setExecutor

      public void setExecutor(Executor e)
      Specified by:
      setExecutor in class jakarta.xml.ws.spi.ServiceDelegate

    • setHandlerResolver

      public void setHandlerResolver(jakarta.xml.ws.handler.HandlerResolver handlerresolver)
      Specified by:
      setHandlerResolver in class jakarta.xml.ws.spi.ServiceDelegate

    • getServiceDescription

      public org.apache.axis2.jaxws.description.ServiceDescription getServiceDescription()
      Get the ServiceDescription tree that this ServiceDelegate

    • getServiceClient

      public org.apache.axis2.client.ServiceClient getServiceClient(QName portQName) throws jakarta.xml.ws.WebServiceException
      Throws:
      jakarta.xml.ws.WebServiceException

    • getPort

      public <T> T getPort(org.apache.axis2.addressing.EndpointReference axis2EPR, String addressingNamespace, Class<T> sei, jakarta.xml.ws.WebServiceFeature... features)

    • releaseService

      public static void releaseService(jakarta.xml.ws.Service service)
      PROPRIETARY METHOD TO RELEASE RESOUCES. USE OF THIS METHOD IS NOT JAX-WS COMPLIANT AND IS NON-PORTABLE! This method can be called by client code to try to release resources associated with the Service instance parameter. These resources include the JAX-WS metadata objects (e.g. ServiceDescription, EndpointDescription) and the associated Axis2 objects (e.g. AxisService and realted objects). Note that these resources can be shared across multiple service delegates, and so they will not actually be released until the last service delegate using them is closed. Note that it is not necessary to call this method since the service delegate finalizer will also release the resources as appropriate. However, finalizers are not necessarily run in a timely fashion and the timing varies across JVMs. To predictibly release resources to prevent large memory requirements and/or OutOfMemory errors, this proprietary release method can be called.
      Parameters:
      service - Instance of the Service for which resources may be released.

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable