Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.system.server
Class ServerConfigImpl

java.lang.Object
  extended byorg.jboss.system.server.ServerConfigImpl
All Implemented Interfaces:
ServerConfig (src)
public class ServerConfigImpl
extends java.lang.Object
implements ServerConfig (src)

A container for the basic configuration elements required to create a Server instance.

MalformedURLException are rethrown as NestedRuntimeExceptions, so that code that needs to access these values does not have to directly worry about problems with lazy construction of final URL values.

Most values are determined durring first call to getter. All values when determined will have equivilent system properties set.

Clients are not meant to use this class directly. Instead use ServerConfigLocator (src) to get an instance of ServerConfig (src) and then use it to get the server's configuration bits.

Field Summary
 
Fields inherited from interface org.jboss.system.server.ServerConfig (src)
BLOCKING_SHUTDOWN, BOOT_LIBRARY_LIST, DEFAULT_BLOCKING_SHUTDOWN, DEFAULT_EXIT_ON_SHUTDOWN, DEFAULT_PARITION_NAME, DEFAULT_PLATFORM_MBEANSERVER, DEFAULT_REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY, DEFAULT_ROOT_DEPLOYMENT_FILENAME, DEFAULT_SERVER_NAME, EXIT_ON_SHUTDOWN, HOME_DIR, HOME_URL, LIBRARY_URL, LIBRARY_URL_SUFFIX, NATIVE_DIR_PROPERTY, NATIVE_LOAD_PROPERTY, PARTITION_NAME_PROPERTY, PATCH_URL, PLATFORM_MBEANSERVER, REQUIRE_JBOSS_URL_STREAM_HANDLER_FACTORY, ROOT_DEPLOYMENT_FILENAME, SERVER_BASE_DIR, SERVER_BASE_DIR_SUFFIX, SERVER_BASE_URL, SERVER_BASE_URL_SUFFIX, SERVER_BIND_ADDRESS, SERVER_CONFIG_URL, SERVER_CONFIG_URL_SUFFIX, SERVER_DATA_DIR, SERVER_DATA_DIR_SUFFIX, SERVER_HOME_DIR, SERVER_HOME_URL, SERVER_LIBRARY_URL, SERVER_NAME, SERVER_TEMP_DIR, SERVER_TEMP_DIR_SUFFIX, SERVER_TYPE
 
Constructor Summary
ServerConfigImpl(java.util.Properties props)
          Construct a new ServerConfigImpl instance.
 
Method Summary
 boolean getBlockingShutdown()
          Get the current value of the blocking shutdown flag.
 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 home URL which the server is running from.
 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 current value of the requireJBossURLStreamHandlerFactory flag.
 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 initURLs()
          Breakout the initialization of URLs from the constructor as we need the ServerConfig.HOME_DIR set for log setup, but we cannot create any file URLs prior to the
 void setBlockingShutdown(boolean flag)
          Enable or disable blocking when Server.shutdown() is called.
 void setExitOnShutdown(boolean flag)
          Enable or disable exiting the JVM when Server.shutdown() is called.
 void setRequireJBossURLStreamHandlerFactory(boolean flag)
          Set the RequireJBossURLStreamHandlerFactory flag.
 void setRootDeploymentFilename(java.lang.String filename)
          Set the filename of the root deployable that will be used to finalize the bootstrap process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerConfigImpl

public ServerConfigImpl(java.util.Properties props)
                 throws java.lang.Exception
Construct a new ServerConfigImpl instance.

Parameters:
props - Configuration properties.
Throws:
java.lang.Exception - Missing or invalid configuration.
Method Detail

initURLs

public void initURLs()
              throws java.net.MalformedURLException
Breakout the initialization of URLs from the constructor as we need the ServerConfig.HOME_DIR set for log setup, but we cannot create any file URLs prior to the

Throws:
java.net.MalformedURLException

getHomeDir

public java.io.File getHomeDir()
Get the local home directory which the server is running from.

Specified by:
getHomeDir in interface ServerConfig (src)
Returns:
The local server home directory.

getHomeURL

public java.net.URL getHomeURL()
Get the home URL which the server is running from.

Specified by:
getHomeURL in interface ServerConfig (src)
Returns:
The home URL which the server is running from.

getLibraryURL

public java.net.URL getLibraryURL()
Get the home URL which the server is running from.

Specified by:
getLibraryURL in interface ServerConfig (src)
Returns:
The library URL for the server.

getPatchURL

public java.net.URL getPatchURL()
Get the patch URL for the server.

Specified by:
getPatchURL in interface ServerConfig (src)
Returns:
The patch URL for the server.

getServerName

