org.ow2.easybeans.api
Interface EZBServerConfig

public interface EZBServerConfig

Defines the EasyBeans configuration.

Author:

Florent Benoit

Method Summary

void	addDeployDirectory(File deployDirectory) Add a directory to the list of path for loading/looking Java EE modules.
boolean	addEmbeddedComponents()
void	addExtensionFactory(EZBConfigurationExtension extension) Adds an EZBConfigurationExtension in the Facory list.
Map<String,Object>	getConfigurationMap()
LinkedList<URL>	getConfigurationURLs()
List<File>	getDeployDirectories()
String	getDescription()
List<EZBConfigurationExtension>	getExtensionFactories()
boolean	initJACC()
boolean	isAutoConfigureComponents()
boolean	isDirectoryScanningEnabled()
boolean	isRegisterDeployerMBean()
boolean	isRegisterJ2EEServerMBean()
boolean	isStartJMXConnector()
boolean	isStopComponentsDuringShutdown()
boolean	isUsingLegacyNamingStrategy() Use or not the EasyBeans v1 legacy naming strategy.
boolean	isUsingMBeans() Use or not the MBeans.
boolean	isUsingNaming() Use or not the EasyBeans naming system.
void	setAddEmbeddedComponents(boolean addEmbeddedComponents) Sets the flag for adding before the startup the core components.
void	setAutoConfigureComponents(boolean autoConfigureComponents) Sets the flag for managing components in EasyBeans.
void	setConfigurationMap(Map<String,Object> configurationMap) Sets the configuration map.
void	setConfigurationURLs(LinkedList<URL> configurationURLs) Sets the list of the URLs used to configure EasyBeans.
void	setDeployDirectories(List<File> deployDirectories) Sets the list of path for loading/looking Java EE modules.
void	setDescription(String description) Sets a description of the embedded server.
void	setDirectoryScanningEnabled(boolean directoryScanningEnabled)
void	setInitJACC(boolean initJACC) Init or not JACC at startup.
void	setRegisterDeployerMBean(boolean registerDeployerMBean) Enable or disable the Deployer MBean.
void	setRegisterJ2EEServerMBean(boolean registerJ2EEServerMBean) Enable or disable the J2EEServer MBean.
void	setShouldWait(boolean shouldWait) Sets if the server will loop at the end of it's startup.
void	setStartJMXConnector(boolean startJMXConnector) Enable or disable the JMX connector.
void	setStopComponentsDuringShutdown(boolean stopComponents) Specify if the components should be stopped during shutdown sequence.
void	setUseLegacyNamingStrategy(boolean useLegacyNamingStrategy) Sets the value for EasyBeans v1 legacy naming strategy.
void	setUseMBeans(boolean useMBeans) Sets the value for using MBeans.
void	setUseNaming(boolean useNaming) Sets the value for using the EasyBeans naming system.
boolean	shouldWait()

Method Detail

getDeployDirectories

List<File> getDeployDirectories()

Returns:

the list of path for loading/looking Java EE modules.

setDeployDirectories

void setDeployDirectories(List<File> deployDirectories)

Sets the list of path for loading/looking Java EE modules.

Parameters:

deployDirectories - the list of path for loading/looking Java EE modules.

addDeployDirectory

void addDeployDirectory(File deployDirectory)

Add a directory to the list of path for loading/looking Java EE modules.

Parameters:

deployDirectory - a path for loading/looking Java EE modules.

shouldWait

boolean shouldWait()

Returns:

true if the server should wait when starting embedded server.

setShouldWait

void setShouldWait(boolean shouldWait)

Sets if the server will loop at the end of it's startup.

Parameters:

shouldWait - true/false

isUsingMBeans

boolean isUsingMBeans()

Use or not the MBeans.

Returns:

true if this is the case.

setUseMBeans

void setUseMBeans(boolean useMBeans)

Sets the value for using MBeans.

Parameters:

useMBeans - the boolean value.

isUsingNaming

boolean isUsingNaming()

Use or not the EasyBeans naming system.

Returns:

true if this is the case.

setUseNaming

void setUseNaming(boolean useNaming)

Sets the value for using the EasyBeans naming system.

