A B C D E F G H I J L M O P R S T U X

A

AbstractPoolJobLoader - class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader.

AbstractPoolJobLoader implements all the management and monitoring methods and abstracts the user from the job pool.

AbstractPoolJobLoader() - Constructor for class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

AbstractPoolJobProcessor - class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor.

Abstract pool job processor implements some of the responsiblites defined by the pool job processor and leaves the application specific functionality implementation to the final processor.

AbstractPoolJobProcessor() - Constructor for class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

addLogger(String, String) - Method in class org.jmonks.batch.framework.config.JobLoggingConfig

appendMessage(String) - Method in class org.jmonks.batch.framework.ErrorCode

Creates a new ErrorCode object with the same error code and appends the given message to the existing message and returns new ErrorCode.

B

BASIC_JOB_PROCESSOR_EXCEPTION - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents error because of the exception in basic job processor.

BasicJobController - class org.jmonks.batch.framework.controller.basic.BasicJobController.

BasicJobController creates and executes the Basic Job Processor class defined in job configuration.

BasicJobController() - Constructor for class org.jmonks.batch.framework.controller.basic.BasicJobController

Constructor enables the instantiation of the basic job controller instance.

BasicJobControllerConfig - class org.jmonks.batch.framework.config.BasicJobControllerConfig.

BasicJobControllerConfig provides the configuration for the BasicJobController.

BasicJobControllerConfig() - Constructor for class org.jmonks.batch.framework.config.BasicJobControllerConfig

BasicJobProcessor - class org.jmonks.batch.framework.controller.basic.BasicJobProcessor.

BasicJobProcessor lets job developers to implement their business logic in the process method and this method will be executed by the BasicJobController.

BasicJobProcessor() - Constructor for class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

basicJobProcessorClassName - Variable in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Basic job processor class name.

basicJobProcessorConfigProps - Variable in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Map contains the properties required by the basic job processor.

basicJobProcessorThreadCount - Variable in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Holds the number of instances needs to be created.

C

CLEANUP - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates the processor is being cleaned up.

CONTEXT_PARAM_JOB_CONFIG - Static variable in class org.jmonks.batch.framework.JobContext

Constant defines the parameter name to be used in the context parameters map to pass the job configuration to create the job context.

CONTEXT_PARAM_JOB_INVOKE_CONFIG - Static variable in class org.jmonks.batch.framework.JobContext

Constant defines the parameter name to be used in the context parameters map to pass the job invoke configuration to create the job context.

CONTEXT_PARAM_REPOSITORY - Static variable in class org.jmonks.batch.framework.JobContext

Constant defines the parameter name to be used in the context parameters map to pass the repository instance to create the job context.

ClientServerDb4oRepository - class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository.

ClientServerDb4oRepository access the Db4o Server and use it as a repository.

ClientServerDb4oRepository() - Constructor for class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Enables the creation of the ClientServerDb4oRepository instance from the factory method.

CollectionJobPool - class org.jmonks.batch.framework.controller.pool.CollectionJobPool.

Provides the implementation of job pool using java utility collections.

CollectionJobPool() - Constructor for class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Default constructor for the instantiation purposes.

ConfigurationException - exception org.jmonks.batch.framework.config.ConfigurationException.

ConfigurationException defines the problems in either framework configuration or job configuration.

ConfigurationException(String, String) - Constructor for class org.jmonks.batch.framework.config.ConfigurationException

Constructs an instance of ConfigurationException with the specified component name and the message.

changeLogLevel(String, Level) - Method in class org.jmonks.batch.framework.JobController

Changes the log level for the requested logger name with the given log level.

changeLogLevel(String, Level) - Static method in class org.jmonks.batch.framework.LoggingManager

Changes the log level for the requested logger name with the given log level.

changeLogLevel(String, Level) - Method in class org.jmonks.batch.framework.management.JobManager

Changes the log level for the requested logger name with the given log level.

changeLogLevel(String, Level) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Changes the log level for the requested logger name with the given log level.

cleanup() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Chance to do any cleanup at the end of the processing.

cleanup() - Method in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Removes all the entries from collection.

cleanup() - Method in interface org.jmonks.batch.framework.controller.pool.JobPool

Controller calls this method after job processing has been done.

clearDataTransferredFromThisJob() - Method in class org.jmonks.batch.framework.Repository

This method will clear all the data that has been sent by this job to all the next jobs.

clearDataTransferredFromThisJob() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

clearDataTransferredFromThisJob() - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

closeConnection(Connection) - Static method in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Closes the given connection.

configProps - Variable in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Map holds the configuration defined for the job pool.

createConnectorServer() - Method in class org.jmonks.batch.framework.management.JobConnectorHelper

Creates the JMX connector server based on the desired connector protocol.

createConnectorServer() - Method in class org.jmonks.batch.framework.management.jmxmp.JMXMPConnectorHelper

Creates the JMX connector server based on JMX Messaging protocol.

createContainer(Map) - Method in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

createContainer(Map) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Creates the container by looking at the configuration from given Map.

createErrorCode(int, String) - Static method in class org.jmonks.batch.framework.ErrorCode

Creates a new error code instance by accepting the code and message.

createJobController(JobContext, Main) - Static method in class org.jmonks.batch.framework.JobController

This factory method creates required implementation of the controller based on the controller configuration available in job context and sets the job context to the controller.

createJobManagementAgent(JobContext, Main) - Static method in class org.jmonks.batch.framework.management.JobManagementAgent

Creates the agent and initializes with the job context and job connection helper.

createRepository(String, FrameworkConfig.RepositoryConfig, Main) - Static method in class org.jmonks.batch.framework.Repository

Factory method creates the repository instance based on the given repository configuration and associate this repository instance with the given job.

D

DB4O_REPOSITORY_FILENAME - Static variable in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Name of the DB4O repository file name which is batchserver_repository.db.

DBBasicJobControllerConfig - class org.jmonks.batch.framework.config.db.DBBasicJobControllerConfig.

DBBasicJobControllerConfig loads the job controller configuration from the defined database.

DBBasicJobControllerConfig(String, Connection) - Constructor for class org.jmonks.batch.framework.config.db.DBBasicJobControllerConfig

Loads the basic job controller configuration from table basic_job_controller_config into DBBasicJobControllerConfig object.

DBJobConfig - class org.jmonks.batch.framework.config.db.DBJobConfig.

DBJobConfig provides the implementation of JobConfig by reading the job configuration from given connection.

DBJobConfigFactory - class org.jmonks.batch.framework.config.db.DBJobConfigFactory.

DBJobConfigFactory reads the job configuration from defined database to create the configuration objects needed by the job.

DBJobConfigFactory() - Constructor for class org.jmonks.batch.framework.config.db.DBJobConfigFactory

Do not use this constructor to instantiate DBJobConfigFactory directly.

DBJobControllerConfig - class org.jmonks.batch.framework.config.db.DBJobControllerConfig.

