net.exogeni.orca.drivers

Interface IDriver

All Known Implementing Classes:

Driver

public interface IDriver

Base interface for all resource drivers

Method Summary

Modifier and Type	Method and Description
int	cleanup() Cleanup any relevant state.
int	dispatch(java.lang.String actionId, 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.
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.
void	setFactory(DriverFactory factory) Sets the factory used to create this driver

Method Detail

getId

DriverId getId()

Returns the unique driver identifier.

Returns:

DriverId

initialize

int initialize()
        throws java.lang.Exception

Initialize the driver

Returns:

int

Throws:

java.lang.Exception - in case of error

cleanup

int cleanup()
     throws java.lang.Exception

Cleanup any relevant state.

Returns:

int

Throws:

java.lang.Exception - in case of error

dispatch

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

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

Parameters:

actionId - action identifier

in - Properties list describing the request

out - Output properties list

Returns:

int

Throws:

java.lang.Exception - in case of error

dispatch2

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

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

Parameters:

actionId - action identifier

in - Properties list describing the request

out - Output properties list

Returns:

int

Throws:

java.lang.Exception - in case of error

isStateful

boolean isStateful()

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

Returns:

true or false

setFactory

void setFactory(DriverFactory factory)

Sets the factory used to create this driver

Parameters:

factory - factory