org.jboss.bootstrap.spi.as.config
Interface JBossASBasedServerConfig<T extends JBossASBasedServerConfig<T>>

All Superinterfaces:
org.jboss.bootstrap.spi.mc.config.MCBasedServerConfig<T>, org.jboss.bootstrap.spi.config.ServerConfig<T>
All Known Subinterfaces:
JBossASServerConfig

public interface JBossASBasedServerConfig<T extends JBossASBasedServerConfig<T>>
extends org.jboss.bootstrap.spi.mc.config.MCBasedServerConfig<T>

JBossASBasedServerConfig Contract for the configuration of AS-based Servers, may be extended for a direct AS ServerConfig

Version:
$Revision: $
Author:
ALR

Field Summary
static String ENV_VAR_JBOSSAS_HOME
          Constant that holds the name of the environment variable which specifies the root of the AS installation
static String PROP_KEY_JBOSSAS_BIND_ADDRESS
          Constant that holds the name of the system or configuration property
static String PROP_KEY_JBOSSAS_BOOT_LIBRARY_URL
          Constant that holds the name of the system property for specifying the URL where JBoss will read library files from.
static String PROP_KEY_JBOSSAS_COMMON_BASE_URL
          Constant that holds the name of the system property for specifying the base URL for files and directories common to different server configurations
static String PROP_KEY_JBOSSAS_COMMON_LIBRARY_URL
          Constant that holds the name of the system property for specifying a library directory URL that points to libraries shared by the various server configurations.
static String PROP_KEY_JBOSSAS_HOME
          Constant that holds the name of the system or configuration property which specifies the root of the AS installation
static String PROP_KEY_JBOSSAS_HOME_DIR
          Constant that holds the name of the system property which specifies the home directory for JBossAS.
static String PROP_KEY_JBOSSAS_HOME_URL
          Constant that holds the name of the system property which specifies the home URL for JBossAS.
static String PROP_KEY_JBOSSAS_NATIVE_DIR
          Constant that holds the location of native libraries
static String PROP_KEY_JBOSSAS_NATIVE_LOAD
          Constant that holds the name of the system property designating whether to load native libraries
static String PROP_KEY_JBOSSAS_PARTITION_NAME
          Constant that holds the name of the system property for specifying the partition name for this instance in clustering
static String PROP_KEY_JBOSSAS_PARTITION_UDP_GROUP
          Constant that holds the name of the system property for specifying the UDP Group for this instance in clustering
static String PROP_KEY_JBOSSAS_PARTITION_UDP_PORT
          Constant that holds the name of the system property for specifying the UDP Port for this instance in clustering
static String PROP_KEY_JBOSSAS_PLATFORM_MBEANSERVER
          Constant that holds the name of the system 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 PROP_KEY_JBOSSAS_SERVER_BASE_DIR
          Constant that holds the name of the system property for specifying the base directory for calculating server home directories.
static String PROP_KEY_JBOSSAS_SERVER_BASE_URL
          Constant that holds the name of the system property for specifying the base URL for calculating server home URLs.
static String PROP_KEY_JBOSSAS_SERVER_CONF_URL
          Constant that holds the name of the system property for specifying the server configuration URL.
static String PROP_KEY_JBOSSAS_SERVER_DATA_DIR
          Constant that holds the name of the system property for specifying the directory which JBoss will use for persistent data file storage.
static String PROP_KEY_JBOSSAS_SERVER_HOME_DIR
          Constant that holds the name of the system property for specifying the server home directory for JBoss.
static String PROP_KEY_JBOSSAS_SERVER_HOME_URL
          Constant that holds the name of the system property for specifying the server home URL for JBoss.
static String PROP_KEY_JBOSSAS_SERVER_LIBRARY_URL
          Constant that holds the name of the system property for specifying the URL where JBoss will read server specific library files from.
static String PROP_KEY_JBOSSAS_SERVER_LOG_DIR
          Constant that holds the name of the system property for specifying the server log directory for JBoss.
static String PROP_KEY_JBOSSAS_SERVER_NAME
          Constant that holds the name of the system or configuration property which specifies the name of the server which will be used to calculate the servers home directory and url.
static String PROP_KEY_JBOSSAS_SERVER_TEMP_DIR
          Constant that holds the name of the system property for specifying the directory which JBoss will use for temporary file storage.
 