DBJobControllerConfig responsible to build the controller specific JobControllerConfig objects from the given database.

DBJobControllerConfig() - Constructor for class org.jmonks.batch.framework.config.db.DBJobControllerConfig

DBJobLoggingConfig - class org.jmonks.batch.framework.config.db.DBJobLoggingConfig.

DBJobLoggingConfig reads the job logging configuration from the table job_logging_config.

DBJobLoggingConfig(String, Connection) - Constructor for class org.jmonks.batch.framework.config.db.DBJobLoggingConfig

Reads the configuration from the table job_logging_config and add each record as JobLoggerConfig object.

DBPoolJobControllerConfig - class org.jmonks.batch.framework.config.db.DBPoolJobControllerConfig.

DBPoolJobControllerConfig loads the job controller configuration from the defined database.

DBPoolJobControllerConfig(String, Connection) - Constructor for class org.jmonks.batch.framework.config.db.DBPoolJobControllerConfig

Loads the pool job controller configuration from table pool_job_controller_config into DBPoolJobControllerConfig object.

DEFAULT_COLLECTION_POOL_SIZE - Static variable in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Default collection pool size.

DEFAULT_MESSAGE_PATTERN - Static variable in class org.jmonks.batch.framework.LoggingManager

Standard pattern expression used for all the log files.

Db4oJobControllerHolder - class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolder.

Db4oJobControllerHolder holds the job controller object and job name.

Db4oJobControllerHolderPredicate - class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolderPredicate.

Db4oJobControllerHolderPredicate used to find the Db4oJobControllerHolder objects in Db4o database using native query.

Db4oJobDataTransferHolder - class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder.

Db4oJobDataTransferHolder holds the data being transferred between the jobs.

Db4oJobMgmtMntrInfoHolder - class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolder.

Db4oJobMgmtMntrInfoHolder holds the job mgmt&mntr information and job name.

Db4oJobMgmtMntrInfoHolderPredicate - class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolderPredicate.

Db4oJobMgmtMntrInfoHolderPredicate used to find the Db4oJobMgmtMntrInfoHolder objects in Db4o database using native query.

Db4oJobStatisticsPredicate - class org.jmonks.batch.framework.repository.db4o.Db4oJobStatisticsPredicate.

Db4oJobStatisticsPredicate used to find the JobStatistics objects in Db4o database using native query.

Db4oRepository - class org.jmonks.batch.framework.repository.db4o.Db4oRepository.

This implementation of repository uses the DB4O database as the repository.

Db4oRepository() - Constructor for class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Do not use this constructor to instantiate Db4oRepository directly.

deserializeObjectFromInputStream(InputStream) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

Deserializes the given inputstream and return the object.

E

ErrorCode - class org.jmonks.batch.framework.ErrorCode.

The ErrorCode represents the error condition that can generate in the system.

equals(Object) - Method in class org.jmonks.batch.framework.ErrorCode

Equality will be based on the code the two ErrorCodes contains.

F

FINISHED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates the processor is finished.

FRAMEWORK_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of framework config component.

FRAMEWORK_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the framework configuration error.

FRAMEWORK_LOGGING_FILE - Static variable in class org.jmonks.batch.framework.LoggingManager

Framework configuration file which is batch_framework.log.

FrameworkConfig - class org.jmonks.batch.framework.config.FrameworkConfig.

FrameworkConfig class is responsible to read the framework configuration from framework-config.xml file and gives the configuration in the form of configuration objects when needed.

FrameworkConfig.FrameworkLoggingConfig - class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig.

FrameworkLoggingConfig class holds configuration required to enable the framework logging by LoggingManager.

FrameworkConfig.JobConfigFactoryConfig - class org.jmonks.batch.framework.config.FrameworkConfig.JobConfigFactoryConfig.

JobConfigFactoryConfig class holds the configuration information required by Job configuration factories.

FrameworkConfig.JobConnectorConfig - class org.jmonks.batch.framework.config.FrameworkConfig.JobConnectorConfig.

JobConnectorConfig class holds the configuration required to create the JobConnectorHelper classes used in establishing the job management agent and clients.

FrameworkConfig.JobControllerConfig - class org.jmonks.batch.framework.config.FrameworkConfig.JobControllerConfig.

ControllerConfig holds the configuration related to the controller components.

FrameworkConfig.RepositoryConfig - class org.jmonks.batch.framework.config.FrameworkConfig.RepositoryConfig.

RepositoryConfig class holds the configuration required to create the class provides the interface to the framework repository and properties needed to work with the repository.

FrameworkUtil - class org.jmonks.batch.framework.util.FrameworkUtil.

FramworkUtil contains utility methods required by the framework.

G

getBasicJobProcessThreadCount() - Method in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Returns the number of basic job processor instances needs to be run to process this job.

getBasicJobProcessorClassName() - Method in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Gets the basic job processor class name.

getBasicJobProcessorConfigProperties() - Method in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Gets the unmodifiable map contains the properties required by basic job processor.

getCode() - Method in class org.jmonks.batch.framework.ErrorCode

Returns the error code represents the error.

getConfigClassName(String, String) - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobControllerConfig

Gets the controller configuration class name from the controller config related to the requested factory.

getConnection(Map) - Static method in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Get the required properties from the given configMap and establishes the connection.

getData() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder

Returns the job data.

getDataFromPreviousJob(String, String) - Method in class org.jmonks.batch.framework.Repository

Gets the data that has been sent by the previous job with the given data identifier.

getDataFromPreviousJob(String, String) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

getDataFromPreviousJob(String, String) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

getDataIdentifier() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder

Returns the data identifier.

getEndTime() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the ending time of this job.

getErrorCode() - Method in class org.jmonks.batch.framework.config.ConfigurationException

Traslates the configuration exception into error code to be retruned to the clients.

getExceptionComponent() - Method in class org.jmonks.batch.framework.config.ConfigurationException

Returns the componenet caused this exception.

getExitCode() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the exit code.

getExpectedRecordsCount() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Returns the total number of records this job going to process.

getExpectedRecordsCount() - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Returns the total number of records this job going to process.

getExpectedRecordsCount() - Method in class org.jmonks.batch.framework.management.JobMonitor

getExpectedRecordsCount() - Method in interface org.jmonks.batch.framework.management.JobMonitorMBean

Gets the total number of records this job might try to process.

getFrameworkConfig() - Method in class org.jmonks.batch.framework.JobContext

Gets the reference to the framework configuration.

getFrameworkLoggingConfig() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the logging configuration defined in the framework configuration as a FrameworkLoggingConfig object.

getFrameworkLoggingLevel() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig

Returns the framework log level to use for the logging.

getInstance() - Static method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the FrameworkConfig instance.

getJobBasePackageName() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig

Returns the base package name to be used for the logging.

getJobConfig() - Method in class org.jmonks.batch.framework.JobContext

Gets the job configuration object belongs to the running job.

getJobConfig(String) - Method in class org.jmonks.batch.framework.config.JobConfigFactory

