com.rhi.architecture.parc
Interface Process

All Known Implementing Classes:

PipelineProcess, ProcessSet

public interface Process

The Process Abstraction is the container or implementor of application logic. It's principle reason for being is to allow multiple processes to run w/in the same application.

Since:

1.0

Author:

Pete McKinstry

Field Summary

static java.lang.String	NAME the last part of the key used to find the name of the process in the config data.
static java.lang.String	SEPARATOR separator used in configuration properties between a process key & the name/type of the process.
static java.lang.String	TYPE the last part of the key used to find the type (class name) of the process in the config data.

Method Summary

void	cleanup() Perform any cleanup required.
java.lang.String	getName() getName returns the configured name for this process.
void	init(java.util.Properties p) Init method will be called prior to run to allow the strategy to initialize itself & acquire any necessary resources.
void	run() The run method provides the strategy implementation It should run the pipeline using whatever strategy it provides.
void	setName(java.lang.String name) setName is called by the framework to provide the correct process name.

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

separator used in configuration properties between a process key & the name/type of the process.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

the last part of the key used to find the name of the process in the config data.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

the last part of the key used to find the type (class name) of the process in the config data.

See Also:

Constant Field Values

Method Detail

init

public void init(java.util.Properties p)
          throws InitializationException

Init method will be called prior to run to allow the strategy to initialize itself & acquire any necessary resources.

Parameters:

p -

Throws:

InitializationException

Since:

1.0

run

public void run()
         throws ProcessingException

The run method provides the strategy implementation It should run the pipeline using whatever strategy it provides.

Throws:

ProcessingException

Since:

1.0

cleanup

public void cleanup()

Perform any cleanup required. This allows the Process to keep resources open after the run() method in case a multi-call strategy is used to execute run() repeatedly.

Since:

1.0

getName

public java.lang.String getName()

getName returns the configured name for this process. This method must return a unique identifier for each process running w/in the same BatchApplication. It is used to identify properties that are specific to a given Process.

Returns:

String

Since:

1.0

setName

public void setName(java.lang.String name)

setName is called by the framework to provide the correct process name.

Parameters:

name -

Since:

1.0