Interface WebServiceEngine

  • All Known Implementing Classes:
    WebServiceEngineImpl

    public interface WebServiceEngine
    This interface holds all behaviour associated with the web service engine. For instance, it gives a list of all registered endpoints, provide hooks to register listener interfaces for endpoints creation/deletion and so on...
    Author:
    Jerome Dochez, Bhakti Mehta
    • Method Detail

      • getEndpoints

        Iterator<Endpoint> getEndpoints()
        Returns:
        an iterator of all the registered active endpoints in the engine.
      • getEndpoint

        Endpoint getEndpoint​(String endpointSelector)
        Parameters:
        endpointSelector - the endpoint selector
        Returns:
        an Endpoint instance if the supplied selector is the endpoint's invocation selector. In case of HTTP based web services, the selector is the endpoint URL
      • addLifecycleListener

        void addLifecycleListener​(EndpointLifecycleListener listener)
        Register a new listener interface to receive notification of web service endpoint creation and deletion
        Parameters:
        listener - instance to register
      • removeLifecycleListener

        void removeLifecycleListener​(EndpointLifecycleListener listener)
        Unregister a listener interface
        Parameters:
        listener - to unregister.
      • addAuthListener

        void addAuthListener​(AuthenticationListener listener)
        Register a new listener interface to receive authentication notification.
        Parameters:
        listener - to add
      • removeAuthListener

        void removeAuthListener​(AuthenticationListener listener)
        Unregister a listener interface
        Parameters:
        listener - to remove
      • setGlobalMessageListener

        void setGlobalMessageListener​(GlobalMessageListener listener)
        Set the unique global listener interface to trace all web service requests or responses. Set to null if no tracing is needed
        Parameters:
        listener - to register
      • getGlobalMessageListener

        GlobalMessageListener getGlobalMessageListener()
        get the global listener interface or null if none is set.
        Returns:
        the global message listener