org.jmonks.batch.framework.config
Class FrameworkConfig

java.lang.Object
  extended byorg.jmonks.batch.framework.config.FrameworkConfig

public final class FrameworkConfig
extends java.lang.Object

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. This searches the classpath for the framework-config.xml. Place this file in any directory and keep the directory in the classpath.

Since:
1.0
Version:
1.0
Author:
Suresh Pragada

Nested Class Summary
 class FrameworkConfig.FrameworkLoggingConfig
           FrameworkLoggingConfig class holds configuration required to enable the framework logging by LoggingManager.
 class FrameworkConfig.JobConfigFactoryConfig
           JobConfigFactoryConfig class holds the configuration information required by Job configuration factories.
 class FrameworkConfig.JobConnectorConfig
           JobConnectorConfig class holds the configuration required to create the JobConnectorHelper classes used in establishing the job management agent and clients.
 class FrameworkConfig.JobControllerConfig
           ControllerConfig holds the configuration related to the controller components.
 class 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.
 
Method Summary
 FrameworkConfig.FrameworkLoggingConfig getFrameworkLoggingConfig()
          Returns the logging configuration defined in the framework configuration as a FrameworkLoggingConfig object.
static FrameworkConfig getInstance()
          Returns the FrameworkConfig instance.
 FrameworkConfig.JobConfigFactoryConfig getJobConfigFactoryConfig()
          Returns the job configuration factory configuration defined in framework configuration as JobConfigFactoryConfig object.
 FrameworkConfig.JobConnectorConfig getJobConnectorConfig()
          Returns the mgmt&mntr configuration defines in the framework configuration as JobConnectorConfig object.
 FrameworkConfig.JobControllerConfig getJobControllerConfig()
          Returns the job controller configuration defined in framework configuration as a JobControllerConfig object.
 FrameworkConfig.RepositoryConfig getRepositoryConfig()
          Returns the repository configuration defined in framework configuration as a RepositoryConfig object.
 java.lang.String toString()
           Returns the string representation of FrameworkConfig class in the format
{FrameworkConfig [jobConfigFactoryConfig = value] [frameworkLoggingConfig = value] [jobConnectorConfig = value] [repositoryConfig = value][controllerConfig = value]}
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static FrameworkConfig getInstance()
Returns the FrameworkConfig instance.

Returns:
Returns the FrameworkConfig instance.

getJobConfigFactoryConfig

public FrameworkConfig.JobConfigFactoryConfig getJobConfigFactoryConfig()
Returns the job configuration factory configuration defined in framework configuration as JobConfigFactoryConfig object.

Returns:
Returns the JobConfigFactoryConfig object.

getFrameworkLoggingConfig

public FrameworkConfig.FrameworkLoggingConfig getFrameworkLoggingConfig()
Returns the logging configuration defined in the framework configuration as a FrameworkLoggingConfig object.

Returns:
Returns the FrameworkLoggingConfig object.

getJobConnectorConfig

public FrameworkConfig.JobConnectorConfig getJobConnectorConfig()
Returns the mgmt&mntr configuration defines in the framework configuration as JobConnectorConfig object.

Returns:
Returns the JobConnectorConfig object.

getRepositoryConfig

public FrameworkConfig.RepositoryConfig getRepositoryConfig()
Returns the repository configuration defined in framework configuration as a RepositoryConfig object.

Returns:
Returns the RepositoryConfig object.

getJobControllerConfig

public FrameworkConfig.JobControllerConfig getJobControllerConfig()
Returns the job controller configuration defined in framework configuration as a JobControllerConfig object.

Returns:
Returns the JobControllerConfig object.

toString

public java.lang.String toString()

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

Returns:
Returns the string representation of FrameworkConfig.