Fields inherited from interface org.jboss.bootstrap.spi.config.ServerConfig
PROP_KEY_BOOTSTRAP_HOME_URL, PROP_KEY_BOOTSTRAP_NAME, PROP_KEY_BOOTSTRAP_URL
 
Method Summary
 T bindAddress(String bindAddress)
          Sets the bind address for the server
 T bootLibraryLocation(String bootLibraryLocation)
          Sets the location of the JBossAS Boot Libraries
 T bootLibraryLocation(URL bootLibraryLocation)
          Sets the location of the JBossAS Boot Libraries
 T commonBaseLocation(String commonBaseLocation)
          Sets the location of the common base
 T commonBaseLocation(URL commonBaseLocation)
          Sets the location of the common base
 T commonLibLocation(String commonLibLocation)
          Sets the location of the common lib
 T commonLibLocation(URL commonLibLocation)
          Sets the location of the common lib
 String getBindAddress()
          Obtains the bind address to be used for the Server.
 URL getBootLibraryLocation()
          Obtains the location of the JBossAS Boot Libraries
 URL getCommonBaseLocation()
          Obtains the location of the common base
 URL getCommonLibLocation()
          Obtains the location of the common lib
 URL getJBossHome()
          Obtains the $JBOSS_HOME, the path to the root location of the JBossAS installation.
 URL getNativeLibraryLocation()
          Obtains the location of the JBossAS Native Libraries
 String getPartitionName()
          Obtains the partition name for this instance in clustering
 URL getServerBaseLocation()
          Obtains the location of the server base, from which server homes (by default) decend
 URL getServerConfLocation()
          Obtains the location in which the server configuration resides
 URL getServerDataLocation()
          Obtains the location in which the server persistent data resides
 URL getServerHomeLocation()
          Obtains the location of the server home
 URL getServerLibLocation()
          Obtains the location in which the server libraries reside
 URL getServerLogLocation()
          Obtains the location in which the server logs reside
 String getServerName()
          Obtains the name of the server configuration.
 URL getServerTempLocation()
          Obtains the location in which the server temp data resides
 String getUdpGroup()
          Obtains the UDP Group for this instance in clustering
 Integer getUdpPort()
          Obtains the JGroups UDP Multicast port for use in clustering
 Boolean isLoadNative()
          Determines whether or not to load the native libraries
 Boolean isUsePlatformMBeanServer()
          Determines whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+
 T jbossHome(String jbossHome)
          Sets $JBOSS_HOME, the path to the root location of the JBossAS installation.
 T jbossHome(URL jbossHome)
          Sets $JBOSS_HOME, the path to the root location of the JBossAS installation.
 T loadNative(Boolean loadNative)
          Sets whether or not to load the native libraries
 T nativeLibraryLocation(String nativeLibraryLocation)
          Sets the location of the JBossAS Native Libraries
 T nativeLibraryLocation(URL nativeLibraryLocation)
          Sets the location of the JBossAS Native Libraries
 T partitionName(String partitionName)
          Sets the partition name for this instance in clustering
 T serverBaseLocation(String serverBaseLocation)
          Sets the location of the server base, from which server homes (by default) decend
 T serverBaseLocation(URL serverBaseLocation)
          Sets the location of the server base, from which server homes (by default) decend
 T serverConfLocation(String serverConfLocation)
          Sets the location in which the server configuration resides
 T serverConfLocation(URL serverConfLocation)
          Sets the location in which the server configuration resides
 T serverDataLocation(String serverDataLocation)
          Sets the location in which the server persistent data resides
 T serverDataLocation(URL serverDataLocation)
          Sets the location in which the server persistent data resides
 T serverHomeLocation(String serverHomeLocation)
          Sets the location of the server home
 T serverHomeLocation(URL serverHomeLocation)
          Sets the location of the server home
 T serverLibLocation(String serverLibLocation)
          Sets the location in which the server libraries reside
 T serverLibLocation(URL serverLibLocation)
          Sets the location in which the server libraries reside
 T serverLogLocation(String serverLogLocation)
          Sets the location in which the server logs reside
 T serverLogLocation(URL serverLogLocation)
          Sets the location in which the server logs reside
 T serverName(String serverName)
          Sets the name of the server configuration
 T serverTempLocation(String serverTempLocation)
          Sets the location in which the server temp data resides
 T serverTempLocation(URL serverTempLocation)
          Sets the location in which the server temp data resides
 T udpGroup(String udpGroup)
          Sets the UDP Group for this instance in clustering
 T udpPort(Integer udpPort)
          Sets the JGroups UDP Multicast port for use in clustering
 T usePlatformMBeanServer(Boolean usePlatformMBeanServer)
          Sets whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+
 
