net.exogeni.orca.drivers

Class Driver

java.lang.Object

net.exogeni.orca.drivers.Driver

All Implemented Interfaces:

IDriver

public abstract class Driver
extends java.lang.Object
implements IDriver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Driver.EventLoggerWrapper
class	Driver.ThreadLocalEventLogger

Field Summary

Fields

Modifier and Type	Field and Description
protected DriverId	driverId Driver identifier.
protected Driver.ThreadLocalEventLogger	eventLogger Per thread event logger.
protected DriverFactory	factory Driver factory that created this driver.
protected org.apache.log4j.Logger	logger Logger.
protected java.util.Hashtable<java.lang.String,java.lang.Integer>	map Map of action name to action code.
protected ActionOverlapTool	overlap Tool for dealing with overlapping actions.

Constructor Summary

Constructors

Constructor and Description
Driver(DriverId driverId)

Method Summary

Modifier and Type	Method and Description
int	cleanup() Cleanup any relevant state.
int	dispatch(java.lang.String actionName, java.util.Properties in, java.util.Properties out) Main driver dispatch routine.
int	dispatch2(java.lang.String objectId, java.lang.String actionId, java.util.Properties in, java.util.Properties out) Main driver dispatch routine for objects.
protected abstract int	doDispatch(java.lang.String actionName, java.lang.Integer actionID, java.util.Properties in, java.util.Properties out) Performs the action dispatch operation.
protected void	finishDispatch(java.lang.String actionName, java.lang.Integer actionID, java.util.Properties in, java.util.Properties out, int code) Performs bookkeeping operations to complete a dispatch call.
protected abstract java.lang.String	getActionKey(java.lang.Integer action, java.util.Properties in) Returns the action key for the given operation.
java.lang.String	getDriverRoot()
EventLogger	getEventLogger()
DriverId	getId() Returns the unique driver identifier.
int	initialize() Initialize the driver
boolean	isStateful() If the driver maintains state between calls, this method should return true.
protected int	prepareDispatch(java.lang.Integer actionID, java.lang.String actionName, java.util.Properties in, java.util.Properties out) Performs validation and bookkeeping actions before dispatching a call.
protected abstract int	prepareEventLogger(java.lang.String actionName, java.lang.Integer actionID, java.util.Properties in) Prepares an event logger for the current operation.
protected void	setEventLogger(EventLogger el)
void	setFactory(DriverFactory factory) Sets the factory used to create this driver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

map

protected java.util.Hashtable<java.lang.String,java.lang.Integer> map

Map of action name to action code.

eventLogger

protected Driver.ThreadLocalEventLogger eventLogger

Per thread event logger.

driverId

protected DriverId driverId

Driver identifier.

factory

protected DriverFactory factory

Driver factory that created this driver.

logger

protected org.apache.log4j.Logger logger

Logger.

overlap

protected ActionOverlapTool overlap

Tool for dealing with overlapping actions.

Constructor Detail

Driver

public Driver(DriverId driverId)

Method Detail

initialize

public int initialize()
               throws java.lang.Exception

Description copied from interface: IDriver

Initialize the driver

Specified by:

initialize in interface IDriver

Returns:

int

Throws:

java.lang.Exception - in case of error

dispatch

public int dispatch(java.lang.String actionName,
                    java.util.Properties in,
                    java.util.Properties out)
             throws java.lang.Exception

Description copied from interface: IDriver

Main driver dispatch routine. This function is the main entry point in the driver.

Specified by:

dispatch in interface IDriver

Parameters:

actionName - action identifier

in - Properties list describing the request

out - Output properties list

Returns:

int

Throws:

java.lang.Exception - in case of error

dispatch2

public int dispatch2(java.lang.String objectId,
                     java.lang.String actionId,
                     java.util.Properties in,
                     java.util.Properties out)
              throws java.lang.Exception

Description copied from interface: IDriver

Main driver dispatch routine for objects. This function is the main entry point in the driver.

Specified by:

dispatch2 in interface IDriver

actionId - action identifier

in - Properties list describing the request

out - Output properties list

Returns:

int

Throws:

java.lang.Exception - in case of error

doDispatch

protected abstract int doDispatch(java.lang.String actionName,
                                  java.lang.Integer actionID,
                                  java.util.Properties in,
                                  java.util.Properties out)

Performs the action dispatch operation.

Parameters:

actionName - action name

actionID - action identifier

in - incoming properties list

out - outgoing properties list

Returns:

0 on success, negative number if an error occurs

prepareEventLogger

protected abstract int prepareEventLogger(java.lang.String actionName,
                                          java.lang.Integer actionID,
                                          java.util.Properties in)

Prepares an event logger for the current operation.

Parameters:

actionName - action name

actionID - action identifier

in - incoming properties list

Returns:

0 on success, negative number if an error occurs

getActionKey

protected abstract java.lang.String getActionKey(java.lang.Integer action,
                                                 java.util.Properties in)

Returns the action key for the given operation.

Parameters:

action - action

in - in

Returns:

action key

prepareDispatch

protected int prepareDispatch(java.lang.Integer actionID,
                              java.lang.String actionName,
                              java.util.Properties in,
                              java.util.Properties out)

Performs validation and bookkeeping actions before dispatching a call.

Parameters:

actionID - action identifier

actionName - action name

in - incoming properties list

out - outgoing properties list

Returns:

0 - success, negative number - error

finishDispatch

protected void finishDispatch(java.lang.String actionName,
                              java.lang.Integer actionID,
                              java.util.Properties in,
                              java.util.Properties out,
                              int code)

Performs bookkeeping operations to complete a dispatch call.

Parameters:

actionName - action name

actionID - action identifier

in - incoming properties list

out - outgoing properties list

code - result of the dispatch call.

setEventLogger

protected void setEventLogger(EventLogger el)

getEventLogger

public EventLogger getEventLogger()

cleanup

public int cleanup()
            throws java.lang.Exception

Description copied from interface: IDriver

Cleanup any relevant state.

Specified by:

cleanup in interface IDriver

Returns:

int

Throws:

java.lang.Exception - in case of error

isStateful

public boolean isStateful()

Description copied from interface: IDriver

If the driver maintains state between calls, this method should return true.

Specified by:

isStateful in interface IDriver

Returns:

true or false

setFactory

public void setFactory(DriverFactory factory)

Description copied from interface: IDriver

Sets the factory used to create this driver

Specified by:

setFactory in interface IDriver

Parameters:

factory - factory

getDriverRoot

public java.lang.String getDriverRoot()

getId

public DriverId getId()

Description copied from interface: IDriver

Returns the unique driver identifier.

Specified by:

getId in interface IDriver

Returns:

DriverId