Package org.apache.ofbiz.service

Interface LocalDispatcher

All Known Implementing Classes:

GenericAbstractDispatcher

public interface LocalDispatcher

A local service dispatcher. This is the main API for the service engine.

Instances of LocalDispatcher are based on a Delegator instance and an entity model reader name. You can get a LocalDispatcher instance by calling the ServiceDispatcher.getLocalDispatcher(String, Delegator) factory method.

Method Summary

Modifier and Type	Method	Description
void	addCommitService(java.lang.String serviceName, boolean persist, java.lang.Object... context)
void	addCommitService(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, boolean persist)	Adds a commit service to the current TX using ServiceSynchronization
void	addRollbackService(java.lang.String serviceName, boolean persist, java.lang.Object... context)
void	addRollbackService(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, boolean persist)	Adds a rollback service to the current TX using ServiceSynchronization
void	deregister()	De-Registers this LocalDispatcher
void	disableEcas()	Disables running of Service Engine Condition Actions (SECAs).
void	enableEcas()	Reenables running of Service Engine Condition Actions (SECAs).
Delegator	getDelegator()	Gets the GenericEntityDelegator associated with this dispatcher
DispatchContext	getDispatchContext()	Returns the DispatchContext created by this dispatcher
JmsListenerFactory	getJMSListeneFactory()	Gets the JmsListenerFactory which holds the message listeners.
JobManager	getJobManager()	Gets the JobManager associated with this dispatcher
java.lang.String	getName()	Returns the Name of this local dispatcher
Security	getSecurity()	Gets the Security object associated with this dispatcher
boolean	isEcasDisabled()	Returns whether Service Engine Condition Actions (SECAs) are disabled or not.
void	registerCallback(java.lang.String serviceName, GenericServiceCallback cb)	Register a callback listener on a specific service.
void	runAsync(java.lang.String serviceName, boolean persist, java.lang.Object... context)
void	runAsync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context)	Run the service asynchronously and IGNORE the result.
void	runAsync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, boolean persist)	Run the service asynchronously and IGNORE the result.
void	runAsync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, GenericRequester requester)	Run the service asynchronously, passing an instance of GenericRequester that will receive the result.
void	runAsync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, GenericRequester requester, boolean persist)	Run the service asynchronously, passing an instance of GenericRequester that will receive the result.
void	runAsync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, GenericRequester requester, boolean persist, int transactionTimeout, boolean requireNewTransaction)	Run the service asynchronously, passing an instance of GenericRequester that will receive the result.
void	runAsync(java.lang.String serviceName, GenericRequester requester, boolean persist, int transactionTimeout, boolean requireNewTransaction, java.lang.Object... context)
void	runAsync(java.lang.String serviceName, GenericRequester requester, boolean persist, java.lang.Object... context)
void	runAsync(java.lang.String serviceName, GenericRequester requester, java.lang.Object... context)
GenericResultWaiter	runAsyncWait(java.lang.String serviceName, boolean persist, java.lang.Object... context)
GenericResultWaiter	runAsyncWait(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context)	Run the service asynchronously.
GenericResultWaiter	runAsyncWait(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, boolean persist)	Run the service asynchronously.
java.util.Map<java.lang.String,java.lang.Object>	runSync(java.lang.String serviceName, int transactionTimeout, boolean requireNewTransaction, java.lang.Object... context)
java.util.Map<java.lang.String,java.lang.Object>	runSync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context)	Run the service synchronously and return the result.
java.util.Map<java.lang.String,java.lang.Object>	runSync(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, int transactionTimeout, boolean requireNewTransaction)	Run the service synchronously with a specified timeout and return the result.
void	runSyncIgnore(java.lang.String serviceName, int transactionTimeout, boolean requireNewTransaction, java.lang.Object... context)
void	runSyncIgnore(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context)	Run the service synchronously and IGNORE the result.
void	runSyncIgnore(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, int transactionTimeout, boolean requireNewTransaction)	Run the service synchronously with a specified timeout and IGNORE the result.
void	schedule(java.lang.String serviceName, long startTime, int frequency, int interval, int count, long endTime, java.lang.Object... context)
void	schedule(java.lang.String serviceName, long startTime, int frequency, int interval, int count, java.lang.Object... context)
void	schedule(java.lang.String serviceName, long startTime, int frequency, int interval, long endTime, java.lang.Object... context)
void	schedule(java.lang.String serviceName, long startTime, java.lang.Object... context)
void	schedule(java.lang.String poolName, java.lang.String serviceName, long startTime, int frequency, int interval, int count, long endTime, int maxRetry, java.lang.Object... context)
void	schedule(java.lang.String jobName, java.lang.String poolName, java.lang.String serviceName, long startTime, int frequency, int interval, int count, long endTime, int maxRetry, java.lang.Object... context)
void	schedule(java.lang.String jobName, java.lang.String poolName, java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime, int frequency, int interval, int count, long endTime, int maxRetry)	Schedule a service to run asynchronously at a specific start time.
void	schedule(java.lang.String poolName, java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime, int frequency, int interval, int count, long endTime, int maxRetry)	Schedule a service to run asynchronously at a specific start time.
void	schedule(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime)	Schedule a service to run asynchronously at a specific start time.
void	schedule(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime, int frequency, int interval, int count)	Schedule a service to run asynchronously at a specific start time.
void	schedule(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime, int frequency, int interval, int count, long endTime)	Schedule a service to run asynchronously at a specific start time.
void	schedule(java.lang.String serviceName, java.util.Map<java.lang.String,? extends java.lang.Object> context, long startTime, int frequency, int interval, long endTime)	Schedule a service to run asynchronously at a specific start time.

