|
||||||||||
PREV CLASS (src) NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface of the basic typed JBoss server configuration.
Clients should use ServerConfigLocator
(src) to get an instance of
ServerConfig
(src) and then use it to get the server's configuration bits.
Field Summary | |
static java.lang.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 java.lang.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 java.lang.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 java.lang.String |
DEFAULT_ROOT_DEPLOYMENT_FILENAME
The default value for ROOT_DEPLOYMENT_FILENAME . |
static java.lang.String |
DEFAULT_SERVER_NAME
The default value for SERVER_NAME . |
static java.lang.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 java.lang.String |
HOME_DIR
Constant that holds the name of the environment property for specifying the home directory for JBoss. |
static java.lang.String |
HOME_URL
Constant that holds the name of the environment property for specifying the home URL for JBoss. |
static java.lang.String |
LIBRARY_URL
Constant that holds the name of the environment property for specifying the URL where JBoss will read library files from. |
static java.lang.String |
LIBRARY_URL_SUFFIX
The suffix used when generating the default value for LIBRARY_URL
and SERVER_LIBRARY_URL . |
static java.lang.String |
NATIVE_DIR_PROPERTY
The location of native libraries property |
static java.lang.String |
NATIVE_LOAD_PROPERTY
Whether to load native libraries |
static java.lang.String |
PARTITION_NAME_PROPERTY
The partition name property |
static java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String |
SERVER_BASE_DIR
Constant that holds the name of the environment property for specifying the base directory for calculating server home directories. |
static java.lang.String |
SERVER_BASE_DIR_SUFFIX
The suffix used when generating the default value for SERVER_BASE_DIR . |
static java.lang.String |
SERVER_BASE_URL
Constant that holds the name of the environment property for specifying the base URL for calculating server home URLs. |
static java.lang.String |
SERVER_BASE_URL_SUFFIX
The suffix used when generating the default value for SERVER_BASE_URL . |
static java.lang.String |
SERVER_BIND_ADDRESS
Constant that holds the name of the environment property for specifying the bind address for all jboss services |
static java.lang.String |
SERVER_CONFIG_URL
Constant that holds the name of the environment property for specifying the server configuration URL. |
static java.lang.String |
SERVER_CONFIG_URL_SUFFIX
The suffix used when generating the default value for SERVER_CONFIG_URL . |
static java.lang.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 java.lang.String |
SERVER_DATA_DIR_SUFFIX
The suffix used when generating the default value for SERVER_DATA_DIR . |
static java.lang.String |
SERVER_HOME_DIR
Constant that holds the name of the environment property for specifying the server home directory for JBoss. |
static java.lang.String |
SERVER_HOME_URL
Constant that holds the name of the environment property for specifying the server home URL for JBoss. |
static java.lang.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 java.lang.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 java.lang.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 java.lang.String |
SERVER_TEMP_DIR_SUFFIX
The suffix used when generating the default value for SERVER_TEMP_DIR . |
static java.lang.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. |
java.io.File |
getHomeDir()
Get the local home directory which the server is running from. |
java.net.URL |
getHomeURL()
Get the home URL which the server is running from. |
java.net.URL |
getLibraryURL()
Get the library URL for the server. |
java.net.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. |
java.lang.String |
getRootDeploymentFilename()
Get the filename of the root deployable that will be used to finalize the bootstrap process. |
java.io.File |
getServerBaseDir()
Get the base directory for calculating server home directories. |
java.net.URL |
getServerBaseURL()
Get the base directory for calculating server home URLs. |
java.net.URL |
getServerConfigURL()
Get the server configuration URL. |
java.io.File |
getServerDataDir()
Get the directory where local data will be stored. |
java.io.File |
getServerHomeDir()
Get the server home directory. |
java.net.URL |
getServerHomeURL()
Get the server home URL. |
java.net.URL |
getServerLibraryURL()
Get the server library URL. |
java.lang.String |
getServerName()
Get the name of the server. |
java.io.File |
getServerNativeDir()
Get the native dir for unpacking |
java.io.File |
getServerTempDeployDir()
Get the temporary deployment dir for unpacking |
java.io.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(java.lang.String filename)
Set the filename of the root deployable that will be used to finalize the bootstrap process. |
Field Detail |
public static final java.lang.String DEFAULT_PARITION_NAME
public static final java.lang.String PARTITION_NAME_PROPERTY
public static final java.lang.String NATIVE_LOAD_PROPERTY
public static final java.lang.String NATIVE_DIR_PROPERTY
public static final java.lang.String BOOT_LIBRARY_LIST
These libraries will be loaded from LIBRARY_URL.
public static final java.lang.String SERVER_TYPE
public static final java.lang.String ROOT_DEPLOYMENT_FILENAME
If not set then the server will default to DEFAULT_ROOT_DEPLOYMENT_FILENAME
.
public static final java.lang.String HOME_DIR
public static final java.lang.String HOME_URL
If not set then the value of HOME_DIR will converted into a URL.
public static final java.lang.String LIBRARY_URL
Defaults to HOME_URL/lib/
public static final java.lang.String PATCH_URL
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.
public static final java.lang.String SERVER_NAME
Defaults to default.
public static final java.lang.String SERVER_BASE_DIR
Defaults to HOME_DIR/server.
public static final java.lang.String SERVER_HOME_DIR
Defaults to SERVER_BASE_DIR/SERVER_NAME.
public static final java.lang.String SERVER_TEMP_DIR
Defaults to SERVER_HOME_DIR/tmp .
public static final java.lang.String SERVER_DATA_DIR
Defaults to SERVER_HOME_DIR/data.
public static final java.lang.String SERVER_BASE_URL
Defaults to HOME_URL/server.
public static final java.lang.String SERVER_HOME_URL
Defaults to SERVER_BASE_URL/SERVER_NAME.
public static final java.lang.String SERVER_CONFIG_URL
Defaults to SERVER_HOME_UTL/conf .
public static final java.lang.String SERVER_LIBRARY_URL
Defaults to SERVER_HOME_URL/lib/
public static final java.lang.String SERVER_BIND_ADDRESS
public static final java.lang.String EXIT_ON_SHUTDOWN
If not set then the server will default to exiting on shutdown.
public static final java.lang.String BLOCKING_SHUTDOWN
If not set then the server will default to asynchronous shutdown.
public static final java.lang.String REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY
If not set then the server will default to asynchronous shutdown.
public static final java.lang.String PLATFORM_MBEANSERVER
If not set then jboss will instantiate its own MBeanServer
public static final java.lang.String LIBRARY_URL_SUFFIX
LIBRARY_URL
and SERVER_LIBRARY_URL
.
public static final java.lang.String SERVER_CONFIG_URL_SUFFIX
SERVER_CONFIG_URL
.
public static final java.lang.String SERVER_BASE_DIR_SUFFIX
SERVER_BASE_DIR
.
public static final java.lang.String SERVER_BASE_URL_SUFFIX
SERVER_BASE_URL
.
public static final java.lang.String SERVER_DATA_DIR_SUFFIX
SERVER_DATA_DIR
.
public static final java.lang.String SERVER_TEMP_DIR_SUFFIX
SERVER_TEMP_DIR
.
public static final java.lang.String DEFAULT_SERVER_NAME
SERVER_NAME
.
public static final boolean DEFAULT_EXIT_ON_SHUTDOWN
EXIT_ON_SHUTDOWN
.
public static final boolean DEFAULT_BLOCKING_SHUTDOWN
BLOCKING_SHUTDOWN
.
public static final boolean DEFAULT_REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY
REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY
.
public static final boolean DEFAULT_PLATFORM_MBEANSERVER
PLATFORM_MBEANSERVER
.
public static final java.lang.String DEFAULT_ROOT_DEPLOYMENT_FILENAME
ROOT_DEPLOYMENT_FILENAME
.
Method Detail |
public java.io.File getHomeDir()
public java.net.URL getHomeURL()
public java.net.URL getLibraryURL()
public java.net.URL getPatchURL()
public java.lang.String getServerName()
public java.io.File getServerBaseDir()
public java.io.File getServerHomeDir()
public java.io.File getServerTempDir()
public java.io.File getServerDataDir()
public java.net.URL getServerBaseURL()
public java.net.URL getServerHomeURL()
public java.net.URL getServerLibraryURL()
public java.net.URL getServerConfigURL()
public java.io.File getServerNativeDir()
public java.io.File getServerTempDeployDir()
public boolean getPlatformMBeanServer()
ServerConfig.PLATFORM_MBEANSERVER
property must be set, and the jvm must be jdk1.5+
public void setExitOnShutdown(boolean flag)
Server.shutdown()
is called.
If enabled, then shutdown calls Server.exit(int)
. If disabled, then
only the shutdown hook will be run.
flag
- True to enable calling exit on shutdown.public boolean getExitOnShutdown()
public boolean getBlockingShutdown()
public void setBlockingShutdown(boolean blockingShutdown)
blockingShutdown
- The new BlockingShutdown value.public boolean getRequireJBossURLStreamHandlerFactory()
public void setRequireJBossURLStreamHandlerFactory(boolean requireJBossURLStreamHandlerFactory)
requireJBossURLStreamHandlerFactory
- The new RequireJBossURLStreamHandlerFactory value.public void setRootDeploymentFilename(java.lang.String filename)
filename
- The filename of the root deployable.public java.lang.String getRootDeploymentFilename()
|
||||||||||
PREV CLASS (src) NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |