org.jboss.system.server
Interface ServerConfig

All Known Implementing Classes:

ServerConfigImpl

public interface ServerConfig

The interface of the basic typed JBoss server configuration.

Clients should use ServerConfigLocator to get an instance of ServerConfig and then use it to get the server's configuration bits.

Version:

$Revision: 1.13.4.8 $

Author:

Jason Dillon, Scott.Stark@jboss.org

Field Summary

static String	BLOCKING_SHUTDOWN Constant that holds the name of the environment property for specifying whether or not the server should shutdown synchronously (true) or asynchronously (false).
static String	BOOT_LIBRARY_LIST Constant that holds the name of the environment property for specifying a comma seperated list of the basenames of to the boot libraries required load the core system.
static boolean	DEFAULT_BLOCKING_SHUTDOWN The default value for BLOCKING_SHUTDOWN.
static boolean	DEFAULT_EXIT_ON_SHUTDOWN The default value for EXIT_ON_SHUTDOWN.
static String	DEFAULT_PARITION_NAME The default partition name
static boolean	DEFAULT_PLATFORM_MBEANSERVER The default value for PLATFORM_MBEANSERVER.
static boolean	DEFAULT_REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY The default value for REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY.
static String	DEFAULT_ROOT_DEPLOYMENT_FILENAME The default value for ROOT_DEPLOYMENT_FILENAME.
static String	DEFAULT_SERVER_NAME The default value for SERVER_NAME.
static String	EXIT_ON_SHUTDOWN Constant that holds the name of the environment property for specifying whether or not the server should exit the JVM on shutdown.
static String	HOME_DIR Constant that holds the name of the environment property for specifying the home directory for JBoss.
static String	HOME_URL Constant that holds the name of the environment property for specifying the home URL for JBoss.
static String	LIBRARY_URL Constant that holds the name of the environment property for specifying the URL where JBoss will read library files from.
static String	LIBRARY_URL_SUFFIX The suffix used when generating the default value for LIBRARY_URL and SERVER_LIBRARY_URL.
static String	NATIVE_DIR_PROPERTY The location of native libraries property
static String	NATIVE_LOAD_PROPERTY Whether to load native libraries
static String	PARTITION_NAME_PROPERTY The partition name property
static String	PARTITION_UDP_PROPERTY The udp address property
static String	PATCH_URL Constant that holds the name of the environment property for specifying the URL where JBoss will read patch library files from.
static String	PLATFORM_MBEANSERVER Constant that holds the name of the environment property for specifying whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+
static String	REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY Constant that holds the name of the environment property for specifying whether or not the server should log and ignore exceptions when setting the URLStreamHandlerFactory.
static String	ROOT_DEPLOYMENT_FILENAME Constant that holds the name of the environment property for specifying the root deployment filename (relative to the server config URL that will be deployed to finalize the boot strap process.
static String	SERVER_BASE_DIR Constant that holds the name of the environment property for specifying the base directory for calculating server home directories.
static String	SERVER_BASE_DIR_SUFFIX The suffix used when generating the default value for SERVER_BASE_DIR.
static String	SERVER_BASE_URL Constant that holds the name of the environment property for specifying the base URL for calculating server home URLs.
static String	SERVER_BASE_URL_SUFFIX The suffix used when generating the default value for SERVER_BASE_URL.
static String	SERVER_BIND_ADDRESS Constant that holds the name of the environment property for specifying the bind address for all jboss services
static String	SERVER_CONFIG_URL Constant that holds the name of the environment property for specifying the server configuration URL.
static String	SERVER_CONFIG_URL_SUFFIX The suffix used when generating the default value for SERVER_CONFIG_URL.
static String	SERVER_DATA_DIR Constant that holds the name of the environment property for specifying the directory which JBoss will use for persistent data file storage.
static String	SERVER_DATA_DIR_SUFFIX The suffix used when generating the default value for SERVER_DATA_DIR.
static String	SERVER_HOME_DIR Constant that holds the name of the environment property for specifying the server home directory for JBoss.
static String	SERVER_HOME_URL Constant that holds the name of the environment property for specifying the server home URL for JBoss.
static String	SERVER_LIBRARY_URL Constant that holds the name of the environment property for specifying the URL where JBoss will read server specific library files from.
static String	SERVER_LOG_DIR Constant that holds the name of the environment property for specifying the server log directory for JBoss.
static String	SERVER_LOG_DIR_SUFFIX The suffix used when generating the default value for SERVER_LOG_DIR.
static String	SERVER_NAME Constant that holds the name of the environment property for specifying the name of the server which will be used to calculate the servers home directory and url.
static String	SERVER_TEMP_DIR Constant that holds the name of the environment property for specifying the directory which JBoss will use for temporary file storage.
static String	SERVER_TEMP_DIR_SUFFIX The suffix used when generating the default value for SERVER_TEMP_DIR.
static String	SERVER_TYPE Constant that holds the name of the environment property for specifying the class type of the server to create.

Method Summary

boolean	getBlockingShutdown() Get the BlockingShutdown value.
boolean	getExitOnShutdown() Get the current value of the exit on shutdown flag.
File	getHomeDir() Get the local home directory which the server is running from.
URL	getHomeURL() Get the home URL which the server is running from.
URL	getLibraryURL() Get the library URL for the server.
URL	getPatchURL() Get the patch URL for the server.
boolean	getPlatformMBeanServer() Get the current value of the flag that indicates if we are using the platform MBeanServer as the main jboss server.
boolean	getRequireJBossURLStreamHandlerFactory() Get the RequireJBossURLStreamHandlerFactory value.
String	getRootDeploymentFilename() Get the filename of the root deployable that will be used to finalize the bootstrap process.
File	getServerBaseDir() Get the base directory for calculating server home directories.
URL	getServerBaseURL() Get the base directory for calculating server home URLs.
URL	getServerConfigURL() Get the server configuration URL.
File	getServerDataDir() Get the directory where local data will be stored.
File	getServerHomeDir() Get the server home directory.
URL	getServerHomeURL() Get the server home URL.
URL	getServerLibraryURL() Get the server library URL.
File	getServerLogDir() Get the directory where log files will be stored.
String	getServerName() Get the name of the server.
File	getServerNativeDir() Get the native dir for unpacking
File	getServerTempDeployDir() Get the temporary deployment dir for unpacking
File	getServerTempDir() Get the directory where temporary files will be stored.
void	setBlockingShutdown(boolean blockingShutdown) Set the BlockingShutdown value.
void	setExitOnShutdown(boolean flag) Enable or disable exiting the JVM when Server.shutdown() is called.
void	setRequireJBossURLStreamHandlerFactory(boolean requireJBossURLStreamHandlerFactory) Set the RequireJBossURLStreamHandlerFactory value.
void	setRootDeploymentFilename(String filename) Set the filename of the root deployable that will be used to finalize the bootstrap process.

Field Detail

DEFAULT_PARITION_NAME

static final String DEFAULT_PARITION_NAME

The default partition name

See Also:

Constant Field Values

PARTITION_NAME_PROPERTY

static final String PARTITION_NAME_PROPERTY

The partition name property

See Also:

Constant Field Values

PARTITION_UDP_PROPERTY

static final String PARTITION_UDP_PROPERTY

The udp address property

See Also:

Constant Field Values

NATIVE_LOAD_PROPERTY

static final String NATIVE_LOAD_PROPERTY

Whether to load native libraries

See Also:

Constant Field Values

NATIVE_DIR_PROPERTY

static final String NATIVE_DIR_PROPERTY

The location of native libraries property

See Also:

Constant Field Values

BOOT_LIBRARY_LIST

static final String BOOT_LIBRARY_LIST

Constant that holds the name of the environment property for specifying a comma seperated list of the basenames of to the boot libraries required load the core system.

These libraries will be loaded from LIBRARY_URL.

See Also:

Constant Field Values

SERVER_TYPE

static final String SERVER_TYPE

Constant that holds the name of the environment property for specifying the class type of the server to create.

See Also:

Constant Field Values

ROOT_DEPLOYMENT_FILENAME

static final String ROOT_DEPLOYMENT_FILENAME

Constant that holds the name of the environment property for specifying the root deployment filename (relative to the server config URL that will be deployed to finalize the boot strap process.

If not set then the server will default to DEFAULT_ROOT_DEPLOYMENT_FILENAME.

See Also:

Constant Field Values

HOME_DIR

static final String HOME_DIR

Constant that holds the name of the environment property for specifying the home directory for JBoss.

See Also:

Constant Field Values

HOME_URL

static final String HOME_URL

Constant that holds the name of the environment property for specifying the home URL for JBoss.

If not set then the value of HOME_DIR will converted into a URL.

See Also:

Constant Field Values

LIBRARY_URL

static final String LIBRARY_URL

Constant that holds the name of the environment property for specifying the URL where JBoss will read library files from.

Defaults to HOME_URL/lib/

See Also:

Constant Field Values

PATCH_URL

static final String PATCH_URL

Constant that holds the name of the environment property for specifying the URL where JBoss will read patch library files from.

If this value is a file URL, then all .zip and .jar files inside will be prepended to the classpath. Otherwise the URL will be added to the classpath. If not set then the no patch files will be loaded.

See Also:

Constant Field Values

SERVER_NAME

static final String SERVER_NAME

Constant that holds the name of the environment property for specifying the name of the server which will be used to calculate the servers home directory and url.

Defaults to default.

See Also:

Constant Field Values

SERVER_BASE_DIR

static final String SERVER_BASE_DIR

Constant that holds the name of the environment property for specifying the base directory for calculating server home directories.

Defaults to HOME_DIR/server.

See Also:

Constant Field Values

SERVER_HOME_DIR

static final String SERVER_HOME_DIR

Constant that holds the name of the environment property for specifying the server home directory for JBoss.

Defaults to SERVER_BASE_DIR/SERVER_NAME.

See Also:

Constant Field Values

SERVER_LOG_DIR

static final String SERVER_LOG_DIR

Constant that holds the name of the environment property for specifying the server log directory for JBoss.

Defaults to SERVER_HOME_DIR/log.

See Also:

Constant Field Values

SERVER_TEMP_DIR

static final String SERVER_TEMP_DIR

Constant that holds the name of the environment property for specifying the directory which JBoss will use for temporary file storage.

Defaults to SERVER_HOME_DIR/tmp .

See Also:

Constant Field Values

SERVER_DATA_DIR

static final String SERVER_DATA_DIR

Constant that holds the name of the environment property for specifying the directory which JBoss will use for persistent data file storage.

Defaults to SERVER_HOME_DIR/data.

See Also:

Constant Field Values

SERVER_BASE_URL

static final String SERVER_BASE_URL

Constant that holds the name of the environment property for specifying the base URL for calculating server home URLs.

Defaults to HOME_URL/server.

See Also:

Constant Field Values

SERVER_HOME_URL

static final String SERVER_HOME_URL

Constant that holds the name of the environment property for specifying the server home URL for JBoss.

Defaults to SERVER_BASE_URL/SERVER_NAME.

See Also:

Constant Field Values

SERVER_CONFIG_URL

static final String SERVER_CONFIG_URL

Constant that holds the name of the environment property for specifying the server configuration URL.

Defaults to SERVER_HOME_UTL/conf .

See Also:

Constant Field Values

SERVER_LIBRARY_URL

static final String SERVER_LIBRARY_URL

Constant that holds the name of the environment property for specifying the URL where JBoss will read server specific library files from.

Defaults to SERVER_HOME_URL/lib/

See Also:

Constant Field Values

SERVER_BIND_ADDRESS

static final String SERVER_BIND_ADDRESS

Constant that holds the name of the environment property for specifying the bind address for all jboss services

See Also:

Constant Field Values

EXIT_ON_SHUTDOWN

static final String EXIT_ON_SHUTDOWN

Constant that holds the name of the environment property for specifying whether or not the server should exit the JVM on shutdown.

If not set then the server will default to exiting on shutdown.

See Also:

Constant Field Values

BLOCKING_SHUTDOWN

static final String BLOCKING_SHUTDOWN

Constant that holds the name of the environment property for specifying whether or not the server should shutdown synchronously (true) or asynchronously (false).

If not set then the server will default to asynchronous shutdown.

See Also:

Constant Field Values

REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY

static final String REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY

Constant that holds the name of the environment property for specifying whether or not the server should log and ignore exceptions when setting the URLStreamHandlerFactory.

If not set then the server will default to asynchronous shutdown.

See Also:

Constant Field Values

PLATFORM_MBEANSERVER

static final String PLATFORM_MBEANSERVER

Constant that holds the name of the environment property for specifying whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+

If not set then jboss will instantiate its own MBeanServer

See Also:

Constant Field Values

LIBRARY_URL_SUFFIX

static final String LIBRARY_URL_SUFFIX

The suffix used when generating the default value for LIBRARY_URL and SERVER_LIBRARY_URL.

See Also:

Constant Field Values

SERVER_CONFIG_URL_SUFFIX

static final String SERVER_CONFIG_URL_SUFFIX

The suffix used when generating the default value for SERVER_CONFIG_URL.

See Also:

Constant Field Values

SERVER_BASE_DIR_SUFFIX

static final String SERVER_BASE_DIR_SUFFIX

The suffix used when generating the default value for SERVER_BASE_DIR.

See Also:

Constant Field Values

SERVER_BASE_URL_SUFFIX

static final String SERVER_BASE_URL_SUFFIX

The suffix used when generating the default value for SERVER_BASE_URL.

See Also:

Constant Field Values

SERVER_DATA_DIR_SUFFIX

static final String SERVER_DATA_DIR_SUFFIX

The suffix used when generating the default value for SERVER_DATA_DIR.

See Also:

Constant Field Values

SERVER_LOG_DIR_SUFFIX

static final String SERVER_LOG_DIR_SUFFIX

The suffix used when generating the default value for SERVER_LOG_DIR.

See Also:

Constant Field Values

SERVER_TEMP_DIR_SUFFIX

static final String SERVER_TEMP_DIR_SUFFIX

The suffix used when generating the default value for SERVER_TEMP_DIR.

See Also:

Constant Field Values

DEFAULT_SERVER_NAME

static final String DEFAULT_SERVER_NAME

The default value for SERVER_NAME.

See Also:

Constant Field Values

DEFAULT_EXIT_ON_SHUTDOWN

static final boolean DEFAULT_EXIT_ON_SHUTDOWN

The default value for EXIT_ON_SHUTDOWN.

See Also:

Constant Field Values

DEFAULT_BLOCKING_SHUTDOWN

static final boolean DEFAULT_BLOCKING_SHUTDOWN

The default value for BLOCKING_SHUTDOWN.

See Also:

Constant Field Values

DEFAULT_REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY

static final boolean DEFAULT_REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY

The default value for REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY.

See Also:

Constant Field Values

DEFAULT_PLATFORM_MBEANSERVER

static final boolean DEFAULT_PLATFORM_MBEANSERVER

The default value for PLATFORM_MBEANSERVER.

See Also:

Constant Field Values

DEFAULT_ROOT_DEPLOYMENT_FILENAME

static final String DEFAULT_ROOT_DEPLOYMENT_FILENAME

The default value for ROOT_DEPLOYMENT_FILENAME.

See Also:

Constant Field Values

Method Detail

getHomeDir

File getHomeDir()

Get the local home directory which the server is running from.

Returns:

The local server home directory.

getHomeURL

URL getHomeURL()

Get the home URL which the server is running from.

Returns:

The home URL which the server is running from.

getLibraryURL

URL getLibraryURL()

Get the library URL for the server.

Returns:

The library URL for the server.

getPatchURL

URL getPatchURL()

Get the patch URL for the server.

Returns:

The patch URL for the server.

getServerName

String getServerName()

Get the name of the server.

Returns:

The name of the server.

getServerBaseDir

File getServerBaseDir()

Get the base directory for calculating server home directories.

Returns:

Base server home directory.

getServerHomeDir

File getServerHomeDir()

Get the server home directory.

Returns:

Server home directory.

getServerLogDir

File getServerLogDir()

Get the directory where log files will be stored.

Returns:

The directory where the server writes log files.

getServerTempDir

File getServerTempDir()

Get the directory where temporary files will be stored.

Returns:

The directory where the server stores temporary files.

getServerDataDir

File getServerDataDir()

Get the directory where local data will be stored.

Returns:

The directory where the server stores local data.

getServerBaseURL

URL getServerBaseURL()

Get the base directory for calculating server home URLs.

Returns:

Base server home URL.

getServerHomeURL

URL getServerHomeURL()

Get the server home URL.

Returns:

Server home URL.

getServerLibraryURL

URL getServerLibraryURL()

Get the server library URL.

Returns:

Server library URL.

getServerConfigURL

URL getServerConfigURL()

Get the server configuration URL.

Returns:

Server configuration URL.

getServerNativeDir

File getServerNativeDir()

Get the native dir for unpacking

Returns:

the directory

getServerTempDeployDir

File getServerTempDeployDir()

Get the temporary deployment dir for unpacking

Returns:

the directory

getPlatformMBeanServer

boolean getPlatformMBeanServer()

Get the current value of the flag that indicates if we are using the platform MBeanServer as the main jboss server. Both the ServerConfig.PLATFORM_MBEANSERVER property must be set, and the jvm must be jdk1.5+

Returns:

true if jboss runs on the jvm platfrom MBeanServer

setExitOnShutdown

void setExitOnShutdown(boolean flag)

Enable or disable exiting the JVM when Server.shutdown() is called. If enabled, then shutdown calls Server.exit(int). If disabled, then only the shutdown hook will be run.

Parameters:

flag - True to enable calling exit on shutdown.

getExitOnShutdown

boolean getExitOnShutdown()

Get the current value of the exit on shutdown flag.

Returns:

The current value of the exit on shutdown flag.

getBlockingShutdown

boolean getBlockingShutdown()

Get the BlockingShutdown value.

Returns:

the BlockingShutdown value.

setBlockingShutdown

void setBlockingShutdown(boolean blockingShutdown)

Set the BlockingShutdown value.

Parameters:

blockingShutdown - The new BlockingShutdown value.

getRequireJBossURLStreamHandlerFactory

boolean getRequireJBossURLStreamHandlerFactory()

Get the RequireJBossURLStreamHandlerFactory value.

Returns:

the RequireJBossURLStreamHandlerFactory value.

setRequireJBossURLStreamHandlerFactory

void setRequireJBossURLStreamHandlerFactory(boolean requireJBossURLStreamHandlerFactory)

Set the RequireJBossURLStreamHandlerFactory value.

Parameters:

requireJBossURLStreamHandlerFactory - The new RequireJBossURLStreamHandlerFactory value.

setRootDeploymentFilename

void setRootDeploymentFilename(String filename)

Set the filename of the root deployable that will be used to finalize the bootstrap process.

Parameters:

filename - The filename of the root deployable.

getRootDeploymentFilename

String getRootDeploymentFilename()

Get the filename of the root deployable that will be used to finalize the bootstrap process.

Returns:

The filename of the root deployable.