Methods inherited from interface org.jboss.bootstrap.spi.config.ServerConfig
bootstrapHome, bootstrapHome, bootstrapName, bootstrapUrl, bootstrapUrl, freeze, getBootstrapHome, getBootstrapName, getBootstrapUrl, getProperties, getProperty, isFrozen, properties, properties, property
 

Field Detail

PROP_KEY_JBOSSAS_BIND_ADDRESS

static final String PROP_KEY_JBOSSAS_BIND_ADDRESS
Constant that holds the name of the system or configuration property

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_NAME

static final String PROP_KEY_JBOSSAS_SERVER_NAME
Constant that holds the name of the system or configuration property which specifies the name of the server which will be used to calculate the servers home directory and url.

See Also:
Constant Field Values

ENV_VAR_JBOSSAS_HOME

static final String ENV_VAR_JBOSSAS_HOME
Constant that holds the name of the environment variable which specifies the root of the AS installation

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_HOME

static final String PROP_KEY_JBOSSAS_HOME
Constant that holds the name of the system or configuration property which specifies the root of the AS installation

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_HOME_DIR

static final String PROP_KEY_JBOSSAS_HOME_DIR
Constant that holds the name of the system property which specifies the home directory for JBossAS.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_HOME_URL

static final String PROP_KEY_JBOSSAS_HOME_URL
Constant that holds the name of the system property which specifies the home URL for JBossAS.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_BOOT_LIBRARY_URL

static final String PROP_KEY_JBOSSAS_BOOT_LIBRARY_URL
Constant that holds the name of the system property for specifying the URL where JBoss will read library files from.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_BASE_DIR

static final String PROP_KEY_JBOSSAS_SERVER_BASE_DIR
Constant that holds the name of the system property for specifying the base directory for calculating server home directories.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_BASE_URL

static final String PROP_KEY_JBOSSAS_SERVER_BASE_URL
Constant that holds the name of the system property for specifying the base URL for calculating server home URLs.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_HOME_DIR

static final String PROP_KEY_JBOSSAS_SERVER_HOME_DIR
Constant that holds the name of the system property for specifying the server home directory for JBoss.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_HOME_URL

static final String PROP_KEY_JBOSSAS_SERVER_HOME_URL
Constant that holds the name of the system property for specifying the server home URL for JBoss.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_COMMON_BASE_URL

static final String PROP_KEY_JBOSSAS_COMMON_BASE_URL
Constant that holds the name of the system property for specifying the base URL for files and directories common to different server configurations

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_COMMON_LIBRARY_URL

static final String PROP_KEY_JBOSSAS_COMMON_LIBRARY_URL
Constant that holds the name of the system property for specifying a library directory URL that points to libraries shared by the various server configurations.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_LOG_DIR

static final String PROP_KEY_JBOSSAS_SERVER_LOG_DIR
Constant that holds the name of the system property for specifying the server log directory for JBoss.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_CONF_URL

static final String PROP_KEY_JBOSSAS_SERVER_CONF_URL
Constant that holds the name of the system property for specifying the server configuration URL.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_LIBRARY_URL

static final String PROP_KEY_JBOSSAS_SERVER_LIBRARY_URL
Constant that holds the name of the system property for specifying the URL where JBoss will read server specific library files from.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_DATA_DIR

static final String PROP_KEY_JBOSSAS_SERVER_DATA_DIR
Constant that holds the name of the system property for specifying the directory which JBoss will use for persistent data file storage.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_SERVER_TEMP_DIR

static final String PROP_KEY_JBOSSAS_SERVER_TEMP_DIR
Constant that holds the name of the system property for specifying the directory which JBoss will use for temporary file storage.

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_PARTITION_NAME

static final String PROP_KEY_JBOSSAS_PARTITION_NAME
Constant that holds the name of the system property for specifying the partition name for this instance in clustering

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_PARTITION_UDP_GROUP