Returns the requested JobConfig object from the defined factory.

getJobConfig(String) - Method in class org.jmonks.batch.framework.config.db.DBJobConfigFactory

Returns the requested job configuration as JobConfig object.

getJobConfig(String) - Method in class org.jmonks.batch.framework.config.xml.XMLJobConfigFactory

Returns the requested job configuration as JobConfig object.

getJobConfigFactory(FrameworkConfig.JobConfigFactoryConfig) - Static method in class org.jmonks.batch.framework.config.JobConfigFactory

This factory method will return the appropriate job configuration factory based on the input values in JobConfigFactoryConfig object.

getJobConfigFactoryClassName() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConfigFactoryConfig

Returns the class name of the factory used to read the job configuration.

getJobConfigFactoryConfig() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the job configuration factory configuration defined in framework configuration as JobConfigFactoryConfig object.

getJobConfigFactoryProperties() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConfigFactoryConfig

Returns the unmodifiable properties map used by the factory class to read the job configuration.

getJobConnectorConfig() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the mgmt&mntr configuration defines in the framework configuration as JobConnectorConfig object.

getJobConnectorConfigProperties() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConnectorConfig

Returns the unmodifiable map consist of the properties needed by the defined job connectors.

getJobConnectorHelper(FrameworkConfig.JobConnectorConfig, JobManagementAgent) - Static method in class org.jmonks.batch.framework.management.JobConnectorHelper

This factory method creates the correct implementation of JobConnectorHelper based on the given configuration which is defined in framework-config.xml file.

getJobConnectorHelperClassName() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConnectorConfig

Returns the defined job connector helper class name for the framework.

getJobController() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolder

Returns the mgmt & mntr object.

getJobControllerClasName() - Method in class org.jmonks.batch.framework.config.JobControllerConfig

Gets the job controller class name.

getJobControllerConfig() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the job controller configuration defined in framework configuration as a JobControllerConfig object.

getJobControllerConfig() - Method in class org.jmonks.batch.framework.config.JobConfig

Returns the Controller configuraiton of the job this JobConfig represents.

getJobControllerConfig(String, Connection) - Static method in class org.jmonks.batch.framework.config.db.DBJobControllerConfig

Factory method creates and returns the controller specific controller config object from the table job_config and controller specific tables.

getJobControllerConfig(Element) - Static method in class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig

Factory method creates and returns the controller specific controller config object from the following XML block from the job configuration file.

getJobControllerConfigProperties() - Method in class org.jmonks.batch.framework.config.JobControllerConfig

Gets the unmodifiable map contains the properties required by the controller.

getJobInvokeConfig() - Method in class org.jmonks.batch.framework.JobContext

Gets the configuration passed in the invocation to the framework.

getJobLoggingConfig() - Method in class org.jmonks.batch.framework.config.JobConfig

Returns job logging configuration.

getJobLoggingDirecotry() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig

Returns the job logging directory name, where to all the job logs needs to be written.

getJobLoggingLevel() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig

Returns the job log level to use for the logging.

getJobName() - Method in class org.jmonks.batch.framework.JobContext

Gets the name of the job this context is associated with.

getJobName() - Method in class org.jmonks.batch.framework.config.JobConfig

Returns the name of the job.

getJobName() - Method in class org.jmonks.batch.framework.management.JobNotification

Gets the job name;

getJobName() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolder

Returns the jobName.

getJobName() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolder

Returns the jobName.

getJobStatistics() - Method in class org.jmonks.batch.framework.JobController

Returns the statistics of this job.

getJobStatistics() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

getJobStatistics() - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

getJobStatus() - Method in class org.jmonks.batch.framework.config.JobConfig

Returns whether the job is active or not.

getJobname() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the job name

getLoadedJobDataCount() - Method in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

getLoadedJobDataCount() - Method in interface org.jmonks.batch.framework.controller.pool.JobPool

Returns the number of job data objects being loaded into the pool.

getLoaderState() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Returns the processing state of the loader.

getLoaderState() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Gets the loader state as object which can be understan by the monitoring client.

getLoaderStatus() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Returns the status of the loader.

getLoaderStatus() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Gets the loader status.

getLogLevel(String) - Method in class org.jmonks.batch.framework.JobController

Gets the log level of the given logger name.

getLogLevel(String) - Static method in class org.jmonks.batch.framework.LoggingManager

Gets the log level of the given logger name.

getLogLevel(String) - Method in class org.jmonks.batch.framework.management.JobManager

Gets the log level of the given logger name.

getLogLevel(String) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Gets the log level of the given logger name.

getLoggerLevel() - Method in class org.jmonks.batch.framework.config.JobLoggingConfig.JobLoggerConfig

Returns the logger level.

getLoggerName() - Method in class org.jmonks.batch.framework.config.JobLoggingConfig.JobLoggerConfig

Returns the logger name.

getLoggers() - Method in class org.jmonks.batch.framework.config.JobLoggingConfig

Gets the array of JobLoggerConfig objects defined for this job.

getMaxMemoryUsage() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the maximum memory used by this job in bytes.

getMessage() - Method in class org.jmonks.batch.framework.ErrorCode

Returns the error message illustrates the exit code.

getMgmtMntrInfo() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolder

Returns the mgmt & mntr object.

getNextJobData() - Method in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

getNextJobData() - Method in interface org.jmonks.batch.framework.controller.pool.JobPool

Gets the next available job data(piece of information) to be processed.

getPoolClassName() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the pool class name.

getPoolConfigProperties() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the unmodifiable map contains properties needed by the pool class.

getPoolJobLoaderClassName() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the pool job loader class name.

getPoolJobLoaderConfigProperties() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the unmodifiable map contains the properties needed by pool job loader.

getPoolJobProcessorClassName() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the pool job processor class name.

getPoolJobProcessorConfigProperties() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Gets the unmodifiable map contains the properties needed by pool job processor.

getPoolJobProcessorThreadCount() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Returns the number of instances of pool job processors needs to be created to process this job.

getProcessedJobDataCount() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

getProcessedJobDataCount() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Returns the number of job data objects this particular job processor has finsihed.

getProcessedRecordsCount() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Returns the number of records processed so far.

getProcessedRecordsCount() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

This is for monitoring applications to know how many records this particular (if there are multiple job processors) job processor has finished processing.

getProcessedRecordsCount() - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Number of records got processed so far.

getProcessedRecordsCount() - Method in class org.jmonks.batch.framework.management.JobMonitor

getProcessedRecordsCount() - Method in interface org.jmonks.batch.framework.management.JobMonitorMBean

Gets the records processed by this job so far.

getProcessingInfo() - Method in class org.jmonks.batch.framework.management.ProcessorState

Returns the processor processing information.

getProcessorDescription() - Method in class org.jmonks.batch.framework.management.ProcessorState

Returns the processor description.

getProcessorID() - Method in class org.jmonks.batch.framework.management.ProcessorState

Returns the processor ID.

