com.bigdata

Class Banner

java.lang.Object

com.bigdata.Banner

public class Banner
extends Object

Class has a static method which writes a copyright banner on stdout once per JVM. This method is invoked from several core classes in order to ensure that the copyright banner is always written out on bigdata startup.

Author:

Bryan Thompson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Banner.BuildInfoMeta An interface which declares the keys for the map returned by getBuildInfo() .
static interface	Banner.Options Environment variables understood by the Banner class.

Constructor Summary

Constructors

Constructor and Description
Banner()

Method Summary

Methods

Modifier and Type	Method and Description
static void	banner() Display the banner, dependencies, etc.
static String	getBanner() Return the banner.
static Map<String,String>	getBuildInfo() Method used to discover and report on the bigdata build information.
static String	getFullyqualifiedhostname() Returns fully qualified host name from static initialization.
static Map<String,String>	getStaticVariables(String className) Utility class to get the static string variables for a given class name.
static String	getVersion() Attempts to return the build version (aka the release version) from the com.bigdata.BuildInfo class.
static void	main(String[] args) Outputs the banner and exits.

Methods inherited from class java.lang.Object

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

Constructor Detail

Banner

public Banner()

Method Detail

getFullyqualifiedhostname

public static String getFullyqualifiedhostname()

Returns fully qualified host name from static initialization. Moved from AbstractStatisticsCollector for BLZG-1497.

Returns:

banner

public static void banner()

Display the banner, dependencies, etc.

getBuildInfo

public static Map<String,String> getBuildInfo()

Method used to discover and report on the bigdata build information. A com.bigdata.BuildInfo class is built when the JAR is created. However, it may not be present when running under an IDE from the source code and, therefore, there MUST NOT be any compile time references to the com.bigdata.BuildInfo class. This method uses reflection to avoid a compile time dependency.

Note: This method works fine. However, people running from an IDE will observe stale data from old com.bigdata.BuildInfo class files left from a previous build of a JAR. This makes the information good for deployed versions of the JAR but potentially misleading when people are running under an IDE.

Returns:

Build info metadata iff available.

See Also:

Banner.BuildInfoMeta

getStaticVariables

public static Map<String,String> getStaticVariables(String className)

Utility class to get the static string variables for a given class name.

Parameters:

className -

Returns:

getVersion

public static final String getVersion()

Attempts to return the build version (aka the release version) from the com.bigdata.BuildInfo class. This class is generated by build.xml and is NOT available from the IDE. It is correct discovered using reflection.

Returns:

Build version if available and null otherwise.

See Also:

getBuildInfo()

getBanner

public static String getBanner()

Return the banner.

main

public static void main(String[] args)

Outputs the banner and exits.

Parameters:

args - Ignored.