static final String PROP_KEY_JBOSSAS_PARTITION_UDP_GROUP
Constant that holds the name of the system property for specifying the UDP Group for this instance in clustering

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_PARTITION_UDP_PORT

static final String PROP_KEY_JBOSSAS_PARTITION_UDP_PORT
Constant that holds the name of the system property for specifying the UDP Port for this instance in clustering

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_NATIVE_LOAD

static final String PROP_KEY_JBOSSAS_NATIVE_LOAD
Constant that holds the name of the system property designating whether to load native libraries

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_NATIVE_DIR

static final String PROP_KEY_JBOSSAS_NATIVE_DIR
Constant that holds the location of native libraries

See Also:
Constant Field Values

PROP_KEY_JBOSSAS_PLATFORM_MBEANSERVER

static final String PROP_KEY_JBOSSAS_PLATFORM_MBEANSERVER
Constant that holds the name of the system 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
Method Detail

getBindAddress

String getBindAddress()
Obtains the bind address to be used for the Server.

Returns:

bindAddress

T bindAddress(String bindAddress)
Sets the bind address for the server

Parameters:
bindAddress -
Returns:

getServerName

String getServerName()
Obtains the name of the server configuration.

Returns:

serverName

T serverName(String serverName)
Sets the name of the server configuration

Parameters:
serverName -
Returns:

getJBossHome

URL getJBossHome()
Obtains the $JBOSS_HOME, the path to the root location of the JBossAS installation.

Returns:

jbossHome

T jbossHome(String jbossHome)
                                                throws IllegalArgumentException
Sets $JBOSS_HOME, the path to the root location of the JBossAS installation.

Parameters:
jbossHome - The location to $JBOSS_HOME
Returns:
This configuration
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

jbossHome

T jbossHome(URL jbossHome)
Sets $JBOSS_HOME, the path to the root location of the JBossAS installation.

Parameters:
jbossHome - The location to $JBOSS_HOME
Returns:
This configuration

getBootLibraryLocation

URL getBootLibraryLocation()
Obtains the location of the JBossAS Boot Libraries

Returns:

bootLibraryLocation

T bootLibraryLocation(URL bootLibraryLocation)
Sets the location of the JBossAS Boot Libraries

Parameters:
bootLibraryLocation -
Returns:

bootLibraryLocation

T bootLibraryLocation(String bootLibraryLocation)
                                                          throws IllegalArgumentException
Sets the location of the JBossAS Boot Libraries

Parameters:
bootLibraryLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerBaseLocation

URL getServerBaseLocation()
Obtains the location of the server base, from which server homes (by default) decend

Returns:

serverBaseLocation

T serverBaseLocation(URL serverBaseLocation)
Sets the location of the server base, from which server homes (by default) decend

Parameters:
serverBaseLocation -
Returns:

serverBaseLocation

T serverBaseLocation(String serverBaseLocation)
                                                         throws IllegalArgumentException
Sets the location of the server base, from which server homes (by default) decend

Parameters:
serverBaseLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerHomeLocation

URL getServerHomeLocation()
Obtains the location of the server home

Returns:

serverHomeLocation

T serverHomeLocation(URL serverHomeLocation)
Sets the location of the server home

Parameters:
serverBaseLocation -
Returns:

serverHomeLocation

T serverHomeLocation(String serverHomeLocation)
                                                         throws IllegalArgumentException
Sets the location of the server home

Parameters:
serverHomeLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getCommonBaseLocation

URL getCommonBaseLocation()
Obtains the location of the common base

Returns:

commonBaseLocation

T commonBaseLocation(URL commonBaseLocation)
Sets the location of the common base

Parameters:
serverBaseLocation -
Returns:

commonBaseLocation

T commonBaseLocation(String commonBaseLocation)
                                                         throws IllegalArgumentException
Sets the location of the common base

Parameters:
commonBaseLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getCommonLibLocation

URL getCommonLibLocation()
Obtains the location of the common lib

Returns:

commonLibLocation

T commonLibLocation(URL commonLibLocation)
Sets the location of the common lib

Parameters:
commonLibLocation -
Returns:

commonLibLocation

T commonLibLocation(String commonLibLocation)
                                                        throws IllegalArgumentException
Sets the location of the common lib

Parameters:
commonLibLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerLogLocation

