org.ofbiz.service.rmi
Interface RemoteDispatcher

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RemoteDispatcherImpl

public interface RemoteDispatcher
extends java.rmi.Remote

Generic Services Remote Dispatcher

Method Summary

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.
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, 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, 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, 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

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,
                                                                java.rmi.RemoteException

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:

GenericServiceException

java.rmi.RemoteException

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 GenericServiceException,
                                                                java.rmi.RemoteException

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:

GenericServiceException

java.rmi.RemoteException

runSyncIgnore

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

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:

GenericServiceException

java.rmi.RemoteException

runSyncIgnore

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

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:

GenericServiceException

java.rmi.RemoteException

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 GenericServiceException,
                     java.rmi.RemoteException

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:

GenericServiceException

java.rmi.RemoteException

runAsync

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

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:

GenericServiceException

java.rmi.RemoteException

runAsync

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

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:

GenericServiceException

java.rmi.RemoteException

runAsync

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

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:

GenericServiceException

java.rmi.RemoteException

runAsync

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

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:

GenericServiceException

java.rmi.RemoteException

runAsyncWait

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

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:

GenericServiceException

java.rmi.RemoteException

runAsyncWait

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

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:

GenericServiceException

java.rmi.RemoteException

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,
                     java.rmi.RemoteException

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

java.rmi.RemoteException

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,
                     java.rmi.RemoteException

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

java.rmi.RemoteException

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,
                     java.rmi.RemoteException

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

java.rmi.RemoteException

schedule

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

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

java.rmi.RemoteException