public java.lang.String getServerName()
Get the name of the server.

Specified by:
getServerName in interface ServerConfig (src)
Returns:
The name of the server.

getServerBaseDir

public java.io.File getServerBaseDir()
Get the base directory for calculating server home directories.

Specified by:
getServerBaseDir in interface ServerConfig (src)
Returns:
Base server home directory.

getServerHomeDir

public java.io.File getServerHomeDir()
Get the server home directory.

Specified by:
getServerHomeDir in interface ServerConfig (src)
Returns:
Server home directory.

getServerTempDir

public java.io.File getServerTempDir()
Get the directory where temporary files will be stored.

Specified by:
getServerTempDir in interface ServerConfig (src)
Returns:
the writable temp directory

getServerDataDir

public java.io.File getServerDataDir()
Get the directory where local data will be stored.

Specified by:
getServerDataDir in interface ServerConfig (src)
Returns:
the data directory

getServerNativeDir

public java.io.File getServerNativeDir()
Get the native dir for unpacking

Specified by:
getServerNativeDir in interface ServerConfig (src)
Returns:
the directory

getServerTempDeployDir

public java.io.File getServerTempDeployDir()
Get the temporary deployment dir for unpacking

Specified by:
getServerTempDeployDir in interface ServerConfig (src)
Returns:
the directory

getServerBaseURL

public java.net.URL getServerBaseURL()
Get the base directory for calculating server home URLs.

Specified by:
getServerBaseURL in interface ServerConfig (src)
Returns:
Base server home URL.

getServerHomeURL

public java.net.URL getServerHomeURL()
Get the server home URL.

Specified by:
getServerHomeURL in interface ServerConfig (src)
Returns:
Server home URL.

getServerLibraryURL

public java.net.URL getServerLibraryURL()
Get the server library URL.

Specified by:
getServerLibraryURL in interface ServerConfig (src)
Returns:
Server library URL.

getServerConfigURL

public java.net.URL getServerConfigURL()
Get the server configuration URL.

Specified by:
getServerConfigURL in interface ServerConfig (src)
Returns:
Server configuration URL.

getPlatformMBeanServer

public 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+

Specified by:
getPlatformMBeanServer in interface ServerConfig (src)
Returns:
true if jboss runs on the jvm platfrom MBeanServer

setExitOnShutdown

public 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.

Specified by:
setExitOnShutdown in interface ServerConfig (src)
Parameters:
flag - True to enable calling exit on shutdown.

getExitOnShutdown

public boolean getExitOnShutdown()
Get the current value of the exit on shutdown flag.

Specified by:
getExitOnShutdown in interface ServerConfig (src)
Returns:
The current value of the exit on shutdown flag.

setBlockingShutdown

public void setBlockingShutdown(boolean flag)
Enable or disable blocking when Server.shutdown() is called. If enabled, then shutdown will be called in the current thread. If disabled, then the shutdown hook will be run ansynchronously in a separate thread.

Specified by:
setBlockingShutdown in interface ServerConfig (src)
Parameters:
flag - True to enable blocking shutdown.

getBlockingShutdown

public boolean getBlockingShutdown()
Get the current value of the blocking shutdown flag.

Specified by:
getBlockingShutdown in interface ServerConfig (src)
Returns:
The current value of the blocking shutdown flag.

setRequireJBossURLStreamHandlerFactory

public void setRequireJBossURLStreamHandlerFactory(boolean flag)
Set the RequireJBossURLStreamHandlerFactory flag. if false, exceptions when setting the URLStreamHandlerFactory will be logged and ignored.

Specified by:
setRequireJBossURLStreamHandlerFactory in interface ServerConfig (src)
Parameters:
flag - True to enable blocking shutdown.

getRequireJBossURLStreamHandlerFactory

public boolean getRequireJBossURLStreamHandlerFactory()
Get the current value of the requireJBossURLStreamHandlerFactory flag.

Specified by:
getRequireJBossURLStreamHandlerFactory in interface ServerConfig (src)
Returns:
The current value of the requireJBossURLStreamHandlerFactory flag.

setRootDeploymentFilename

public void setRootDeploymentFilename(java.lang.String filename)
Set the filename of the root deployable that will be used to finalize the bootstrap process.

Specified by:
setRootDeploymentFilename in interface ServerConfig (src)
Parameters:
filename - The filename of the root deployable.

getRootDeploymentFilename

public java.lang.String getRootDeploymentFilename()
Get the filename of the root deployable that will be used to finalize the bootstrap process.

Specified by:
getRootDeploymentFilename in interface ServerConfig (src)
Returns:
The filename of the root deployable.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD