Package org.apache.ofbiz.service

Class ServiceDispatcher

  • public class ServiceDispatcher
extends java.lang.Object
    The global service dispatcher. This is the "engine" part of the Service Engine.

    • Constructor Detail

      • ServiceDispatcher

        protected ServiceDispatcher​(Delegator delegator,
                            boolean enableJM,
                            boolean enableJMS)

      • ServiceDispatcher

        protected ServiceDispatcher​(Delegator delegator)

    • Method Detail

      • getLocalDispatcher

        public static LocalDispatcher getLocalDispatcher​(java.lang.String name,
                                                 Delegator delegator)
        Returns a pre-registered instance of the ServiceDispatcher associated with this delegator.
        Parameters:
        name - the name of the DispatchContext
        delegator - the local delegator
        Returns:
        A reference to the LocalDispatcher associated with the DispatchContext

      • getInstance

        public static ServiceDispatcher getInstance​(Delegator delegator)
        Returns an instance of the ServiceDispatcher associated with this delegator.
        Parameters:
        delegator - the local delegator
        Returns:
        A reference to this global ServiceDispatcher

      • register

        public void register​(DispatchContext context)
        Registers the loader with this ServiceDispatcher
        Parameters:
        context - the context of the local dispatcher

      • deregister

        public void deregister​(LocalDispatcher local)
        De-Registers the loader with this ServiceDispatcher
        Parameters:
        local - the LocalDispatcher to de-register

      • registerCallback

        public void registerCallback​(java.lang.String serviceName,
                             GenericServiceCallback cb)
        Registers a callback by associating it to a service.
        Parameters:
        serviceName - the name of the service to associate the callback with
        cb - the callback to register

      • getCallbacks

        public java.util.List<GenericServiceCallback> getCallbacks​(java.lang.String serviceName)
        Provides a list of the enabled callbacks corresponding to a service. As a side effect, disabled callbacks are removed.
        Parameters:
        serviceName - the name of service whose callbacks should be called
        Returns:
        a list of callbacks corresponding to serviceName

      • getGenericEngine

        public GenericEngine getGenericEngine​(java.lang.String engineName)
                               throws GenericServiceException
        Gets the GenericEngine instance that corresponds to the given name
        Parameters:
        engineName - Name of the engine
        Returns:
        GenericEngine instance that corresponds to the engineName
        Throws:
        GenericServiceException

      • getJobManager

        public JobManager getJobManager()
        Gets the JobManager associated with this dispatcher
        Returns:
        JobManager that is associated with this dispatcher

      • getJMSListenerFactory

        public JmsListenerFactory getJMSListenerFactory()
        Gets the JmsListenerFactory which holds the message listeners.
        Returns:
        JmsListenerFactory

      • getDelegator

        public Delegator getDelegator()
        Gets the Delegator associated with this dispatcher
        Returns:
        Delegator associated with this dispatcher

      • getSecurity

        public Security getSecurity()
        Gets the Security object associated with this dispatcher
        Returns:
        Security object associated with this dispatcher

      • getLocalContext

        public DispatchContext getLocalContext​(java.lang.String name)
        Gets the local context from a name
        Parameters:
        name - of the context to find.

      • getLocalDispatcher

        public LocalDispatcher getLocalDispatcher​(java.lang.String name)
        Gets the local dispatcher from a name
        Parameters:
        name - of the LocalDispatcher to find.
        Returns:
        LocalDispatcher matching the loader name

      • containsContext

        public boolean containsContext​(java.lang.String name)
        Test if this dispatcher instance contains the local context.
        Parameters:
        name - of the local context
        Returns:
        true if the local context is found in this dispatcher.

      • enableJM

        public static void enableJM​(boolean enable)
        Enables/Disables the Job Manager/Scheduler globally (this will not effect any dispatchers already running)
        Parameters:
        enable -

      • enableJMS

        public static void enableJMS​(boolean enable)
        Enables/Disables the JMS listeners globally (this will not effect any dispatchers already running)
        Parameters:
        enable -

      • enableSvcs

        public static void enableSvcs​(boolean enable)
        Enables/Disables the startup services globally (this will not effect any dispatchers already running)
        Parameters:
        enable -