org.adroitlogic.ultraesb.api

Class Environment

java.lang.Object

org.adroitlogic.ultraesb.api.Environment

public class Environment
extends Object

Defines the environment for UltraESB which controls the runtime behavior of the system. There are few pre-defined environments named as follows with the respective properties;

Environment Name	Binary Class Reloading	Configuration Auto Refresh
DEV	Enabled	Disabled
IDE	Enabled	Enabled
UNIT_TEST	Disabled	Disabled
SAMPLE	Disabled	Disabled
TEST	Enabled	Disabled
STAGE	Enabled	Disabled
PROD	Enabled	Disabled

Any of the above environments can be specified as your environment, with specifying the name as a constructor argument to the Environment. The name is case insensitive so "DEV", "dev", "Dev" and "dEv" all represent the predefined dev environment. This environment doesn't require the properties as the system will use the properties as per the above table in defining the UltraESB system behavior.

Custom user defined environments can also be used, which requires the specification of the properties associated with that custom configuration. One could also use a pre-defined environment and overwrite any properties in the spring configuration

Since:

2.0.0

Author:

Ruwan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Environment.NamedEnv Represent the pre-defined named environments

Constructor Summary

Constructors

Constructor and Description
Environment(String name) Constructs an Environment with the given name, while there are pre-defined environments as described in the header comment, you could build your custom environment too.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Gets the name of the environment
boolean	isBinaryClassReloadingEnabled() Whether binary class reloading or class hot swapping is enabled at the runtime, so that invoking the method add or update DeploymentUnit to add or update a configuration will use the re-loaded classes.
boolean	isConfigAutoRefreshEnabled() Whether on the fly configuration updating is enabled.
boolean	isDeploymentUnitsEnabled() Whether to load deployment units or not
boolean	isOnTheFlyCompilationEnabled() Checks the on the fly compilation status
boolean	isTuned() Whether the environment is tuned for performance
boolean	isUnitTestMode() Whether the server is started for a unit test
void	setBinaryClassReloadingEnabled(boolean binaryClassReloadingEnabled) Sets whether the binary class reloading or the class hot swapping is enabled at runtime, so that invoking the method add or update DeploymentUnit to add or update a configuration will use the re-loaded classes.
void	setConfigAutoRefreshEnabled(boolean configAutoRefreshEnabled) Sets whether on the fly configuration updating is enabled.
void	setDeploymentUnitsEnabled(boolean deploymentUnitsEnabled) Sets whether the deployment units are enabled
void	setOnTheFlyCompilationEnabled(boolean onTheFlyCompilationEnabled) Sets the on the fly compilation status
void	setTuned(boolean tuned) Sets whether the environment is tuned or not
void	setUnitTestMode(boolean unitTestMode) Sets whether the server is running in a unit test mode or not

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Environment

public Environment(String name)

Constructs an Environment with the given name, while there are pre-defined environments as described in the header comment, you could build your custom environment too.

Parameters:

name - name of the environment, with pre-defined values for "dev", "test", "unit_test", "sample", "stage" and "prod"

Method Detail

isBinaryClassReloadingEnabled

public boolean isBinaryClassReloadingEnabled()

Whether binary class reloading or class hot swapping is enabled at the runtime, so that invoking the method add or update DeploymentUnit to add or update a configuration will use the re-loaded classes.

Returns:

true if hot swapping is enabled, otherwise false

setBinaryClassReloadingEnabled

public void setBinaryClassReloadingEnabled(boolean binaryClassReloadingEnabled)

Sets whether the binary class reloading or the class hot swapping is enabled at runtime, so that invoking the method add or update DeploymentUnit to add or update a configuration will use the re-loaded classes.

Parameters:

binaryClassReloadingEnabled - true to enable hot swapping of classes

isConfigAutoRefreshEnabled

public boolean isConfigAutoRefreshEnabled()

Whether on the fly configuration updating is enabled. This is usually important in development environments where the UltraESB is running on an IDE while developing the configurations

** Note: Not recommended to be used in production environments

Returns:

true if configuration auto refreshing is enabled, otherwise false

setConfigAutoRefreshEnabled

public void setConfigAutoRefreshEnabled(boolean configAutoRefreshEnabled)

Sets whether on the fly configuration updating is enabled. This is usually important in development environments where the UltraESB is running on an IDE while developing the configurations

** Note: Not recommended to be used in production environments

Parameters:

configAutoRefreshEnabled - true to enable configuration auto refreshing

isUnitTestMode

public boolean isUnitTestMode()

Whether the server is started for a unit test

Returns:

true if the server is running a unit test

setUnitTestMode

public void setUnitTestMode(boolean unitTestMode)

Sets whether the server is running in a unit test mode or not

Parameters:

unitTestMode - whether server is running in unit test mode

isTuned

public boolean isTuned()

Whether the environment is tuned for performance

Returns:

true if it should be tuned

setTuned

public void setTuned(boolean tuned)

Sets whether the environment is tuned or not

Parameters:

tuned - whether the server should be tuned or not

isDeploymentUnitsEnabled

public boolean isDeploymentUnitsEnabled()

Whether to load deployment units or not

Returns:

true if deployment units are enabled

setDeploymentUnitsEnabled

public void setDeploymentUnitsEnabled(boolean deploymentUnitsEnabled)

Sets whether the deployment units are enabled

Parameters:

deploymentUnitsEnabled - whether the deployment units are enabled

isOnTheFlyCompilationEnabled

public boolean isOnTheFlyCompilationEnabled()

Checks the on the fly compilation status

Returns:

if the on the fly compilation is enabled, true and false otherwise

setOnTheFlyCompilationEnabled

public void setOnTheFlyCompilationEnabled(boolean onTheFlyCompilationEnabled)

Sets the on the fly compilation status

Parameters:

onTheFlyCompilationEnabled - the on the fly compilation status to be set

getName

public String getName()

Gets the name of the environment

Returns:

name of the environment