getProcessorIDList() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Returns the IDs of all the processors as string array.

getProcessorIDList() - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Returns the IDs assigned to all the processors, loader as a string array.

getProcessorIDList() - Method in class org.jmonks.batch.framework.management.JobMonitor

getProcessorIDList() - Method in interface org.jmonks.batch.framework.management.JobMonitorMBean

Returns the array of IDs assigned to be processors running under this controller.

getProcessorState(String) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Returns the state of the requested processor as a ProcessorState object.

getProcessorState() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

This is for monitoring applications to know what the information (record) this job processor is processing.

getProcessorState() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

getProcessorState(String) - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Returns the current state of the processor identified by the given processor ID as the ProcessorState object.

getProcessorState() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Gets the processor to be displyed or anaylyzed for the monitoring purposes.

getProcessorState(String) - Method in class org.jmonks.batch.framework.management.JobMonitor

getProcessorState(String) - Method in interface org.jmonks.batch.framework.management.JobMonitorMBean

Gets the state of the processor identified by the given processor ID.

getProcessorStatus(String) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Returns the status of the processor identified by the given processor ID.

getProcessorStatus() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Returns the status of the processor as a ProcessorStatus object, which gives the information like whether the processor is running, suspended, resumed or stopped.

getProcessorStatus() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

getProcessorStatus(String) - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Returns the status of the processor identified by the given processor ID.

getProcessorStatus() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Gets the processor status being used by the management clients.

getProcessorStatus(String) - Method in class org.jmonks.batch.framework.management.JobManager

Returns the status of the processor identified by the given processor ID.

getProcessorStatus(String) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Returns the status of the processor identified by the given processor ID.

getRecordsProcessed() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the number of records processed.

getRepository() - Method in class org.jmonks.batch.framework.JobContext

Gets the repository reference configured for this framework.

getRepositoryClassName() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.RepositoryConfig

Returns the repository class name responsible to work with the repository.

getRepositoryConfig() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the repository configuration defined in framework configuration as a RepositoryConfig object.

getRepositoryConfigProperties() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.RepositoryConfig

Returns all the properties required by the repository class to interact with the repsoitory in a unmodifiable map.

getSourceJobName() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder

Returns the source job name.

getStartTime() - Method in class org.jmonks.batch.framework.JobStatistics

Gets the start time of this job.

getTargetJobName() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder

Returns the target job name.

getTotalJobDataCount() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Returns the number of job data objects that this loader is going to load.

getTotalJobDataCount() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Gets the total records this loader is going to load.

getTotalRecordsCount() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

This is for monitoring applications to know how many records this particular (if there are multiple job processors) job processor is going to process.

H

hashCode() - Method in class org.jmonks.batch.framework.ErrorCode

Code represented by ErrorCode will be returned as a hash code.

I

INITIALIZED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates that processor is initailized.

INITIALIZING - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates that processor is being initialized.

INSTANTIATED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates that processor is instantiated.

init(Map) - Method in class org.jmonks.batch.framework.Repository

Method to initialize the repository implementation by using the properties defined in the framework configuration.

init(Map) - Method in class org.jmonks.batch.framework.config.JobConfigFactory

Method to initialize the factory using properies defined for this factory in framework configuration file.

init(Map) - Method in class org.jmonks.batch.framework.config.db.DBJobConfigFactory

This method initializes the factory by accepting the required properties as a map.

init(Map) - Method in class org.jmonks.batch.framework.config.xml.XMLJobConfigFactory

This method initializes the factory by accepting the required properties from the input map.

init(Map) - Method in class org.jmonks.batch.framework.management.JobConnectorHelper

This method will be called after instantiating the JobConnectorHelper to initialize JobConnectorHelper with the properties needed to create JMX connector server and initialize the lookup location needed to register and unregister the JMX connector servers.

init(Map) - Method in class org.jmonks.batch.framework.management.jmxmp.RepositoryJMXMPConnectorHelper

init(Map) - Method in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Initializes the ClientServerDb4oRepository by accepting the map consist of properties needed to access Db4o server.

init(Map) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Initializes the Db4oRepository by accepting the map consist of properties needed to setup the repository.

init(Map) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

Receives the jdbc configuration in a map from the factory method and validates the given configuration is valid by making a connection to the database.

initialize(JobContext) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Chance to initialize itself using the information provided through job context.

initialize(JobContext) - Method in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Initializes the collection job pool using the configuration defined in the job configuration.

initialize(JobContext) - Method in interface org.jmonks.batch.framework.controller.pool.JobPool

Controller calls this method to initialize the job pool.

initializeFrameworkLogging(FrameworkConfig.FrameworkLoggingConfig, Main) - Static method in class org.jmonks.batch.framework.LoggingManager

Initializes the logging of the framework in the directory defined in framework configuration.

initializeJobLogging(String, FrameworkConfig.FrameworkLoggingConfig, JobLoggingConfig, Main) - Static method in class org.jmonks.batch.framework.LoggingManager

This method accepts all the information available from framwork logging configuration and job logging configuration and loads the required loggers appropriately.

isRunning() - Method in class org.jmonks.batch.framework.management.JobManagementAgent

Tells whether the agent is running or not.

J

JMXMPConnectorHelper - class org.jmonks.batch.framework.management.jmxmp.JMXMPConnectorHelper.

JMXMPConnectorHelper creates the JMX connector server based on the JMX Messaging protocol and leaves the lookup location details to the class going to implement this abstract class.

JMXMPConnectorHelper() - Constructor for class org.jmonks.batch.framework.management.jmxmp.JMXMPConnectorHelper

JOB_COMPLETED_SUCCESSFULLY - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents job got completed successfully.

JOB_COMPLETED_WITH_ERRORS - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents job got completed with errors.

JOB_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of job config component.

JOB_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the job configuration error.

JOB_CONFIG_ELEMENT_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobConfig

Element name that identifies the job configuration which is job-config.

JOB_CONFIG_FACTORY_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of job config factory config component.

JOB_CONFIG_FACTORY_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the job config factory configuration error.

JOB_CONNECTOR_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of job connector config component.

JOB_CONNECTOR_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the connector configuration error.

JOB_CONTROLLER_CLASS_ATTRIBUTE_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig

Attribute name that identifies the job controller class name which is job-controller-class-name.

JOB_CONTROLLER_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of controller config component.

JOB_CONTROLLER_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the job controller configuration error.

JOB_CONTROLLER_CONFIG_FACTORY_CLASS_ATTRIBUTE_NAME - Static variable in class org.jmonks.batch.framework.config.db.DBJobControllerConfig

Identifier used to request the Framework controller configuration for the specific controller config for this factory.

JOB_CONTROLLER_CONFIG_FACTORY_CLASS_ATTRIBUTE_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig

Element name that identifies the job controller configuration class name which is xml-factory-config-class-name.

JOB_CONTROLLER_ELEMENT_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig

Element name that identifies the job controller configuration which is job-controller.

