com.barchart.udt.lib
Class PluginPropsUDT

java.lang.Object
  com.barchart.udt.lib.PluginPropsUDT

public class PluginPropsUDT
extends Object

maven-nar-plugin build-time properties which determine library name and path conventions; AOL stands for "arch/os/linker"

Field Summary

protected static String	AOL_CPP_COMPILER suffix for c++ compiler configured for platform in NAR_AOL_PROPERTIES file
protected static String	AOL_JNI_EXTENSION suffix for JNI library file extension as defined in NAR_AOL_PROPERTIES file
protected static String	AOL_LINKER_DEPENDENCY suffix for dependency libraries as defined in NAR_AOL_PROPERTIES file
protected static String	AOL_SHARED_PREFIX suffix for shared library file prefix as defined in NAR_AOL_PROPERTIES file
protected static String	EMPTY_VALUE missing / invalid property value representation
protected static org.slf4j.Logger	log
protected static String	NAR_AOL_PROPERTIES NAR properties file; should be present in project root folder during build time for plug-in configuration and as a class path resource during run time for properties lookup.
protected static String	OS_ARCH current architecture reported by JVM
protected static String	OS_NAME current operating system reported by JVM
protected static Properties	props properties from NAR_AOL_PROPERTIES file

Constructor Summary

PluginPropsUDT()

Method Summary

protected static List<String>	currentDependencyLibraries() dependency libraries specified in NAR_AOL_PROPERTIES file
protected static String	currentNarKey() nar key prefix for current arch/os/link
protected static String	currentNarKey(String suffix) full nar key built from arch/os/link prefix and the key suffix
protected static String	currentNarKeyCppCompiler() CPP compiler for the platform
protected static String	currentNarKeyJniExtension() JNI extension for the platform
protected static String	currentNarKeyLinkerDependency() list of dependencies for the platform
protected static String	currentNarKeySharedPrefix() library name prefix for the platform
protected static String	currentNarPath() nar aol path entry for current arch/os/link
protected static List<String>	currentReleaseLibraries(String coreName) list of release library paths expected to be resent for current platform; must be packaged in the jar; used during release delivery
protected static List<String>	currentStagingLibraries(String coreName) list of staging library paths expected to be resent for current platform; must be located on test class path; used during NAR build
protected static List<String>	currentTestingLibraries(String coreName) list of testing library paths expected to be resent for current platform; must be located on test class path; used during CDT build
protected static String	formatMainLibraryName(String coreName) make main library name with AOL_SHARED_PREFIX and AOL_JNI_EXTENSION convention
protected static String	formatMainReleasePath(String name) location of release main library and dependency libraries in release jar
protected static String	formatMainStagingPath(String coreName) location of staging main library on the test class path
protected static String	formatMainTestingPath(String coreName) location of testing main library on the test class path
protected static String	formatNarKey(String arch, String os, String link) NAR_AOL_PROPERTIES property key prefix
protected static String	formatNarPath(String arch, String os, String link) NAR_AOL_PROPERTIES aol path element
protected static String	formatTestingDependencyPath(String name) location of dependency libraries on test class path
protected static boolean	isSupportedPlatform() is current platform defined in NAR_AOL_PROPERTIES file?
protected static String	narARCH() map JVM arch name to NAR arch name
protected static String	narLINK() map JVM arch/os name to NAR tool chain name
protected static String	narOS() map JVM os name to NAR os name
protected static String	property(String key) find property entry in the NAR_AOL_PROPERTIES file

Methods inherited from class java.lang.Object

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

Field Detail

AOL_CPP_COMPILER

protected static final String AOL_CPP_COMPILER

suffix for c++ compiler configured for platform in NAR_AOL_PROPERTIES file

See Also:

Constant Field Values

AOL_JNI_EXTENSION

protected static final String AOL_JNI_EXTENSION

suffix for JNI library file extension as defined in NAR_AOL_PROPERTIES file

See Also:

Constant Field Values

AOL_LINKER_DEPENDENCY

protected static final String AOL_LINKER_DEPENDENCY

suffix for dependency libraries as defined in NAR_AOL_PROPERTIES file

See Also:

Constant Field Values

AOL_SHARED_PREFIX

protected static final String AOL_SHARED_PREFIX

suffix for shared library file prefix as defined in NAR_AOL_PROPERTIES file

See Also:

Constant Field Values

EMPTY_VALUE

protected static final String EMPTY_VALUE

missing / invalid property value representation

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

NAR_AOL_PROPERTIES

protected static final String NAR_AOL_PROPERTIES

NAR properties file; should be present in project root folder during build time for plug-in configuration and as a class path resource during run time for properties lookup.

See Also:

Constant Field Values

OS_ARCH

protected static final String OS_ARCH

current architecture reported by JVM

OS_NAME

protected static final String OS_NAME

current operating system reported by JVM

props

protected static final Properties props

properties from NAR_AOL_PROPERTIES file

Constructor Detail

PluginPropsUDT

public PluginPropsUDT()

Method Detail

currentDependencyLibraries

protected static List<String> currentDependencyLibraries()

dependency libraries specified in NAR_AOL_PROPERTIES file

currentNarKey

protected static String currentNarKey()

nar key prefix for current arch/os/link

currentNarKey

protected static String currentNarKey(String suffix)

full nar key built from arch/os/link prefix and the key suffix

currentNarKeyCppCompiler

protected static String currentNarKeyCppCompiler()

CPP compiler for the platform

currentNarKeyJniExtension

protected static String currentNarKeyJniExtension()

JNI extension for the platform

currentNarKeyLinkerDependency

protected static String currentNarKeyLinkerDependency()

list of dependencies for the platform

currentNarKeySharedPrefix

protected static String currentNarKeySharedPrefix()

library name prefix for the platform

currentNarPath

protected static String currentNarPath()

nar aol path entry for current arch/os/link

currentReleaseLibraries

protected static List<String> currentReleaseLibraries(String coreName)

list of release library paths expected to be resent for current platform; must be packaged in the jar; used during release delivery

currentStagingLibraries

protected static List<String> currentStagingLibraries(String coreName)

list of staging library paths expected to be resent for current platform; must be located on test class path; used during NAR build

currentTestingLibraries

protected static List<String> currentTestingLibraries(String coreName)

list of testing library paths expected to be resent for current platform; must be located on test class path; used during CDT build

formatMainLibraryName

protected static String formatMainLibraryName(String coreName)

make main library name with AOL_SHARED_PREFIX and AOL_JNI_EXTENSION convention

formatMainReleasePath

protected static String formatMainReleasePath(String name)

location of release main library and dependency libraries in release jar

formatMainStagingPath

protected static String formatMainStagingPath(String coreName)

location of staging main library on the test class path

formatMainTestingPath

protected static String formatMainTestingPath(String coreName)

location of testing main library on the test class path

formatNarKey

protected static String formatNarKey(String arch,
                                     String os,
                                     String link)

NAR_AOL_PROPERTIES property key prefix

formatNarPath

protected static String formatNarPath(String arch,
                                      String os,
                                      String link)

NAR_AOL_PROPERTIES aol path element

formatTestingDependencyPath

protected static String formatTestingDependencyPath(String name)

location of dependency libraries on test class path

isSupportedPlatform

protected static boolean isSupportedPlatform()

is current platform defined in NAR_AOL_PROPERTIES file?

narARCH

protected static String narARCH()

map JVM arch name to NAR arch name

narLINK

protected static String narLINK()

map JVM arch/os name to NAR tool chain name

narOS

protected static String narOS()

map JVM os name to NAR os name

property

protected static String property(String key)

find property entry in the NAR_AOL_PROPERTIES file