Method Detail

disableEcas

void disableEcas()

Disables running of Service Engine Condition Actions (SECAs). Intended to be turned off temporarily.

enableEcas

void enableEcas()

Reenables running of Service Engine Condition Actions (SECAs).

isEcasDisabled

boolean isEcasDisabled()

Returns whether Service Engine Condition Actions (SECAs) are disabled or not.

Returns:

returns whether Service Engine Condition Actions (SECAs) are disabled or not.

runSync

java.util.Map<java.lang.String,java.lang.Object> runSync(java.lang.String serviceName,
                                                               java.util.Map<java.lang.String,? extends java.lang.Object> context)
                                                        throws GenericServiceException

Run the service synchronously and return the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

Returns:

Map of name, value pairs composing the result.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runSync

java.util.Map<java.lang.String,java.lang.Object> runSync(java.lang.String serviceName,
                                                               java.util.Map<java.lang.String,? extends java.lang.Object> context,
                                                               int transactionTimeout,
                                                               boolean requireNewTransaction)
                                                        throws ServiceAuthException,
                                                               ServiceValidationException,
                                                               GenericServiceException

Run the service synchronously with a specified timeout and return the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

transactionTimeout - the overriding timeout for the transaction (if we started it).

requireNewTransaction - if true we will suspend and create a new transaction so we are sure to start.

Returns:

Map of name, value pairs composing the result.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runSync

java.util.Map<java.lang.String,java.lang.Object> runSync(java.lang.String serviceName,
                                                               int transactionTimeout,
                                                               boolean requireNewTransaction,
                                                               java.lang.Object... context)
                                                        throws ServiceAuthException,
                                                               ServiceValidationException,
                                                               GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runSyncIgnore

void runSyncIgnore(java.lang.String serviceName,
                   java.util.Map<java.lang.String,? extends java.lang.Object> context)
            throws GenericServiceException

Run the service synchronously and IGNORE the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runSyncIgnore

void runSyncIgnore(java.lang.String serviceName,
                   java.util.Map<java.lang.String,? extends java.lang.Object> context,
                   int transactionTimeout,
                   boolean requireNewTransaction)
            throws ServiceAuthException,
                   ServiceValidationException,
                   GenericServiceException

