com.nsysmon.config.appinfo

Class ADefaultApplicationInfoProvider

java.lang.Object

com.nsysmon.config.appinfo.ADefaultApplicationInfoProvider

All Implemented Interfaces:

AApplicationInfoProvider

public class ADefaultApplicationInfoProvider
extends Object
implements AApplicationInfoProvider

Author:

arno

Constructor Summary

Constructors

Constructor and Description
ADefaultApplicationInfoProvider(String applicationName, String version)
ADefaultApplicationInfoProvider(String applicationName, String version, String deployment, String nodeId)

Method Summary

Modifier and Type	Method and Description
static String	calcDeployment() provides a 'deployment' string based on machine and user
static String	calcHtmlColor(AApplicationInfoProvider appInfo) calculates an HTML color code based on the hash codes of the application info values.
String	getApplicationName() This is a high-level name of the application per se, regardless of version or deployment.
String	getDeployment() This string identifies one 'instance' of a system.
String	getHtmlColorCode() This color code is used in presentation to allows users to distinguish between different deployments at a glance, e.g.
String	getNodeId() This string is relevant only in a clustered deployment, where it distinguishes between different nodes of a cluster.
String	getVersion() This is the logical name of the software version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ADefaultApplicationInfoProvider

public ADefaultApplicationInfoProvider(String applicationName,
                                       String version)
                                throws UnknownHostException

Throws:

UnknownHostException

ADefaultApplicationInfoProvider

public ADefaultApplicationInfoProvider(String applicationName,
                                       String version,
                                       String deployment,
                                       String nodeId)

Method Detail

getApplicationName

public String getApplicationName()

Description copied from interface: AApplicationInfoProvider

This is a high-level name of the application per se, regardless of version or deployment. This could be something like 'product server' or 'customer portal'.

Specified by:

getApplicationName in interface AApplicationInfoProvider

getVersion

public String getVersion()

Description copied from interface: AApplicationInfoProvider

This is the logical name of the software version.

Specified by:

getVersion in interface AApplicationInfoProvider

getDeployment

public String getDeployment()

Description copied from interface: AApplicationInfoProvider

This string identifies one 'instance' of a system. This should be a unique identifier for every JVM across the network (except for cluster nodes, which should share the same value). Values should stay the same across reboots, restarts and re-deployments.

This value is intended to allow aggregation (or comparison) of values from several JVMs in a central database.

This could be the name of a stage, e.g. 'prod' or 'qa-1', or for local developer deployments something like 'local-arno'.

Specified by:

getDeployment in interface AApplicationInfoProvider

getNodeId

public String getNodeId()

Description copied from interface: AApplicationInfoProvider

This string is relevant only in a clustered deployment, where it distinguishes between different nodes of a cluster.

Specified by:

getNodeId in interface AApplicationInfoProvider

getHtmlColorCode

public String getHtmlColorCode()

Description copied from interface: AApplicationInfoProvider

This color code is used in presentation to allows users to distinguish between different deployments at a glance, e.g. using 'red' for production environments.

There is a generic implementation that calculates the HTML color code from the other values.

Specified by:

getHtmlColorCode in interface AApplicationInfoProvider

calcDeployment

public static String calcDeployment()
                             throws UnknownHostException

provides a 'deployment' string based on machine and user

Throws:

UnknownHostException

calcHtmlColor

public static String calcHtmlColor(AApplicationInfoProvider appInfo)

calculates an HTML color code based on the hash codes of the application info values.