com.foreach.common.spring.context

Class ApplicationContextInfo

java.lang.Object

com.foreach.common.spring.context.ApplicationContextInfo

All Implemented Interfaces:

ApplicationInfo

public class ApplicationContextInfo
extends Object
implements ApplicationInfo

This class is deprecated, favour the more simple ApplicationInfo interface. This class groups application metadata.

Because some of the metadata may only be available at build time, you will usually have spring instantiate this object as a bean from xml.

You can refer to this bean from other beans that handle errors or provide environment dependent logic.

An example spring configuration:

  <bean id="applicationContextInfo" class="com.foreach.spring.context.ApplicationContextInfo">
      <property name="environmentLabel" value="${app.environment}"/>
      <-- see ApplicationEnvironment --/>
      <property name="applicationName" value="${app.name}"/>
      <property name="label" value="${app.label}"/>
      <property name="buildNumber" value="${build.number}"/>
      <property name="buildDate" value="${build.date}"/>
  </bean>
 

See Also:

ApplicationInfo, MutableApplicationInfo

Constructor Summary

Constructors

Constructor and Description
ApplicationContextInfo()

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() Example: myapp
String	getApplicationName() Returns the specified application name
Date	getBuildDate() Returns the build date of the current application
String	getBuildId() Could be a build number from the build server, revision number from source control etc.
long	getBuildNumber() Returns the build number of the current application
ApplicationEnvironment	getEnvironment() Deprecated.
String	getEnvironmentId() Example: test
String	getEnvironmentName() Example: Test environment
String	getHostName() Example: localhost
String	getInstanceId() Application instance is usually a combination of the application, environment and hostname.
String	getLabel() Returns the specified label of the current application
Date	getStartupDate() Returns the start-up date of the current application.
boolean	isRunningIn(ApplicationEnvironment environmentToCheck) Method to check whether the current application is running in given mode.
boolean	isRunningIn(String environmentId)
void	setApplicationName(String applicationName) Specify an application name
void	setBuildDate(Date buildDate) Specify the build date of current application
void	setBuildNumber(long buildNumber) Specify the build number of the current application
void	setEnvironment(ApplicationEnvironment environment) Specify a ApplicationEnvironment enum for the current environment, the specified enum should be one of ApplicationEnvironment
void	setEnvironmentId(String environmentId)
void	setEnvironmentLabel(String environmentLabel) Deprecated.
void	setHostName(String hostName)
void	setLabel(String label) Specify a readable label for the current application
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationContextInfo

public ApplicationContextInfo()

Method Detail

getInstanceId

public String getInstanceId()

Application instance is usually a combination of the application, environment and hostname.

Example: myapp-test-localhost

Specified by:

getInstanceId in interface ApplicationInfo

Returns:

The unique id of the application instance.

getApplicationId

public String getApplicationId()

Example: myapp

Specified by:

getApplicationId in interface ApplicationInfo

Returns:

The id of the application.

getHostName

public String getHostName()

Description copied from interface: ApplicationInfo

Example: localhost

Specified by:

getHostName in interface ApplicationInfo

Returns:

The name of infrastructure hosting this application.

setHostName

public void setHostName(String hostName)

setEnvironmentLabel

@Deprecated
public final void setEnvironmentLabel(String environmentLabel)

Deprecated.

Specify ApplicationEnvironment label for the current environment, the specified label should be one of ApplicationEnvironment

Parameters:

environmentLabel -

setEnvironment

public final void setEnvironment(ApplicationEnvironment environment)

Specify a ApplicationEnvironment enum for the current environment, the specified enum should be one of ApplicationEnvironment

Parameters:

environment -

setEnvironmentId

public void setEnvironmentId(String environmentId)

getEnvironmentId

public String getEnvironmentId()

Example: test

Specified by:

getEnvironmentId in interface ApplicationInfo

Returns:

The id of the environment this application is running in.

getEnvironmentName

public String getEnvironmentName()

Example: Test environment

Specified by:

getEnvironmentName in interface ApplicationInfo

Returns:

The descriptive name of the environment.

getEnvironment

@Deprecated
public final ApplicationEnvironment getEnvironment()

Deprecated.

Returns the current application environment

isRunningIn

public final boolean isRunningIn(ApplicationEnvironment environmentToCheck)

Method to check whether the current application is running in given mode. Used for environment dependent logic.

Parameters:

environmentToCheck -

Returns:

true if environment is not null and equal to environmentToCheck, false otherwise.

isRunningIn

public boolean isRunningIn(String environmentId)

Specified by:

isRunningIn in interface ApplicationInfo

Parameters:

environmentId - Id of the environment to check against.

Returns:

True if the application is running in that environment.

setLabel

public final void setLabel(String label)

Specify a readable label for the current application

Parameters:

label -

getLabel

public final String getLabel()

Returns the specified label of the current application

setApplicationName

public final void setApplicationName(String applicationName)

Specify an application name

Parameters:

applicationName -

getApplicationName

public final String getApplicationName()

Returns the specified application name

Specified by:

getApplicationName in interface ApplicationInfo

Returns:

The descriptive name of the application.

setBuildNumber

public final void setBuildNumber(long buildNumber)

Specify the build number of the current application

Parameters:

buildNumber - a number corresponding to a unique build to facilitate defect tracking.

getBuildNumber

public final long getBuildNumber()

Returns the build number of the current application

getBuildId

public String getBuildId()

Could be a build number from the build server, revision number from source control etc.

Specified by:

getBuildId in interface ApplicationInfo

Returns:

The id of the build

setBuildDate

public final void setBuildDate(Date buildDate)

Specify the build date of current application

Parameters:

buildDate - the date the application was built.

getBuildDate

public final Date getBuildDate()

Returns the build date of the current application

Specified by:

getBuildDate in interface ApplicationInfo

Returns:

Timestamp of the build.

getStartupDate

public final Date getStartupDate()

Returns the start-up date of the current application. This value is set automatically at instantiation.

Specified by:

getStartupDate in interface ApplicationInfo

Returns:

Timestamp when the application was considered to be started up.

toString

public final String toString()

Overrides:

toString in class Object