java.lang.Object
org.refcodes.jobbus.JobBusProxy<CTX,H>
- Type Parameters:
CTX
- The context type to use, can by any component, service or POJO.H
- The handle type used to reference a job.
- All Implemented Interfaces:
org.refcodes.component.FlushHandle<H>
,org.refcodes.component.HandleLookup<H,org.refcodes.command.Undoable<CTX,?,?>>
,org.refcodes.component.ProgressHandle<H>
,org.refcodes.component.ResetHandle<H>
,JobBus<CTX,H>
public class JobBusProxy<CTX,H> extends Object implements JobBus<CTX,H>
The
JobBusProxy
implements a JobBus
proxy: a JobBus
proxy can use a remote JobBus
whilst only delegating those operations
to the remote JobBus
which can be handled on the remote system. Any
operation requiring asynchronous Thread
operations is handled by the
JobBusProxy
. This is necessary for the synchronous operations as a)
waiting for an asynchronous operation to finish may result in a timeout
caused by the remoting framework and as b) invoking lambda operations on the
proxy will not be propagated to a remote JobBus
instance as
bidirectional remoting usually is not supported by a remoting framework.-
Constructor Summary
Constructors Constructor Description JobBusProxy(JobBus<CTX,H> aJobBus)
Instantiates a new job bus proxy impl.JobBusProxy(JobBus<CTX,H> aJobBus, ExecutorService aExecutorService)
Instantiates a new job bus proxy impl. -
Method Summary
Modifier and Type Method Description H
execute(org.refcodes.command.Undoable<CTX,?,?> aJob)
Executes the given job.<RET, E extends Exception>
voidexecute(org.refcodes.command.Undoable<CTX,RET,E> aJob, BiConsumer<RET,E> aResultConsumer)
Executes the given job and invokes the providesBiConsumer
lambda (closure) upon finished execution.<RET, E extends Exception>
voidexecute(org.refcodes.command.Undoable<CTX,RET,E> aJob, Consumer<RET> aResultConsumer)
Executes the given job and invokes the providedConsumer
lambda (closure) upon finished execution.void
flush(H aHandle)
<E extends Exception>
EgetException(H aHandle)
Returns the exception of the job in case it terminated with an error.float
getProgress(H aHandle)
<RET> RET
getResult(H aHandle)
Returns the result of the job as the result of executing the job.<JOB extends org.refcodes.command.Undoable<CTX, RET, ?>, RET>
RETgetResult(JOB aJob)
Executes the job and waits for the job's result or an exception.<JOB extends org.refcodes.command.Undoable<CTX, RET, ?>, RET>
RETgetResult(JOB aJob, long aTimeoutInMs)
Executes the job and waits for the job's result or an exception or till the timeout has been reached.boolean
hasException(H aHandle)
Determines whether the job identified by the given handle ended with an exception (instead of a regular result).boolean
hasFlush(H aHandle)
boolean
hasHandle(H aHandle)
boolean
hasProgress(H aHandle)
boolean
hasReset(H aHandle)
boolean
hasResult(H aHandle)
Determines whether the job identified by the given handle has a regular result (instead of an exception).boolean
isExecuted(H aHandle)
Determines whether the job has been executed.org.refcodes.command.Undoable<CTX,?,?>
lookupHandle(H aHandle)
org.refcodes.command.Undoable<CTX,?,?>
removeHandle(H aHandle)
void
reset(H aHandle)
void
waitForExecution(H aHandle)
Waits till the job identified by the given handle finished execution by regularly terminating or by throwing an exception.void
waitForExecution(H aHandle, long aTimeoutInMs)
Waits till the job identified by the given handle finished execution by regularly terminating or by throwing an exception or till the timeout has been reached.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.refcodes.component.FlushHandle
flushUnchecked
-
Constructor Details
-
JobBusProxy
Instantiates a new job bus proxy impl.- Parameters:
aJobBus
- the job bus
-
JobBusProxy
Instantiates a new job bus proxy impl.- Parameters:
aJobBus
- the job busaExecutorService
- the executor service
-
-
Method Details
-
hasHandle
-
hasProgress
- Specified by:
hasProgress
in interfaceorg.refcodes.component.ProgressHandle<CTX>
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
-
hasReset
- Specified by:
hasReset
in interfaceorg.refcodes.component.ResetHandle<CTX>
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
-
hasFlush
- Specified by:
hasFlush
in interfaceorg.refcodes.component.FlushHandle<CTX>
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
-
lookupHandle
-
removeHandle
-
reset
public void reset(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.component.UnsupportedHandleOperationRuntimeException- Specified by:
reset
in interfaceorg.refcodes.component.ResetHandle<CTX>
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
org.refcodes.component.UnsupportedHandleOperationRuntimeException
-
getProgress
public float getProgress(H aHandle) throws org.refcodes.component.UnsupportedHandleOperationRuntimeException, org.refcodes.component.UnknownHandleRuntimeException- Specified by:
getProgress
in interfaceorg.refcodes.component.ProgressHandle<CTX>
- Throws:
org.refcodes.component.UnsupportedHandleOperationRuntimeException
org.refcodes.component.UnknownHandleRuntimeException
-
flush
public void flush(H aHandle) throws IOException, org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.component.UnsupportedHandleOperationRuntimeException- Specified by:
flush
in interfaceorg.refcodes.component.FlushHandle<CTX>
- Throws:
IOException
org.refcodes.component.UnknownHandleRuntimeException
org.refcodes.component.UnsupportedHandleOperationRuntimeException
-
execute
Executes the given job. By double dispatch the job's execute method is invoked. The Job is provided with a service-bus to be able to perform its task. This is an implementation of the command pattern. -
isExecuted
Determines whether the job has been executed.- Specified by:
isExecuted
in interfaceJobBus<CTX,H>
- Parameters:
aHandle
- The handle associated to the job in question.- Returns:
- True if the job represented by the handle has been executed.
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.
-
hasResult
public boolean hasResult(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.command.NotYetExecutedRuntimeExceptionDetermines whether the job identified by the given handle has a regular result (instead of an exception). There may be jobs which do not have any result, i.e. check if the job has been executed and also check if there is a result or an exception before requesting the according information.- Specified by:
hasResult
in interfaceJobBus<CTX,H>
- Parameters:
aHandle
- The handle associated to the job in question.- Returns:
- The result of the job.
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.org.refcodes.command.NotYetExecutedRuntimeException
- in case the job has not been executed yet
-
hasException
public boolean hasException(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.command.NotYetExecutedRuntimeExceptionDetermines whether the job identified by the given handle ended with an exception (instead of a regular result). Most jobs do not have any exception, i.e. check if the job has been executed and also check if there is a result or an exception before requesting the according information.- Specified by:
hasException
in interfaceJobBus<CTX,H>
- Parameters:
aHandle
- The handle associated to the job in question.- Returns:
- The exception of the job's execution.
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.org.refcodes.command.NotYetExecutedRuntimeException
- in case the job has not been executed yet.
-
getResult
public <RET> RET getResult(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.command.NotYetExecutedRuntimeException, org.refcodes.command.NoResultAvailableRuntimeExceptionReturns the result of the job as the result of executing the job.- Specified by:
getResult
in interfaceJobBus<CTX,H>
- Type Parameters:
RET
- As of convenience, the return type of theUndoable
instance's proceedings. CAUTION: As the handle does not permit insight on theUndoable
(job) instance's return type, you may end up with a class cast exception in case you do not make sure that the result is of the expected typeRET
.- Parameters:
aHandle
- The handle associated to the job in question.- Returns:
- The result after executing the job.
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.org.refcodes.command.NotYetExecutedRuntimeException
- in case the job has not been executed yet.org.refcodes.command.NoResultAvailableRuntimeException
- in case the job did not provide a result after execution.
-
getException
public <E extends Exception> E getException(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.command.NotYetExecutedRuntimeException, org.refcodes.command.NoExceptionAvailableRuntimeExceptionReturns the exception of the job in case it terminated with an error.- Specified by:
getException
in interfaceJobBus<CTX,H>
- Type Parameters:
E
- the element type- Parameters:
aHandle
- The handle associated to the job in question.- Returns:
- The exception after executing the job.
- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.org.refcodes.command.NotYetExecutedRuntimeException
- in case the job has not been executed yet.org.refcodes.command.NoExceptionAvailableRuntimeException
- in case the job did not provide an exception after execution.
-
execute
public <RET, E extends Exception> void execute(org.refcodes.command.Undoable<CTX,RET,E> aJob, Consumer<RET> aResultConsumer)Description copied from interface:JobBus
Executes the given job and invokes the providedConsumer
lambda (closure) upon finished execution. The parameter is passed in case we have an ordinary result, an exceptual situation is "ignored" as theConsumer
will not be invoked in such a case. In case you have to take action upon an exceptional situation, then use theJobBus.execute(Undoable, BiConsumer)
method. -
execute
public <RET, E extends Exception> void execute(org.refcodes.command.Undoable<CTX,RET,E> aJob, BiConsumer<RET,E> aResultConsumer)Executes the given job and invokes the providesBiConsumer
lambda (closure) upon finished execution. The first parameter is passed in case we have an ordinary result, the second one is passed in case we have an exceptional situation. Either the one parameter or the other one is passed, never both of them at the same invocation! In case both arguments are null, then your job has returned null. Consider using theOptional
to be returned by your job. Though consider that theOptional
is NOT serializable which could cause problems with remote job execution! In case you do not have to take action upon an exceptional situation, then use theJobBus.execute(Undoable, Consumer)
method.- Specified by:
execute
in interfaceJobBus<CTX,H>
- Type Parameters:
RET
- the generic typeE
- the element type- Parameters:
aJob
- The job to be executed.aResultConsumer
- TheBiConsumer
lambda to be invoked upon finished execution.- See Also:
- "http://www.refcodes.org/blog/obliged_to_do_the_optional_or_is_it_optional"
-
waitForExecution
public void waitForExecution(H aHandle) throws org.refcodes.component.UnknownHandleRuntimeExceptionWaits till the job identified by the given handle finished execution by regularly terminating or by throwing an exception. The handle my be used to determine if there was an exception or not and to retrieve the result or in case of an exception the exception object.- Specified by:
waitForExecution
in interfaceJobBus<CTX,H>
- Parameters:
aHandle
- The handle associated with the provided job.- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- in case the handle is not unknown.
-
waitForExecution
public void waitForExecution(H aHandle, long aTimeoutInMs) throws org.refcodes.component.UnknownHandleRuntimeException, org.refcodes.component.HandleTimeoutRuntimeExceptionWaits till the job identified by the given handle finished execution by regularly terminating or by throwing an exception or till the timeout has been reached. In case the timeout has been reached before execution was finished, then aHandleTimeoutRuntimeException
is thrown to abort the waiting loop. This is especially useful when a remote connection is used to managed a distributedJobBus
infrastructure and due to connection issues, wait time would be endless. The handle my be used to determine if there was an exception or not and to retrieve the result or in case of an exception the exception object.- Specified by:
waitForExecution
in interfaceJobBus<CTX,H>
- Parameters:
aHandle
- The handle associated with the provided job.aTimeoutInMs
- The timeout to wait at most even when execution did not finish. In case the timeout has been reached before execution was finished, then aHandleTimeoutRuntimeException
is thrown to abort the waiting loop.- Throws:
org.refcodes.component.UnknownHandleRuntimeException
- Thrown in case the handle is not unknown.org.refcodes.component.HandleTimeoutRuntimeException
- Thrown in case the timeout was reached before execution finished.
-
getResult
public <JOB extends org.refcodes.command.Undoable<CTX, RET, ?>, RET> RET getResult(JOB aJob) throws org.refcodes.command.NoResultAvailableRuntimeExceptionExecutes the job and waits for the job's result or an exception.- Specified by:
getResult
in interfaceJobBus<CTX,H>
- Type Parameters:
JOB
- the generic typeRET
- The return type of theUndoable
's proceedings.- Parameters:
aJob
- The job to execute- Returns:
- The result of the job execution. In case the job does not produce a result by default ("void"), then the according exception is thrown. Make sure the job produces a result!
- Throws:
org.refcodes.command.NoResultAvailableRuntimeException
- in case a job has been executed which never delivers a result or which terminated with an exception. UseJobBus.hasException(Object)
andJobBus.hasResult(Object)
to clarify which state yourUndoable
(job) is in.
-
getResult
public <JOB extends org.refcodes.command.Undoable<CTX, RET, ?>, RET> RET getResult(JOB aJob, long aTimeoutInMs) throws org.refcodes.command.NoResultAvailableRuntimeException, org.refcodes.component.HandleTimeoutRuntimeExceptionExecutes the job and waits for the job's result or an exception or till the timeout has been reached. In case the timeout has been reached before execution was finished, then aHandleTimeoutRuntimeException
is thrown to abort the waiting loop. This is especially useful when a remote connection is used to managed a distributedJobBus
infrastructure and due to connection issues, wait time would be endless.- Specified by:
getResult
in interfaceJobBus<CTX,H>
- Type Parameters:
JOB
- the generic typeRET
- The return type of theUndoable
's proceedings.- Parameters:
aJob
- The job to executeaTimeoutInMs
- The timeout to wait at most even when execution did not finish. In case the timeout has been reached before execution was finished, then aHandleTimeoutRuntimeException
is thrown to abort the waiting loop.- Returns:
- The result of the job execution. In case the job does not produce a result by default ("void"), then the according exception is thrown. Make sure the job produces a result!
- Throws:
org.refcodes.command.NoResultAvailableRuntimeException
- in case a job has been executed which never delivers a result or which terminated with an exception. UseJobBus.hasException(Object)
andJobBus.hasResult(Object)
to clarify which state yourUndoable
(job) is in.org.refcodes.component.HandleTimeoutRuntimeException
- the handle timeout runtime exception
-