net.sf.mmm.util.lang.api

Interface EnvironmentDetector

All Known Implementing Classes:

AbstractEnvironmentDetector, EnvironmentDetectorSpringProfileImpl

@ComponentSpecification
public interface EnvironmentDetector

This is the interface for a detector of the environment. It can be used for dynamic decision of behavior that shall differ between environments. The common approach is the DTAP setup with the environments Development, Test, Acceptance, and the Production. However, also other more fine-grained environment setups are supported.
ATTENTION:
Unfortunately there is no Java standard for this. Therefore your configuration to setup the environments has to be compliant to the implementation of this interface. Environments can be defined via spring profiles, via JEE application server specific configurations, via custom system properties, etc. The default implementation is using spring profiles so you have to replace it if you choose a different setup.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_TYPE_ACCEPTANCE The environment type for the acceptance environment.
static String	ENVIRONMENT_TYPE_DEVELOPMENT The environment type for the development environment.
static String	ENVIRONMENT_TYPE_PRE_PRODUCTION The environment type for the pre-production environment.
static String	ENVIRONMENT_TYPE_PRODUCTION The environment type for the production environment.
static String	ENVIRONMENT_TYPE_STAGING The environment type for the staging environment.
static String	ENVIRONMENT_TYPE_TEST The environment type for the test environment.

Method Summary

Modifier and Type	Method and Description
String	getEnvironmentType()
boolean	isDevelopmentEnvironment()
boolean	isEnvironmentCloseToProduction()
boolean	isProductionEnvironment()

Field Detail

ENVIRONMENT_TYPE_DEVELOPMENT

static final String ENVIRONMENT_TYPE_DEVELOPMENT

The environment type for the development environment.

See Also:

isDevelopmentEnvironment(), Constant Field Values

ENVIRONMENT_TYPE_TEST

static final String ENVIRONMENT_TYPE_TEST

The environment type for the test environment.

See Also:

Constant Field Values

ENVIRONMENT_TYPE_ACCEPTANCE

static final String ENVIRONMENT_TYPE_ACCEPTANCE

The environment type for the acceptance environment.

See Also:

Constant Field Values

ENVIRONMENT_TYPE_PRODUCTION

static final String ENVIRONMENT_TYPE_PRODUCTION

The environment type for the production environment.

See Also:

isProductionEnvironment(), Constant Field Values

ENVIRONMENT_TYPE_STAGING

static final String ENVIRONMENT_TYPE_STAGING

The environment type for the staging environment.

See Also:

Constant Field Values

ENVIRONMENT_TYPE_PRE_PRODUCTION

static final String ENVIRONMENT_TYPE_PRE_PRODUCTION

The environment type for the pre-production environment.

See Also:

Constant Field Values

Method Detail

getEnvironmentType

String getEnvironmentType()

Returns:

the environment type such as ENVIRONMENT_TYPE_DEVELOPMENT, ENVIRONMENT_TYPE_TEST, ENVIRONMENT_TYPE_ACCEPTANCE, ENVIRONMENT_TYPE_PRODUCTION, or any other custom kind of environment.

isDevelopmentEnvironment

boolean isDevelopmentEnvironment()

Returns:

the result of getEnvironmentType().equals(ENVIRONMENT_TYPE_DEVELOPMENT).

isProductionEnvironment

boolean isProductionEnvironment()

Returns:

the result of getEnvironmentType().equals(ENVIRONMENT_TYPE_PRODUCTION).

isEnvironmentCloseToProduction

boolean isEnvironmentCloseToProduction()

Returns:

true if the environment type is ENVIRONMENT_TYPE_PRODUCTION or close to production such as ENVIRONMENT_TYPE_PRE_PRODUCTION, ENVIRONMENT_TYPE_ACCEPTANCE, or ENVIRONMENT_TYPE_STAGING.