Package dev.getelements.elements.rt

Interface HandlerContext

All Known Implementing Classes:

SimpleHandlerContext

public interface HandlerContext

Used to manage handler-type Resource instances. These are intended to be short-lived and managed entirely on the server side. Unlike using the bare ResourceContext the methods in this interface will automatically guaranteed the lifecycle of the remote Resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HANDLER_TIMEOUT_MSEC	The timeout for the HandlerContext in milliseconds.

Method Summary

Modifier and Type	Method	Description
default Object	invokeRetainedHandler(Attributes attributes, String module, String method, Object... args)	Synchronously invokes invokeRetainedHandlerAsync(Consumer, Consumer, Attributes, String, String, Object...) blocking until the call returns.
void	invokeRetainedHandlerAsync(Consumer<Object> success, Consumer<Throwable> failure, Attributes attributes, String module, String method, Object... args)	Creates a Resource, invokes a method on that Resource, and returns the result as either a success or a failure.
default Object	invokeSingleUseHandler(Attributes attributes, String module, String method, Object... args)	Synchronously invokes invokeSingleUseHandlerAsync(Consumer, Consumer, Attributes, String, String, Object...) blocking until the call returns.
void	invokeSingleUseHandlerAsync(Consumer<Object> success, Consumer<Throwable> failure, Attributes attributes, String module, String method, Object... args)	Creates a Resource, invokes a method on that Resource, and returns the result as either a success or a failure.
default void	start()	Starts this HandlerContext.
default void	stop()	Stops this HandlerContext.

Field Details

HANDLER_TIMEOUT_MSEC

static final String HANDLER_TIMEOUT_MSEC

The timeout for the HandlerContext in milliseconds.

See Also:

• Constant Field Values

Method Details

start

default void start()

Starts this HandlerContext.

stop

default void stop()

Stops this HandlerContext.

invokeSingleUseHandler

default Object invokeSingleUseHandler(Attributes attributes,
 String module,
 String method,
 Object... args)

Synchronously invokes invokeSingleUseHandlerAsync(Consumer, Consumer, Attributes, String, String, Object...) blocking until the call returns.

Parameters:

attributes - the Attributes supplied to the underlying Resource

module - the module name used to instantiate the resource

method - the method to invoke

args - the arguments passed to the method

Returns:

the invocation result

invokeSingleUseHandlerAsync

void invokeSingleUseHandlerAsync(Consumer<Object> success,
 Consumer<Throwable> failure,
 Attributes attributes,
 String module,
 String method,
 Object... args)

Creates a Resource, invokes a method on that Resource, and returns the result as either a success or a failure. The HandlerContext will assign a temporary Path, and ResourceId which will not be exposed to the client code. Further, this will guaranteed the destruction of the created Resource even if the client abandons the call this method. The underlying HandlerContext may time out the Resource. In which case the caller will receive an instance fo HandlerTimeoutException through the returned Future or in the Consumer<Throwable> handed to the method.

Parameters:

success - invoked when the invocation successfully returns

failure - invoked whent he invocation encounters an error

attributes - the Attributes supplied to the underlying Resource

module - the module name used to instantiate the resource

method - the method to invoke

args - the arguments passed to the method

invokeRetainedHandler

default Object invokeRetainedHandler(Attributes attributes,
 String module,
 String method,
 Object... args)

Synchronously invokes invokeRetainedHandlerAsync(Consumer, Consumer, Attributes, String, String, Object...) blocking until the call returns.

Parameters:

attributes - the Attributes supplied to the underlying Resource

module - the module name used to instantiate the resource

method - the method to invoke

args - the arguments passed to the method

Returns:

the invocation result

invokeRetainedHandlerAsync

void invokeRetainedHandlerAsync(Consumer<Object> success,
 Consumer<Throwable> failure,
 Attributes attributes,
 String module,
 String method,
 Object... args)

Creates a Resource, invokes a method on that Resource, and returns the result as either a success or a failure. The HandlerContext will assign a temporary Path, and ResourceId which will not be exposed to the client code. Unlike invokeSingleUseHandlerAsync(Consumer, Consumer, Attributes, String, String, Object...) this will just unlink the Resource after it invokes the specified method. It will be responsiblity of the invoked method to provide further retentions should it be desired. The underlying HandlerContext may time out the Resource. In which case the caller will receive an instance fo HandlerTimeoutException through the returned Future or in the Consumer<Throwable> handed to the method.

Parameters:

success - invoked when the invocation successfully returns

failure - invoked whent he invocation encounters an error

attributes - the Attributes supplied to the underlying Resource

module - the module name used to instantiate the resource

method - the method to invoke

args - the arguments passed to the method