JOB_FINISHED - Static variable in class org.jmonks.batch.framework.management.JobNotification

Notification type specifies that the job got finished.

JOB_INVOKATION_CONFIGURAION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the configuration error used to invoke the job.

JOB_IS_NOT_CONFIGURED - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the job is not configured error.

JOB_LOGGING_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the logging configuration error.

JOB_LOGGING_CONFIG_ELEMENT_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobLoggingConfig

Element name represents the job logging config which is job-logging-config.

JOB_MANAGER_MBEAN_NAME - Static variable in class org.jmonks.batch.framework.management.JobManagementAgent

Name of the bean that manages this job.

JOB_MONITOR_MBEAN_NAME - Static variable in class org.jmonks.batch.framework.management.JobManagementAgent

Name of the bean monitors this job.

JOB_NAME_ATTRIBUTE_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobConfig

Attribute name that identifies the job name which is job-name.

JOB_NAME_KEY_NAME - Static variable in class org.jmonks.batch.framework.Main

Name of the parameter key holds the job name in configuration map which is job-name.

JOB_REPOSITORY_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the repository configuration error.

JOB_STATUS_ATTRIBUTE_NAME - Static variable in class org.jmonks.batch.framework.config.xml.XMLJobConfig

Attribute name that identifies the job status which is job-status.

JdbcConnectionHelper - class org.jmonks.batch.framework.util.JdbcConnectionHelper.

JdbcConnectionHelper helps the jdbc repository and db configuration factory to create the jdbc connections with the given configuration map and closes the connections.

JdbcRepository - class org.jmonks.batch.framework.repository.jdbc.JdbcRepository.

JdbcRepository implementation of repository uses any database that can be accessed by using the JDBC technology.

JdbcRepository() - Constructor for class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

JobConfig - class org.jmonks.batch.framework.config.JobConfig.

JobConfig represents the configuration needed to execute the job.

JobConfig() - Constructor for class org.jmonks.batch.framework.config.JobConfig

JobConfigFactory - class org.jmonks.batch.framework.config.JobConfigFactory.

JobConfigFactory returns the factory class instance which in turn returns the job configuration objects from the designated factory.

JobConfigFactory() - Constructor for class org.jmonks.batch.framework.config.JobConfigFactory

JobConnectorHelper - class org.jmonks.batch.framework.management.JobConnectorHelper.

JobConnectorHelper defines the helper methods will be used in creating the JMX connector server, registering and unregistering the JMX connector server in lookup location.

JobConnectorHelper() - Constructor for class org.jmonks.batch.framework.management.JobConnectorHelper

JobContext - class org.jmonks.batch.framework.JobContext.

JobContext provides the references to the framework resources.

JobContext(Map, Main) - Constructor for class org.jmonks.batch.framework.JobContext

Creates and Initializes the JobContext object by looking up the information in the given context parameters map.

JobController - class org.jmonks.batch.framework.JobController.

Job Controller is the important component, which actually creates and drives the execution of the job.

JobController() - Constructor for class org.jmonks.batch.framework.JobController

JobControllerConfig - class org.jmonks.batch.framework.config.JobControllerConfig.

JobControllerConfig represents the configuration needed for the Controller componenet.

JobControllerConfig() - Constructor for class org.jmonks.batch.framework.config.JobControllerConfig

JobLoggingConfig - class org.jmonks.batch.framework.config.JobLoggingConfig.

JobLoggingConfig holds the list of loggers defined for this job.

JobLoggingConfig() - Constructor for class org.jmonks.batch.framework.config.JobLoggingConfig

JobLoggingConfig.JobLoggerConfig - class org.jmonks.batch.framework.config.JobLoggingConfig.JobLoggerConfig.

JobLoggerConfig holds the information of each logger defined for the job.

JobManagementAgent - class org.jmonks.batch.framework.management.JobManagementAgent.

JobManagementAgent defines the methods to start and stop the JMX Agent for this job.

JobManager - class org.jmonks.batch.framework.management.JobManager.

JobManager instruments the job controller for management purposes.

JobManager(JobController) - Constructor for class org.jmonks.batch.framework.management.JobManager

Creates a new instance of JobManagerMBean and initializes with job controller.

JobManagerMBean - interface org.jmonks.batch.framework.management.JobManagerMBean.

This standard MBean interface provides the methods to instrument the job controller and processors running under the job controller.

JobMonitor - class org.jmonks.batch.framework.management.JobMonitor.

Implementation of job monitor mbean to instrument the job controller.

JobMonitor(JobController) - Constructor for class org.jmonks.batch.framework.management.JobMonitor

Creates a new instance of JobMonitorMBean and initializes with job controller.

JobMonitorMBean - interface org.jmonks.batch.framework.management.JobMonitorMBean.

JobMonitorMBean interface defines the methods to instrument the job being run to find out the statistics of the job and to find out all the processor states running in the controller.

JobNotification - class org.jmonks.batch.framework.management.JobNotification.

Notification to send the specified job information and define the various notification types.

JobNotification(String, String, Object, String) - Constructor for class org.jmonks.batch.framework.management.JobNotification

Creates a new instance of JobNotification

JobPool - interface org.jmonks.batch.framework.controller.pool.JobPool.

JobPool pools all the job data being loaded by the loader and serves this data when job processors requests for the processing.

JobStatistics - class org.jmonks.batch.framework.JobStatistics.

JobStatistics holds the useful metrics and information of particular run of a job.

JobStatistics(String) - Constructor for class org.jmonks.batch.framework.JobStatistics

Constructor takes the job name and build the skelton.

jdbcConfigMap - Variable in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

Map holds the jdbc configuration.

jobConfig - Variable in class org.jmonks.batch.framework.JobContext

Holds the job configuration object reference.

jobContext - Variable in class org.jmonks.batch.framework.JobController

JobContext associated to this controller.

jobControllerClassName - Variable in class org.jmonks.batch.framework.config.JobControllerConfig

Class name that defines the kind of controller job wants to use.

jobControllerConfig - Variable in class org.jmonks.batch.framework.config.JobConfig

Controller configuration of the job.

jobControllerConfigProps - Variable in class org.jmonks.batch.framework.config.JobControllerConfig

Map holds the required properties support the specified controller.

jobInvokeConfig - Variable in class org.jmonks.batch.framework.JobContext

Holds the job invoke configuration reference.

jobLoggingConfig - Variable in class org.jmonks.batch.framework.config.JobConfig

Map holds the logger information.

jobName - Variable in class org.jmonks.batch.framework.Repository

Name of the job associated with the repository.

jobName - Variable in class org.jmonks.batch.framework.config.JobConfig

Name of the job this configuration belongs to.

jobStatus - Variable in class org.jmonks.batch.framework.config.JobConfig

Variable holds the status of the job.

L

LOGGING_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of logging config component.

LoggingManager - class org.jmonks.batch.framework.LoggingManager.

Logging Manager provides the logging services to the framework.