Parameters:

useNaming - the boolean value.

addExtensionFactory

void addExtensionFactory(EZBConfigurationExtension extension)

Adds an EZBConfigurationExtension in the Facory list.

Parameters:

extension - the factory FQN.

getExtensionFactories

List<EZBConfigurationExtension> getExtensionFactories()

Returns:

Returns the list of EZBConfigurationExtension.

isDirectoryScanningEnabled

boolean isDirectoryScanningEnabled()

Returns:

the directoryScanningEnabled

setDirectoryScanningEnabled

void setDirectoryScanningEnabled(boolean directoryScanningEnabled)

Parameters:

directoryScanningEnabled - the directoryScanningEnabled to set

setInitJACC

void setInitJACC(boolean initJACC)

Init or not JACC at startup.

Parameters:

initJACC - initialization of JACC provider.

initJACC

boolean initJACC()

Returns:

true if JACC provider needs to be initialized at startup.

setAddEmbeddedComponents

void setAddEmbeddedComponents(boolean addEmbeddedComponents)

Sets the flag for adding before the startup the core components.

Parameters:

addEmbeddedComponents - the boolean value

addEmbeddedComponents

boolean addEmbeddedComponents()

Returns:

true if the core components need to be added before the startup of Embedded.

isStartJMXConnector

boolean isStartJMXConnector()

Returns:

true if EasyBeans will start the JMX connector.

setStartJMXConnector

void setStartJMXConnector(boolean startJMXConnector)

Enable or disable the JMX connector.

Parameters:

startJMXConnector - true/false.

isRegisterDeployerMBean

boolean isRegisterDeployerMBean()

Returns:

true if Deployer needs to be registered.

setRegisterDeployerMBean

void setRegisterDeployerMBean(boolean registerDeployerMBean)

Enable or disable the Deployer MBean.

Parameters:

registerDeployerMBean - true/false.

isRegisterJ2EEServerMBean

boolean isRegisterJ2EEServerMBean()

Returns:

true if Deployer needs to be registered.

setRegisterJ2EEServerMBean

void setRegisterJ2EEServerMBean(boolean registerJ2EEServerMBean)

Enable or disable the J2EEServer MBean.

Parameters:

registerJ2EEServerMBean - true/false.

isAutoConfigureComponents

boolean isAutoConfigureComponents()

Returns:

true if components are managed by EasyBeans and not externally.

setAutoConfigureComponents

void setAutoConfigureComponents(boolean autoConfigureComponents)

Sets the flag for managing components in EasyBeans.

Parameters:

autoConfigureComponents - if true, managed by EasyBeans

getDescription

String getDescription()

Returns:

a description of the embedded server

setDescription

void setDescription(String description)

Sets a description of the embedded server.

Parameters:

description - a description of the embedded server

setStopComponentsDuringShutdown

void setStopComponentsDuringShutdown(boolean stopComponents)

Specify if the components should be stopped during shutdown sequence.

Parameters:

stopComponents - true if components should be stopped during shutdown sequence

isStopComponentsDuringShutdown

boolean isStopComponentsDuringShutdown()

Returns:

true if components should be stopped during shutdown sequence

getConfigurationURLs

LinkedList<URL> getConfigurationURLs()

Returns:

the list of the URLs that will be used to configure EasyBeans.

setConfigurationURLs

void setConfigurationURLs(LinkedList<URL> configurationURLs)

Sets the list of the URLs used to configure EasyBeans.

Parameters:

configurationURLs - the list of URLs

getConfigurationMap

Map<String,Object> getConfigurationMap()

Returns:

the configuration map.

setConfigurationMap

void setConfigurationMap(Map<String,Object> configurationMap)

Sets the configuration map.

Parameters:

configurationMap - the given map

isUsingLegacyNamingStrategy

boolean isUsingLegacyNamingStrategy()

Use or not the EasyBeans v1 legacy naming strategy.

Returns:

true if this is the case.

setUseLegacyNamingStrategy

void setUseLegacyNamingStrategy(boolean useLegacyNamingStrategy)

Sets the value for EasyBeans v1 legacy naming strategy.

Parameters:

useLegacyNamingStrategy - the boolean value.