toolbox.services
Class EnvironmentConfig

Package class diagram package EnvironmentConfig
java.lang.Object
  extended by toolbox.services.EnvironmentConfig

 class EnvironmentConfig
extends java.lang.Object

Package protected class to store the configuration of a service environment for the default service registry.


Constructor Summary
EnvironmentConfig(java.lang.String envHome, java.lang.String name, java.lang.String clazz, boolean relative, boolean svcClassLdr, java.lang.String config)
          Create a new environment config.
 
Method Summary
(package private)  java.lang.String getClassName()
          Return the name of the environment implementation class.
(package private)  java.lang.String getConfigHome()
          Return the environment configuration home.
(package private)  java.lang.String getConfigPath()
          Return the location of the environment configuration.
(package private)  java.lang.String getName()
          Return the name of the environment.
(package private)  boolean isConfigRelative()
          Return the flag to indicate whether the environment configuration is relative to the configuration home directory.
(package private)  boolean useServiceClassLoader()
          Return the flag indicating whether the environment class must be loaded using the service class loader.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnvironmentConfig

EnvironmentConfig(java.lang.String envHome,
                  java.lang.String name,
                  java.lang.String clazz,
                  boolean relative,
                  boolean svcClassLdr,
                  java.lang.String config)
            throws ServiceException
Create a new environment config.

Parameters:
envHome - String containing the environments home directory path.
name - String containing the name of the environment.
clazz - String containing the class name of the environment implementation.
relative - Primitive boolean indicating whether the environment configuratio is relative to the environment home directory.
svcClassLdr - Primitive boolean indicating whether the environment class must be loaded using the the service class loader.
config - String containing the path to the environment config.
Throws:
ServiceException - if the configuration cannot be created.
Method Detail

getName

java.lang.String getName()
Return the name of the environment.

Returns:
String containing name of the environment.

getConfigHome

java.lang.String getConfigHome()
Return the environment configuration home.

Returns:
String containing the environment configuration home.

isConfigRelative

boolean isConfigRelative()
Return the flag to indicate whether the environment configuration is relative to the configuration home directory.

Returns:
boolean

useServiceClassLoader

boolean useServiceClassLoader()
Return the flag indicating whether the environment class must be loaded using the service class loader.

Returns:
boolean

getConfigPath

java.lang.String getConfigPath()
Return the location of the environment configuration.

If the configuration is relative, the configuration home value will be pre-pended.

Returns:
String containing configuration path.

getClassName

java.lang.String getClassName()
Return the name of the environment implementation class.

Returns:
String containing name of environment implementation class.