loadJobData(Object) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Loads the given job data into the job pool.This method is for the final loaders to load the job data into the pool.

loadJobData(Object) - Method in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

loadJobData(Object) - Method in interface org.jmonks.batch.framework.controller.pool.JobPool

Job Loader will use this API to load the job data into the pool.

loadPool(JobContext, JobPool) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Abstracts the job pool details from the final loader by defining other set of methods for the final loader and implements the management and monitoring related methods.

loadPool(JobContext) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Load the job data into the pool that needs to be processed by job processor(s).

loadPool(JobContext, JobPool) - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Loads the job data that needs to be processed in to the job pool.

loadPropertiesFromElementToMap(Element, Map) - Static method in class org.jmonks.batch.framework.util.FrameworkUtil

Loads the property elements exists in the given element to the given map.

loadPropertiesFromStringToMap(String, Map) - Static method in class org.jmonks.batch.framework.util.FrameworkUtil

Loads the property key value pairs exists in the given string to the given map.

loadedJobsCount - Variable in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Holds the number of job data objects have been loaded by job loader.

loaderStatus - Variable in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Holds the status of the loader.

logStatistics(JobStatistics) - Method in class org.jmonks.batch.framework.Repository

Logs the job statistics given in the form of JobStatistics object in the repository for further use/references.

logStatistics(JobStatistics) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

logStatistics(JobStatistics) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

M

MBEAN_SERVER_DOMAIN_NAME - Static variable in class org.jmonks.batch.framework.management.JobManagementAgent

Mbean Server domain name.

Main - class org.jmonks.batch.framework.Main.

Main is the entry point to the batch framework.

main(String[]) - Static method in class org.jmonks.batch.framework.Main

This method provides the interface to execute the jobs from command line.

match(Db4oJobControllerHolder) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolderPredicate

Method to run the the native query.

match(Db4oJobMgmtMntrInfoHolder) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolderPredicate

Method to run the the native query.

match(JobStatistics) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobStatisticsPredicate

Method to run the the native query.

O

org.jmonks.batch.framework - package org.jmonks.batch.framework

org.jmonks.batch.framework.config - package org.jmonks.batch.framework.config

org.jmonks.batch.framework.config.db - package org.jmonks.batch.framework.config.db

org.jmonks.batch.framework.config.xml - package org.jmonks.batch.framework.config.xml

org.jmonks.batch.framework.controller.basic - package org.jmonks.batch.framework.controller.basic

org.jmonks.batch.framework.controller.pool - package org.jmonks.batch.framework.controller.pool

org.jmonks.batch.framework.management - package org.jmonks.batch.framework.management

org.jmonks.batch.framework.management.jmxmp - package org.jmonks.batch.framework.management.jmxmp

org.jmonks.batch.framework.repository.db4o - package org.jmonks.batch.framework.repository.db4o

org.jmonks.batch.framework.repository.jdbc - package org.jmonks.batch.framework.repository.jdbc

org.jmonks.batch.framework.util - package org.jmonks.batch.framework.util

P

POOL_JOB_LOADER_EXCEPTION - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents error because of the exception in pool job loader.

POOL_JOB_PROCESSOR_EXCEPTION - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents error because of the exception in pool job processor.

POOL_SIZE_PROPERTY_NAME - Static variable in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Property name by which pool size will be associated with.

PROPERTY_DATABASE_PASSWORD - Static variable in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Constant defines the property name for database password which is password.

PROPERTY_DATABASE_USER_NAME - Static variable in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Constant defines the property name for database user name which is username.

PROPERTY_DB4O_DIRECTORY - Static variable in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Property identifies the db4o directory name which is db4o-directory.

PROPERTY_DB4O_SERVER_NAME - Static variable in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Property identifies the Db4o Server name which is db4o-server-name.

PROPERTY_DB4O_SERVER_PASSWORD - Static variable in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Property identifies the Db4o Server password which is db4o-server-password.

PROPERTY_DB4O_SERVER_PORT - Static variable in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Property identifies the Db4o Server port which is db4o-server-port.

PROPERTY_DB4O_SERVER_USERNAME - Static variable in class org.jmonks.batch.framework.repository.db4o.ClientServerDb4oRepository

Property identifies the Db4o Server user name which is db4o-server-username.

PROPERTY_JDBC_DRIVER_CLASS_NAME - Static variable in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Constant defines the property name for jdbc driver class name which is jdbc-driver-class-name.

PROPERTY_JDBC_URL - Static variable in class org.jmonks.batch.framework.util.JdbcConnectionHelper

Constant defines the property name for database URL which is jdbc-url.

PoolJobController - class org.jmonks.batch.framework.controller.pool.PoolJobController.

PoolJobController provides the job architecture based on the pool concept, where a loader is load all the information to be processed into the pool and processors(>=1) retrieves the information from pool and process them.

PoolJobController() - Constructor for class org.jmonks.batch.framework.controller.pool.PoolJobController

Constructor enables the instantiation of the pool job controller instance.

PoolJobControllerConfig - class org.jmonks.batch.framework.config.PoolJobControllerConfig.

PoolJobControllerConfig represents the controller congiguration needed by PoolJobController.

PoolJobControllerConfig() - Constructor for class org.jmonks.batch.framework.config.PoolJobControllerConfig

PoolJobLoader - interface org.jmonks.batch.framework.controller.pool.PoolJobLoader.

PoolJobLoader loads the job data into the pool to be processed by PoolJobProcessor(s).

PoolJobProcessor - interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor.

PoolJobProcessor gets the job data to be processed from the job pool and processes it.

ProcessorState - class org.jmonks.batch.framework.management.ProcessorState.

This represents the state of the processor(thread) running under the controller.

ProcessorState(String, String, Object) - Constructor for class org.jmonks.batch.framework.management.ProcessorState

Constructor initializes the object.

ProcessorStatus - class org.jmonks.batch.framework.management.ProcessorStatus.

ProcessorStatus defines the statuses that processors can be in the system.

pool - Variable in class org.jmonks.batch.framework.controller.pool.CollectionJobPool

Java utility collection holds the job data objects.

poolClassName - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Pool class name.

poolConfigProps - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Map contains the properties needed by pool class.

poolJobLoaderClassName - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Pool job loader class name.

poolJobLoaderConfigProps - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Map contains the properties needed by pool job loader.

poolJobProcessorClassName - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Pool job processor class name.

poolJobProcessorConfigProps - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Map contains the properties needed by pool job processor.

poolJobProcessorThreadCount - Variable in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Holds the number of instances to be created.

process() - Method in class org.jmonks.batch.framework.JobController

This method will be called by the Main to process the job.

process(Map) - Static method in class org.jmonks.batch.framework.Main

This method provides the interface to execute the job from another java program.

process() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Executes the job by running the configured number of basic job processors and returns the appropriate errorcode.

process(JobContext) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Does the processing and return the appropriate error code.

process(Object) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Execute the business logic on the given jobData and return the appropriate error code.

process() - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Executes the job by creating the pool, loader and processor(s) based on the configuration and have them work accordingly to process the job.

processPool(JobContext, JobPool) - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Initializes the processor implementation by calling the initialize method by passing job context reference, gets the job data from the pool and passes that information to the processor implementation for processing and cleans up the processor implementation by calling the cleanup method.

processPool(JobContext, JobPool) - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Process the job data available in the job pool until the job loader done loading of all the job data into the pool.

processorStatus - Variable in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Indicates the status of this processor.

processorStatus - Variable in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Holds the processor status.

processorThread - Variable in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Holds the thread references this processor has been spawned.

R

REPOSITORY_CONFIG - Static variable in class org.jmonks.batch.framework.config.ConfigurationException

Constant defines the source of repository config component.

RESUMED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates the processor is resumed.

RUNNING - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates that processor is running.

Repository - class org.jmonks.batch.framework.Repository.

Repository class provides utility methods to access and use the repository maintained by the framework.

Repository() - Constructor for class org.jmonks.batch.framework.Repository

RepositoryJMXMPConnectorHelper - class org.jmonks.batch.framework.management.jmxmp.RepositoryJMXMPConnectorHelper.

This connector is based on JMX Messaging protocol and uses the framework reposiotry as the lookup location to register and unregister the JMX Service URL.

RepositoryJMXMPConnectorHelper() - Constructor for class org.jmonks.batch.framework.management.jmxmp.RepositoryJMXMPConnectorHelper

registerConnectorServer(JobContext, JMXConnectorServer) - Method in class org.jmonks.batch.framework.management.JobConnectorHelper

Registers the jmx connector server with the job name taken from job context in the desired lookup location.

registerConnectorServer(JobContext, JMXConnectorServer) - Method in class org.jmonks.batch.framework.management.jmxmp.RepositoryJMXMPConnectorHelper

Registers the jmx connector server with the job name taken from job context in the repository defined for this framework.

registerJobMgmtMntrInfo(Object) - Method in class org.jmonks.batch.framework.Repository

Registers the given job management and monitoring information to this job.

registerJobMgmtMntrInfo(Object) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

registerJobMgmtMntrInfo(Object) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

repository - Variable in class org.jmonks.batch.framework.JobContext

Holds the framework repository reference.

repositoryConfigProperties - Variable in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

Map holds the configuration properties of repository.

resume(String) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Resumes the processor identified by given processor ID.

resume() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Basic job controller calls this method to resume the job processor, when it receives a resume message from the managemet interface.

resume() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Resumes the loading of the jobs.

resume() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Resumes the processor.

resume(String) - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Resumes the processor identified by given processor ID.

resume() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Resumes the loader.

resume() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Resumes the pool job processor.

resume(String) - Method in class org.jmonks.batch.framework.management.JobManager

Controller should resume processing of the processor identified by the given processor ID.

resume(String) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Controller should resume processing of the processor identified by the given processor ID.

S

STOPPED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indicates the processor is stopped.

SUSPENDED - Static variable in class org.jmonks.batch.framework.management.ProcessorStatus

Status indictes that processor is suspended.

sendDataToNextJob(String, String, Object) - Method in class org.jmonks.batch.framework.Repository

Data will be send to the specified next job and will be identified with the given identifier.

sendDataToNextJob(String, String, Object) - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

sendDataToNextJob(String, String, Object) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

serializeObjectIntoByteArray(Object) - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

Serializes the given object and return that serialized data as byte array.

setEndTime(Date) - Method in class org.jmonks.batch.framework.JobStatistics

Sets the endtime of the job.

setExitCode(ErrorCode) - Method in class org.jmonks.batch.framework.JobStatistics

Sets the given error code as exit code.

setMaxMemeoryUsage(long) - Method in class org.jmonks.batch.framework.JobStatistics

Sets the maximum memory used for the job in bytes.

setRecordsProcessed(long) - Method in class org.jmonks.batch.framework.JobStatistics

Sets the number of the records processed in this job.

setStartTime(Date) - Method in class org.jmonks.batch.framework.JobStatistics

Sets the startime of the job.

start(JobController) - Method in class org.jmonks.batch.framework.management.JobManagementAgent

This method start the job management agent with the given controller information.

stop(String) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Stops the processor identified by the given processor ID.

stop() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Basic job controller calls this method to stop the job processor, when it receives a stop message from the managemet interface.

stop() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Stops the loading of the jobs into the pool.

stop() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Stops the processor.

stop(String) - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Stops the processor identified by the given processor ID.

stop() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Stops the loader.

stop() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Stops the processor.

stop(ErrorCode) - Method in class org.jmonks.batch.framework.management.JobManagementAgent

Stops the JMX connector server, unregisters the MBeans and MBeanServer and unregisters the jmx service url information from lookup location and marks stopped flag as true to indicate that agent has been stopped.

stop(String) - Method in class org.jmonks.batch.framework.management.JobManager

Controller should stop processing of the processor identified by the given processor ID.

stop(String) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Controller should stop processing of the processor identified by the given processor ID.

stopLoading() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Tells whether the loading of the jobs needs to be stopped or not.

suspend(String) - Method in class org.jmonks.batch.framework.controller.basic.BasicJobController

Suspends the processor identified by the given processor ID.

suspend() - Method in class org.jmonks.batch.framework.controller.basic.BasicJobProcessor

Basic job controller calls this method to suspend the job processor, when it receives a suspsend message from the managemet interface.

suspend() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobLoader

Suspends loading of the jobs into the pool.

suspend() - Method in class org.jmonks.batch.framework.controller.pool.AbstractPoolJobProcessor

Suspends the processor.

suspend(String) - Method in class org.jmonks.batch.framework.controller.pool.PoolJobController

Suspends the processor identified by the given processor ID.

suspend() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobLoader

Suspends the loader.

suspend() - Method in interface org.jmonks.batch.framework.controller.pool.PoolJobProcessor

Suspends the pool job processor.

suspend(String) - Method in class org.jmonks.batch.framework.management.JobManager

Controller should suspend processing of the processor identified by the give processor ID.

suspend(String) - Method in interface org.jmonks.batch.framework.management.JobManagerMBean

Controller should suspend processing of the processor identified by the give processor ID.

T

toString() - Method in class org.jmonks.batch.framework.ErrorCode

Returns the string representation of ErrorCode class in the format
{ErrorCode [code = value] [message = value]}

toString() - Method in class org.jmonks.batch.framework.JobStatistics

Returns the string representation of JobStatistics class in the format
{JobStatistics [jobName = value] [startTime = value] [endTime = value]}

toString() - Method in class org.jmonks.batch.framework.config.BasicJobControllerConfig

Returns the string representation of BasicJobControllerConfig class in the format
{BasicJobControllerConfig [controllerClassName = value] [controllerConfigProps = value] [basicJobProcessorClassName = value] [basicJobProcessorConfigProps = value] [basicJobProcessorThreadCount = value]}