Run the service synchronously with a specified timeout and IGNORE the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

transactionTimeout - the overriding timeout for the transaction (if we started it).

requireNewTransaction - if true we will suspend and create a new transaction so we are sure to start.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runSyncIgnore

void runSyncIgnore(java.lang.String serviceName,
                   int transactionTimeout,
                   boolean requireNewTransaction,
                   java.lang.Object... context)
            throws ServiceAuthException,
                   ServiceValidationException,
                   GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              GenericRequester requester,
              boolean persist,
              int transactionTimeout,
              boolean requireNewTransaction)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Run the service asynchronously, passing an instance of GenericRequester that will receive the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

requester - Object implementing GenericRequester interface which will receive the result.

persist - True for store/run; False for run.

transactionTimeout - the overriding timeout for the transaction (if we started it).

requireNewTransaction - if true we will suspend and create a new transaction so we are sure to start.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              GenericRequester requester,
              boolean persist,
              int transactionTimeout,
              boolean requireNewTransaction,
              java.lang.Object... context)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              GenericRequester requester,
              boolean persist)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Run the service asynchronously, passing an instance of GenericRequester that will receive the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

requester - Object implementing GenericRequester interface which will receive the result.

persist - True for store/run; False for run.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              GenericRequester requester,
              boolean persist,
              java.lang.Object... context)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              GenericRequester requester)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Run the service asynchronously, passing an instance of GenericRequester that will receive the result. This method WILL persist the job.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

requester - Object implementing GenericRequester interface which will receive the result.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              GenericRequester requester,
              java.lang.Object... context)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              boolean persist)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Run the service asynchronously and IGNORE the result.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

persist - True for store/run; False for run.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              boolean persist,
              java.lang.Object... context)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsync

void runAsync(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context)
       throws ServiceAuthException,
              ServiceValidationException,
              GenericServiceException

Run the service asynchronously and IGNORE the result. This method WILL persist the job.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsyncWait

GenericResultWaiter runAsyncWait(java.lang.String serviceName,
                                 java.util.Map<java.lang.String,? extends java.lang.Object> context,
                                 boolean persist)
                          throws ServiceAuthException,
                                 ServiceValidationException,
                                 GenericServiceException

Run the service asynchronously.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

persist - True for store/run; False for run.

Returns:

A new GenericRequester object.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsyncWait

GenericResultWaiter runAsyncWait(java.lang.String serviceName,
                                 boolean persist,
                                 java.lang.Object... context)
                          throws ServiceAuthException,
                                 ServiceValidationException,
                                 GenericServiceException

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

runAsyncWait

GenericResultWaiter runAsyncWait(java.lang.String serviceName,
                                 java.util.Map<java.lang.String,? extends java.lang.Object> context)
                          throws ServiceAuthException,
                                 ServiceValidationException,
                                 GenericServiceException

Run the service asynchronously. This method WILL persist the job.

Parameters:

serviceName - Name of the service to run.

context - Map of name, value pairs composing the context.

Returns:

A new GenericRequester object.

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

registerCallback

void registerCallback(java.lang.String serviceName,
                      GenericServiceCallback cb)

Register a callback listener on a specific service.

Parameters:

serviceName - Name of the service to link callback to.

cb - The callback implementation.

schedule

void schedule(java.lang.String poolName,
              java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime,
              int maxRetry)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

poolName - Name of the service pool to send to.

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

frequency - The frequency of the recurrence (RecurrenceRule.DAILY, etc).

interval - The interval of the frequency recurrence.

count - The number of times to repeat.

endTime - The time in milliseconds the service should expire

maxRetry - The number of times we should retry on failure

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

schedule

