hirondelle.web4j
Interface ApplicationInfo

public interface ApplicationInfo

Static, descriptive information for a web application.

Implemenations of this interface are usually quite simple. Here is the implementation used in the WEB4J example application.

See BuildImpl for important information on how this item is configured. BuildImpl.forApplicationInfo() returns the configured implementation of this interface.

Upon startup, WEB4J creates an object which implements this interface, and places it into application scope under a KEY, where it is accessible to response pages. (For example, it may be referenced in a footer.) For access in code, the caller can simply refer directly to BuildImpl.forApplicationInfo(). In addition, this data is logged during startup, and contributes to the content of TroubleTicket emails.

No method in this interface returns a null object reference.

Field Summary

static String

KEY Key for the ApplicationInfo object placed in application scope.

Method Summary

String	getAuthor() The author of this web application.
DateTime	getBuildDate() The date which this binary version of the web application was built.
String	getLink() URL for more information regarding this application.
String	getMessage() A general message of arbitrary content.
String	getName() The name of this web application.
String	getVersion() The version of this web application.

Field Detail

KEY

static final String KEY

Key for the ApplicationInfo object placed in application scope.

See Also:

Constant Field Values

Method Detail

getName

String getName()

The name of this web application.

getVersion

String getVersion()

The version of this web application.

The content is arbitrary, and make take any desired form. Examples : "1.2.3", "Build 1426".

getAuthor

String getAuthor()

The author of this web application.

getBuildDate

DateTime getBuildDate()

The date which this binary version of the web application was built.

getLink

String getLink()

URL for more information regarding this application.

getMessage

String getMessage()

A general message of arbitrary content.