toString() - Method in class org.jmonks.batch.framework.config.ConfigurationException

Returns the string representation of ConfigurationException class in the format
{ConfigurationException [component = value] [message = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.FrameworkLoggingConfig

Returns the string representation of FrameworkLoggingConfig class in the format
{FrameworkLoggingConfig [jobLoggingDirectory = value] [frameworkLoggingLevel = value] [jobBasePackageName = value] [jobLoggingLevel = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConfigFactoryConfig

Returns the string representation of JobConfigFactoryConfig class in the format
{JobConfigFactoryConfig [configFactoryclassName = value] [properties = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobConnectorConfig

Returns the string representation of JobConnectorConfig class in the format
{JobConnectorConfig [jobConnectorHelperClassName = value] [properties = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.JobControllerConfig

Returns the string representation of JobControllerConfig class in the format
{JobControllerConfig [controllerProperties = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig.RepositoryConfig

Returns the string representation of RepositoryConfig class in the format
{RepositoryConfig [repositoryClassName = value] [properties = value]}

toString() - Method in class org.jmonks.batch.framework.config.FrameworkConfig

Returns the string representation of FrameworkConfig class in the format
{FrameworkConfig [jobConfigFactoryConfig = value] [frameworkLoggingConfig = value] [jobConnectorConfig = value] [repositoryConfig = value][controllerConfig = value]}

toString() - Method in class org.jmonks.batch.framework.config.JobConfig

Returns the string representation of JobConfig class in the format
{JobConfig [name = value] [status = value] [controllerConfig = value]}

toString() - Method in class org.jmonks.batch.framework.config.JobLoggingConfig.JobLoggerConfig

Returns the string representation of JobLoggerConfig class in the format
{JobLoggerConfig [loggerName = value] [loggerLevel = value]}

toString() - Method in class org.jmonks.batch.framework.config.JobLoggingConfig

Returns the string representation of JobLoggingConfig class in the format
{JobLoggingConfig [loggerList = value]}

toString() - Method in class org.jmonks.batch.framework.config.PoolJobControllerConfig

Returns the string representation of PoolJobControllerConfig class in the format
{PoolJobControllerConfig [controllerClassName = value] [controllerConfigProps = value] [poolJobProcessorClassName = value] [poolJobProcessorConfigProps = value] [poolJobLoaderClassName = value] [poolJobLoaderConfigProps = value] [jobPoolClassName = value] [jobPoolConfigProps = value] [poolJobProcessorThreadCount = value]}

toString() - Method in class org.jmonks.batch.framework.config.xml.XMLJobConfigFactory

Returns the string representation of XMLJobConfigFactory class in the format
{XMLJobConfigFactory [configProperties = value] [element = value]}

toString() - Method in class org.jmonks.batch.framework.management.JobNotification

Returns the string representation of JobNotification class in the format
{JobNotification [jobName = value] [rest = value] }

toString() - Method in class org.jmonks.batch.framework.management.ProcessorState

Returns the string representation of ProcessorState class in the format
{ProcessorState [ID = value] [desc = value] [processingInfo = value]}

toString() - Method in class org.jmonks.batch.framework.management.ProcessorStatus

Returns the job status in string format.

toString() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobControllerHolder

Returns the string representation of Db4oJobControllerHolder class in the format
{Db4oJobControllerHolder [jobName = value] [mgmtMntrInfo = value]}

toString() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobDataTransferHolder

Returns the string representation of Db4oJobDataTransferHolder class in the format
{Db4oJobDataTransferHolder [dataIdentifier = value] [sourceJN = value] [targetJN = value] [data = value]}

toString() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oJobMgmtMntrInfoHolder

Returns the string representation of Db4oJobMgmtMntrInfoHolder class in the format
{Db4oJobMgmtMntrInfoHolder [jobName = value] [mgmtMntrInfo = value]}

U

UNKNOWN_CONFIGURATION_ERROR - Static variable in class org.jmonks.batch.framework.ErrorCode

Represents the unknown configuration error.

unregisterConnectorServer(JobContext) - Method in class org.jmonks.batch.framework.management.JobConnectorHelper

Unregisters the jmx connector server registered in desired lookup location with the job name available in job context.

unregisterConnectorServer(JobContext) - Method in class org.jmonks.batch.framework.management.jmxmp.RepositoryJMXMPConnectorHelper

Unregisters the jmx connector server registered in repository with the job name available in job context.

unregisterJobMgmtMntrInfo() - Method in class org.jmonks.batch.framework.Repository

Unregisters the job management and monitoring information assosciated with this job.

unregisterJobMgmtMntrInfo() - Method in class org.jmonks.batch.framework.repository.db4o.Db4oRepository

unregisterJobMgmtMntrInfo() - Method in class org.jmonks.batch.framework.repository.jdbc.JdbcRepository

X

XMLBasicJobControllerConfig - class org.jmonks.batch.framework.config.xml.XMLBasicJobControllerConfig.

XMLBasicJobControllerConfig loads the XML job controller configuration.

XMLBasicJobControllerConfig(Element) - Constructor for class org.jmonks.batch.framework.config.xml.XMLBasicJobControllerConfig

Loads the XML job controller configuration into XMLBasicJobControllerConfig object.

XMLJobConfig - class org.jmonks.batch.framework.config.xml.XMLJobConfig.

XMLJobConfig provides the implementation of JobConfig by reading the job configuration from XML DOM element <job-config> configured in the job configuration file.

XMLJobConfigFactory - class org.jmonks.batch.framework.config.xml.XMLJobConfigFactory.

XMLJobConfigFactory reads the job configuration from XML file to create the configuration objects needed by the job.

XMLJobConfigFactory() - Constructor for class org.jmonks.batch.framework.config.xml.XMLJobConfigFactory

Do not use this constructor to instantiate XMLJobConfigFactory directly.

XMLJobControllerConfig - class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig.

XMLJobControllerConfig responsible to build the controller specific JobControllerConfig objects from the given XML.

XMLJobControllerConfig() - Constructor for class org.jmonks.batch.framework.config.xml.XMLJobControllerConfig

XMLJobLoggingConfig - class org.jmonks.batch.framework.config.xml.XMLJobLoggingConfig.

Reads the job logging configuration from the XML job configuration file.

XMLJobLoggingConfig(Element) - Constructor for class org.jmonks.batch.framework.config.xml.XMLJobLoggingConfig

Loads the job logging config object from the input element represents job-logging-config element.

XMLPoolJobControllerConfig - class org.jmonks.batch.framework.config.xml.XMLPoolJobControllerConfig.

XMLPoolJobControllerConfig loads the controller configuration from XML Job controller configuration.

XMLPoolJobControllerConfig(Element) - Constructor for class org.jmonks.batch.framework.config.xml.XMLPoolJobControllerConfig

Loads the XMLPoolJobControllerConfig from XML DOM Element <job-controller>

A B C D E F G H I J L M O P R S T U X