com.gigaspaces.start

Class SystemConfig

java.lang.Object

com.gigaspaces.start.SystemConfig

public class SystemConfig
extends Object

Provides system configuration support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemConfig.JMXServiceDescriptor Initialize RMI Registry and JMX Platform MBeanServer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODESERVER System property set indicating the address and port of the Webster instance created by this utility, in the form of :

Method Summary

Modifier and Type	Method and Description
static String[]	appendOverrides(String configFile) If this utility has been started with override arguments, append the override arguments to the configuration file
static String	getBuildNumber() Get the build number from the PlatformVersion.
Configuration	getConfiguration() Get the Configuration created by this utility
String[]	getConfigurationParms() Get the configuration parameters used to create this utility.
ServiceDescriptor	getESMServiceDescriptor() Get the ServiceDescriptor for the ESM
ServiceDescriptor	getGSAServiceDescriptor()
ServiceDescriptor	getGSCServiceDescriptor() Get the ServiceDescriptor for the GSC
ServiceDescriptor	getGSMServiceDescriptor() Get the ServiceDescriptor for the GSM
ServiceDescriptor	getGSServiceDescriptor() Get the ServiceDescriptor for the GigaSpaces service
String	getHomeDir()
static SystemConfig	getInstance() Get an instance of the SystemConfig object that has been previously created with configuration arguments.
static SystemConfig	getInstance(String[] configArgs) Get an instance of the SystemConfig object
ServiceDescriptor	getJMXServiceDescriptor() Get the ServiceDescriptor to start JMX
ServiceDescriptor	getLookupHandlerServiceDescriptor() Get the ServiceDescriptor for LookupHandler.
ServiceDescriptor	getMahaloServiceDescriptor() Get the ServiceDescriptor for Mahalo transaction manager
String[]	getOverrides() Get the configuration overrides this utility was created with
URL[]	getPlatformJars() Get the platformJars
Collection<ServiceDescriptor>	getServiceDescriptors(String[] keys) Get ServiceDescriptor instances for the following keys
Properties	getSystemProperties() Get configured system properties
static String	getVersionInfo()
static String	getVersionNumber() Get the version number from the PlatformVersion.
Webster	getWebster() Create a Webster instance
int	getWebsterPort()
String	getWebsterProtocol()

Methods inherited from class java.lang.Object

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

Field Detail

CODESERVER

public static final String CODESERVER

System property set indicating the address and port of the Webster instance created by this utility, in the form of :

http://address:port

See Also:

Constant Field Values

Method Detail

getInstance

public static SystemConfig getInstance(String[] configArgs)
                                throws ConfigurationException

Get an instance of the SystemConfig object

Parameters:

configArgs - An array whose first element is the location of the configuration source and remaining elements specify override values for entries that will be used to create the SystemConfig singleton for the system. If the SystemConfig instance has already been created this parameter is optional

Returns:

The SystemConfig instance

Throws:

ConfigurationException

getInstance

public static SystemConfig getInstance()

Get an instance of the SystemConfig object that has been previously created with configuration arguments. This is a utilty method for clients to obtain the previously created SystemConfig instance

Returns:

The SystemConfig instance. If the SystemConfig instance has not been previously created usng a configurationwhen this method is called, a RuntimeException is thrown

getHomeDir

public String getHomeDir()

getConfigurationParms

public String[] getConfigurationParms()

Get the configuration parameters used to create this utility. If this utility was created with no (or null) parameters, a zero-length String array will be returned

getConfiguration

public Configuration getConfiguration()

Get the Configuration created by this utility

appendOverrides

public static String[] appendOverrides(String configFile)

If this utility has been started with override arguments, append the override arguments to the configuration file

Parameters:

configFile - The file to append to, this parameter must not be null

Returns:

A String array, with the first element being the configFile parameter, each subsequent element a corresponding override argument this utility was started with. If there are no override arguments, the array will contain only the configFile parameter.

getOverrides

public String[] getOverrides()

Get the configuration overrides this utility was created with

Returns:

The configuration overrides this utility was created with. If no configuration overrides were provided, this method returns null

getPlatformJars

public URL[] getPlatformJars()
                      throws MalformedURLException,
                             ConfigurationException

Get the platformJars

Returns:

URL[] An array of URL resources indicating the jars the common ClassLoader must add.

Throws:

MalformedURLException - If the URL resources result in an improperly formatted URL

ConfigurationException - If there are errors accessing the configuration

getSystemProperties

public Properties getSystemProperties()
                               throws ConfigurationException,
                                      UnknownHostException

Get configured system properties

Throws:

ConfigurationException

UnknownHostException

getWebsterProtocol

public String getWebsterProtocol()

getWebsterPort

public int getWebsterPort()

getWebster

public Webster getWebster()
                   throws BindException,
                          ConfigurationException,
                          UnknownHostException

Create a Webster instance

Returns:

A Webster instance

Throws:

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration

UnknownHostException

getLookupHandlerServiceDescriptor

public ServiceDescriptor getLookupHandlerServiceDescriptor()
                                                    throws BindException,
                                                           UnknownHostException,
                                                           ConfigurationException

Get the ServiceDescriptor for LookupHandler.

Returns:

A ServiceDescriptor suitable for the creation of the lookup handler

Throws:

UnknownHostException - If the codebase cannot be constructed

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getMahaloServiceDescriptor

public ServiceDescriptor getMahaloServiceDescriptor()
                                             throws BindException,
                                                    UnknownHostException,
                                                    ConfigurationException

Get the ServiceDescriptor for Mahalo transaction manager

Returns:

A ServiceDescriptor suitable for the creation of the Mahalo transaction manager

Throws:

UnknownHostException - If the codebase cannot be constructed

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getServiceDescriptors

public Collection<ServiceDescriptor> getServiceDescriptors(String[] keys)
                                                    throws BindException,
                                                           UnknownHostException,
                                                           ConfigurationException

Get ServiceDescriptor instances for the following keys

Parameters:

keys - Array of String values that map to ServiceDescriptor definitions for the Grid Service Container, Grid Service Monitor pr GigaSpaces

Returns:

An Collection of ServiceDescriptor instances that can be used to start services. A new Collection is allocated each time. If no matching services are found, a zero-lengh Collection is returned.

Throws:

BindException

UnknownHostException

ConfigurationException

getGSAServiceDescriptor

public ServiceDescriptor getGSAServiceDescriptor()
                                          throws UnknownHostException,
                                                 ConfigurationException

Throws:

UnknownHostException

ConfigurationException

getGSCServiceDescriptor

public ServiceDescriptor getGSCServiceDescriptor()
                                          throws UnknownHostException,
                                                 BindException,
                                                 ConfigurationException

Get the ServiceDescriptor for the GSC

Throws:

IllegalArgumentException - if the root or gsLib directories do not exist or cannot be read from

UnknownHostException - If the codebase cannot be constructed

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getGSMServiceDescriptor

public ServiceDescriptor getGSMServiceDescriptor()
                                          throws UnknownHostException,
                                                 BindException,
                                                 ConfigurationException

Get the ServiceDescriptor for the GSM

Throws:

IllegalArgumentException - if the root or gsLib directories do not exist or cannot be read from

UnknownHostException - If the codebase cannot be constructed

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getESMServiceDescriptor

public ServiceDescriptor getESMServiceDescriptor()
                                          throws UnknownHostException,
                                                 BindException,
                                                 ConfigurationException

Get the ServiceDescriptor for the ESM

Throws:

UnknownHostException

BindException

ConfigurationException

getJMXServiceDescriptor

public ServiceDescriptor getJMXServiceDescriptor()
                                          throws ConfigurationException

Get the ServiceDescriptor to start JMX

Throws:

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getGSServiceDescriptor

public ServiceDescriptor getGSServiceDescriptor()
                                         throws UnknownHostException,
                                                BindException,
                                                ConfigurationException

Get the ServiceDescriptor for the GigaSpaces service

Throws:

IllegalArgumentException - if the root or gsLib directories do not exist or cannot be read from

UnknownHostException - If the codebase cannot be constructed

BindException - If the Webster instance could not be created

ConfigurationException - If errors occur reading the configuration or the default configuration file cannot be located

getVersionInfo

public static String getVersionInfo()

getBuildNumber

public static String getBuildNumber()

Get the build number from the PlatformVersion. If the PlatformVersion class cannot be loaded, and empty string is returned

getVersionNumber

public static String getVersionNumber()

Get the version number from the PlatformVersion. If the PlatformVersion class cannot be loaded, and empty string is returned