URL getServerLogLocation()
Obtains the location in which the server logs reside

Returns:

serverLogLocation

T serverLogLocation(URL serverLogLocation)
Sets the location in which the server logs reside

Parameters:
serverLogLocation -
Returns:

serverLogLocation

T serverLogLocation(String serverLogLocation)
                                                        throws IllegalArgumentException
Sets the location in which the server logs reside

Parameters:
serverLogLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerConfLocation

URL getServerConfLocation()
Obtains the location in which the server configuration resides

Returns:

serverConfLocation

T serverConfLocation(URL serverConfLocation)
Sets the location in which the server configuration resides

Parameters:
serverConfLocation -
Returns:

serverConfLocation

T serverConfLocation(String serverConfLocation)
                                                         throws IllegalArgumentException
Sets the location in which the server configuration resides

Parameters:
serverConfLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerLibLocation

URL getServerLibLocation()
Obtains the location in which the server libraries reside

Returns:

serverLibLocation

T serverLibLocation(URL serverLibLocation)
Sets the location in which the server libraries reside

Parameters:
serverLibLocation -
Returns:

serverLibLocation

T serverLibLocation(String serverLibLocation)
                                                        throws IllegalArgumentException
Sets the location in which the server libraries reside

Parameters:
serverLibLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerDataLocation

URL getServerDataLocation()
Obtains the location in which the server persistent data resides

Returns:

serverDataLocation

T serverDataLocation(URL serverDataLocation)
Sets the location in which the server persistent data resides

Parameters:
serverDataLocation -
Returns:

serverDataLocation

T serverDataLocation(String serverDataLocation)
                                                         throws IllegalArgumentException
Sets the location in which the server persistent data resides

Parameters:
serverDataLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getServerTempLocation

URL getServerTempLocation()
Obtains the location in which the server temp data resides

Returns:

serverTempLocation

T serverTempLocation(URL serverTempLocation)
Sets the location in which the server temp data resides

Parameters:
serverTempLocation -
Returns:

serverTempLocation

T serverTempLocation(String serverTempLocation)
                                                         throws IllegalArgumentException
Sets the location in which the server temp data resides

Parameters:
serverTempLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

getPartitionName

String getPartitionName()
Obtains the partition name for this instance in clustering

Returns:

partitionName

T partitionName(String partitionName)
Sets the partition name for this instance in clustering

Parameters:
partitionName -
Returns:

getUdpGroup

String getUdpGroup()
Obtains the UDP Group for this instance in clustering

Returns:

udpGroup

T udpGroup(String udpGroup)
Sets the UDP Group for this instance in clustering

Parameters:
udpGroup -
Returns:

getUdpPort

Integer getUdpPort()
Obtains the JGroups UDP Multicast port for use in clustering

Returns:

udpPort

T udpPort(Integer udpPort)
Sets the JGroups UDP Multicast port for use in clustering

Parameters:
udpPort - The port, or null to use the default
Returns:

isLoadNative

Boolean isLoadNative()
Determines whether or not to load the native libraries

Returns:

loadNative

T loadNative(Boolean loadNative)
Sets whether or not to load the native libraries

Parameters:
loadNative - true or false, or null to use the default
Returns:

getNativeLibraryLocation

URL getNativeLibraryLocation()
Obtains the location of the JBossAS Native Libraries

Returns:

nativeLibraryLocation

T nativeLibraryLocation(URL nativeLibraryLocation)
Sets the location of the JBossAS Native Libraries

Parameters:
nativeLibraryLocation -
Returns:

nativeLibraryLocation

T nativeLibraryLocation(String nativeLibraryLocation)
                                                            throws IllegalArgumentException
Sets the location of the JBossAS Native Libraries

Parameters:
nativeLibraryLocation -
Returns:
Throws:
IllegalArgumentException - If the specified argument is non-null and cannot be constructed into a URL

isUsePlatformMBeanServer

Boolean isUsePlatformMBeanServer()
Determines whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+

Returns:

usePlatformMBeanServer

T usePlatformMBeanServer(Boolean usePlatformMBeanServer)
Sets whether or not to use as the main jboss server the MBeanServer returned from ManagementFactory.getPlatformMBeanServer(), when running under jdk1.5+

Parameters:
usePlatformMBeanServer -
Returns:


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.