org.rvpf.processor.engine.executor

Interface EngineExecutor

All Superinterfaces:

Serializable

All Known Implementing Classes:

PipeExecutor, ScriptExecutor

public interface EngineExecutor
extends Serializable

Engine executor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this.
void	disposeContext(Serializable context) Disposes of a context.
List<PointValue>	execute(ResultValue resultValue, String[] params, Serializable context) Executes the processing of a request for a result value.
Serializable	newContext(Params params, Logger logger) Returns a new context.
boolean	setUp(String name, Params params, Config config, Logger logger) Sets up this engine executor.
void	tearDown() Tears down what has been set up.

Method Detail

close

void close()

Closes this.

disposeContext

void disposeContext(@Nonnull
                    Serializable context)

Disposes of a context.

Parameters:

context - The context.

execute

@Nullable
 @CheckReturnValue
List<PointValue> execute(@Nonnull
                                                        ResultValue resultValue,
                                                        @Nonnull
                                                        String[] params,
                                                        @Nonnull
                                                        Serializable context)
                                                 throws InterruptedException,
                                                        ServiceNotAvailableException

Executes the processing of a request for a result value.

Parameters:

resultValue - The requested result.

params - Result parameters.

context - The context.

Returns:

A List of point values (null on failure).

Throws:

InterruptedException - When interrupted.

ServiceNotAvailableException - When the service is not available.

newContext

@Nullable
 @CheckReturnValue
Serializable newContext(@Nonnull
                                                       Params params,
                                                       @Nonnull
                                                       Logger logger)

Returns a new context.

Parameters:

params - The caller's parameters.

logger - The caller's logger.

Returns:

The new context (null on failure).

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 String name,
                                 @Nonnull
                                 Params params,
                                 @Nonnull
                                 Config config,
                                 @Nonnull
                                 Logger logger)

Sets up this engine executor.

Parameters:

name - The caller's name.

params - The caller's parameters.

config - The configuration.

logger - The caller's logger.

Returns:

True on success.

tearDown

void tearDown()

Tears down what has been set up.