org.jboss.system.server
Interface ServerConfigImplMBean

All Known Implementing Classes:
ServerConfigImpl

public interface ServerConfigImplMBean

MBean interface.


Field Summary
static javax.management.ObjectName OBJECT_NAME
           
 
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.
 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 home URL which the server is running from.
 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.
 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 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(String filename)
          Set the filename of the root deployable that will be used to finalize the bootstrap process.
 

Field Detail

OBJECT_NAME

static final javax.management.ObjectName OBJECT_NAME
Method Detail

getHomeDir

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


getHomeURL

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


getLibraryURL

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


getPatchURL

URL getPatchURL()
Get the patch URL for the server.


getServerName

String getServerName()
Get the name of the server.


getServerBaseDir

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


getServerHomeDir

File getServerHomeDir()
Get the server home directory.


getServerLogDir

File getServerLogDir()
Get the directory where log files will be stored.

Returns:
the writable log directory

getServerTempDir

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

Returns:
the writable temp directory

getServerDataDir

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

Returns:
the data directory

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

getServerBaseURL

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


getServerHomeURL

URL getServerHomeURL()
Get the server home URL.


getServerLibraryURL

URL getServerLibraryURL()
Get the server library URL.


getServerConfigURL

URL getServerConfigURL()
Get the server configuration URL.


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.

setBlockingShutdown

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.

Parameters:
flag - True to enable blocking shutdown.

getBlockingShutdown

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

Returns:
The current value of the blocking shutdown flag.

setRequireJBossURLStreamHandlerFactory

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

Parameters:
flag - True to enable blocking shutdown.

getRequireJBossURLStreamHandlerFactory

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

Returns:
The current value of the requireJBossURLStreamHandlerFactory flag.

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.


Copyright © 2002 JBoss Group, LLC. All Rights Reserved.