void schedule(java.lang.String poolName,
              java.lang.String serviceName,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime,
              int maxRetry,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

schedule

void schedule(java.lang.String jobName,
              java.lang.String poolName,
              java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime,
              int maxRetry)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

jobName - Name of the job

poolName - Name of the service pool to send to.

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

frequency - The frequency of the recurrence (RecurrenceRule.DAILY, etc).

interval - The interval of the frequency recurrence.

count - The number of times to repeat.

endTime - The time in milliseconds the service should expire

maxRetry - The number of times we should retry on failure

Throws:

ServiceAuthException

ServiceValidationException

GenericServiceException

schedule

void schedule(java.lang.String jobName,
              java.lang.String poolName,
              java.lang.String serviceName,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime,
              int maxRetry,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

frequency - The frequency of the recurrence (RecurrenceRule.DAILY, etc).

interval - The interval of the frequency recurrence.

count - The number of times to repeat.

endTime - The time in milliseconds the service should expire

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              long startTime,
              int frequency,
              int interval,
              int count,
              long endTime,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime,
              int frequency,
              int interval,
              int count)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

frequency - The frequency of the recurrence (RecurrenceRule.DAILY, etc).

interval - The interval of the frequency recurrence.

count - The number of times to repeat.

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              long startTime,
              int frequency,
              int interval,
              int count,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime,
              int frequency,
              int interval,
              long endTime)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

frequency - The frequency of the recurrence (RecurrenceRule.DAILY, etc).

interval - The interval of the frequency recurrence.

endTime - The time in milliseconds the service should expire

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              long startTime,
              int frequency,
              int interval,
              long endTime,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              java.util.Map<java.lang.String,? extends java.lang.Object> context,
              long startTime)
       throws GenericServiceException

Schedule a service to run asynchronously at a specific start time.

Parameters:

serviceName - Name of the service to invoke.

context - The name/value pairs composing the context.

startTime - The time to run this service.

Throws:

GenericServiceException

schedule

void schedule(java.lang.String serviceName,
              long startTime,
              java.lang.Object... context)
       throws GenericServiceException

Throws:

GenericServiceException

addRollbackService

void addRollbackService(java.lang.String serviceName,
                        java.util.Map<java.lang.String,? extends java.lang.Object> context,
                        boolean persist)
                 throws GenericServiceException

Adds a rollback service to the current TX using ServiceSynchronization

Parameters:

serviceName -

context -

persist -

Throws:

GenericServiceException

addRollbackService

void addRollbackService(java.lang.String serviceName,
                        boolean persist,
                        java.lang.Object... context)
                 throws GenericServiceException

Throws:

GenericServiceException

addCommitService

void addCommitService(java.lang.String serviceName,
                      java.util.Map<java.lang.String,? extends java.lang.Object> context,
                      boolean persist)
               throws GenericServiceException

Adds a commit service to the current TX using ServiceSynchronization

Parameters:

serviceName -

context -

persist -

Throws:

GenericServiceException

addCommitService

void addCommitService(java.lang.String serviceName,
                      boolean persist,
                      java.lang.Object... context)
               throws GenericServiceException

Throws:

GenericServiceException

getJobManager

JobManager getJobManager()

Gets the JobManager associated with this dispatcher

Returns:

JobManager that is associated with this dispatcher

getJMSListeneFactory

JmsListenerFactory getJMSListeneFactory()

Gets the JmsListenerFactory which holds the message listeners.

Returns:

JmsListenerFactory

getDelegator

Delegator getDelegator()

Gets the GenericEntityDelegator associated with this dispatcher

Returns:

GenericEntityDelegator associated with this dispatcher

getSecurity

Security getSecurity()

Gets the Security object associated with this dispatcher

Returns:

Security object associated with this dispatcher

getName

java.lang.String getName()

Returns the Name of this local dispatcher

Returns:

String representing the name of this local dispatcher

getDispatchContext

DispatchContext getDispatchContext()

Returns the DispatchContext created by this dispatcher

Returns:

DispatchContext created by this dispatcher

deregister

void deregister()

De-Registers this LocalDispatcher