com.sibvisions.rad.server.config
Class Configuration

java.lang.Object
  com.sibvisions.rad.server.config.Configuration

public final class Configuration
extends Object

The Configuration enables the access to the server zone and all available application zones. The zones are organized in following directories:

 <CONFIG-DIRECTORY>
 |- apps                   (applications directory)
    |- <application name>  (application zone) (application directory - case sensitive)
       |- src              (source files)
       |- libs             (additional libraries)
       |- classes          (compiled sources)
       |- config.xml       (application configuration file)
 |- server                 (server zone) (server directory)
    |- config.xml          (server configuration file)
 

Nested Class Summary

static class

Configuration.ApplicationListOption Application name restriction.

Method Summary

static File	getApplicationsDir() Returns the directory with the applications.
static ApplicationZone	getApplicationZone(String sApplicationName) Returns the current zone for an application.
static AppSettings	getAppSettings() Gets the application settings.
static File	getConfigurationDir() Returns the directory with the configuration files.
static File	getServerDir() Returns the server directory.
static ServerZone	getServerZone() Returns the server zone.
static boolean	isApplication(String pApplicationName) Checks if a given application name exists as application.
static List<String>	listApplicationNames(Configuration.ApplicationListOption pListOption) Gets a list of all available application names.

Methods inherited from class java.lang.Object

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

Method Detail

getConfigurationDir

public static File getConfigurationDir()

Returns the directory with the configuration files.

Returns:

the configuration directory

getApplicationsDir

public static File getApplicationsDir()

Returns the directory with the applications.

Returns:

the applications directory

getServerDir

public static File getServerDir()

Returns the server directory.

Returns:

the server directory

getApplicationZone

public static ApplicationZone getApplicationZone(String sApplicationName)
                                          throws Exception

Returns the current zone for an application.

Parameters:

sApplicationName - the desired application

Returns:

the zone for the application of null if the application is not available

Throws:

Exception - if the application zone has errors

getServerZone

public static ServerZone getServerZone()
                                throws Exception

Returns the server zone.

Returns:

the server zone

Throws:

Exception - if the server zone has errors

listApplicationNames

public static List<String> listApplicationNames(Configuration.ApplicationListOption pListOption)

Gets a list of all available application names. This method doesn't check if applications are valid.

Parameters:

pListOption - an option to ignore/list specific applications

Returns:

a list of available application names

isApplication

public static boolean isApplication(String pApplicationName)

Checks if a given application name exists as application.

Parameters:

pApplicationName - an application name

Returns:

true if the application is available and is valid (configuration is available), false otherwise

getAppSettings

public static AppSettings getAppSettings()

Gets the application settings.

Returns:

the application settings