Class BaseApp

java.lang.Object

ch.autumo.commons.application.BaseApp

All Implemented Interfaces:

LicensedApplication, SecureApplication

public abstract class BaseApp
extends Object
implements LicensedApplication

A console application. For a server use the autumo beetRoot-library (Class: BaseServer). In any case you always can use the getters from the ConfigurationManager to retrieve any configuration parameter.

See Also:

• autumo beetRoot.
• SecureApplication
• LicensedApplication

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ansiErrName	ANSI colored application name for errors.
protected static String	ansiName	ANSI colored application name.
protected String	baseCfgFile	Base configuration file ('cfg/app.cfg').
protected Properties	baseProps	Base configuration properties.
protected static final org.slf4j.Logger	LOG	Logger.
protected static String	rootPath	Root path of application.

Fields inherited from interface LicensedApplication

AP_LS_AD_KEY, AP_LS_AK_KEY, BASE_CFG_FILE, BASE_CFG_JAR, CONFIG_DEFAULT_FILE, CONFIG_PATH, FILE_REG_SOURCE, INLINE_CHECKS_KEY, LIC_CHARS, LIC_INFO_FILE, LIC_PATH, LIC_TYPE_KEY, LICENSE_PUBLIC_KEY, PROD_KEY, RT_TYPE_KEY

Modifier and Type	Field	Description
static final String	AP_LS_AD_KEY	autumo products license server address from 'base.ifc'.
static final String	AP_LS_AK_KEY	autumo products license server API key from 'base.ifc'.
static final String	BASE_CFG_FILE	Base config file.
static final String	BASE_CFG_JAR	Base config jar.
static final String	CONFIG_DEFAULT_FILE	Default config file.
static final String	CONFIG_PATH	Interface config path.
static final String	FILE_REG_SOURCE	License registration file with temporary extension.
static final String	INLINE_CHECKS_KEY	Inline checks key from 'base.ifc'.
static final String	LIC_CHARS	Allowed lic key chars.
static final String	LIC_INFO_FILE	License info file.
static final String	LIC_PATH	License path.
static final String	LIC_TYPE_KEY	License type key from 'base.ifc'.
static final String	LICENSE_PUBLIC_KEY	license public key from 'base.ifc'.
static final String	PROD_KEY	Product key from 'base.ifc'.
static final String	RT_TYPE_KEY	Runtime type key from 'base.ifc'.

Fields inherited from interface SecureApplication

SEC_KEY_SEED

Modifier and Type	Field	Description
static final String	SEC_KEY_SEED	Security key seed configuration parameter name.

Constructor Summary

Constructors

Constructor	Description
BaseApp()	Because of SecureApplication and when console tools such as the Encoder are used.
BaseApp(RegistrationVersion regVersion)	Because of LicensedApplication and when console tools such as the Register are used.
BaseApp(String[] params)	Create the application.

Method Summary

Modifier and Type	Method	Description
String	getApiKey()	Get API key for online license server.
abstract String	getAppTitle()	Get application title.
abstract String	getAppVersion()	Get application version.
protected final Properties	getBaseProperties()	Get base properties (properties from 'cfg/base.ifc').
protected final String	getBasePropertiesFile()	Get base properties file ('cfg/base.ifc') for possible modifications; e.g.
final String	getConfigurationParameter(String key)	Get a configuration parameter/value.
InlineChecks	getInlineChecks()	Overwrite if inline-checks are used!
String	getInternalSecurityKey()	Overwrite if you want to use an own internal security key.
static String	getInternalSecurityKeyDate()	Get the date the internal security key was last changed (ISO-8601), read from the ISK_RESOURCE resource.
final String	getLicensePath()	Get local path to license.
final String	getLicInfoTitle()	Get license info title - unique for every application.
String	getLicSrvUrl()	Get license server URL.
String	getLicType()	Overwrite if there's a specific license version; e.g.
String	getPassphrase()	The pass phrase the Encoder asks for when a value is decoded on the console: the second half of the internal security key.
String	getProductKey()	You most likely want to overwrite this method if your application can be registered or is registered and product key is not read and decrypted from 'base.ifc'.
String	getPublicKey()	Get public key.
RegistrationVersion	getRegVersion()	You most likely want to overwrite this method if your application can be registered or is registered.
String	getRuntimeType()	Overwrite if there's a specific runtime version; e.g.
final String	getUniqueSecurityKey()	Returns an unique security key, which should different for every app.
protected abstract void	initialize(String[] params)	Initialization.
void	initializeBaseConfig(String rootFolder)	Initializes the base configuration if any ('base.ifc').
protected void	initializeLogging(String logCfgFile)	Initialize logging.
final boolean	isAllowed2ReadEnvData()	Identifies if this application is allowed to read environment data during online registration.
final boolean	isLicenseAccepted()	Is license accepted flag set?
final void	licenseAccepted()	Set license accepted flag.
final void	setAllowed2ReadEnvData(boolean allow)	Set application to allow to read user's environment data through online registration process.

Methods inherited from class Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

Logger.

rootPath

protected static String rootPath

Root path of application.

ansiName

protected static String ansiName

ANSI colored application name.

ansiErrName

protected static String ansiErrName

ANSI colored application name for errors.

baseCfgFile

protected String baseCfgFile

Base configuration file ('cfg/app.cfg').

baseProps

protected Properties baseProps

Base configuration properties.

Constructor Details

BaseApp

public BaseApp()

Because of SecureApplication and when console tools such as the Encoder are used.

BaseApp

public BaseApp(RegistrationVersion regVersion)

Because of LicensedApplication and when console tools such as the Register are used.

Parameters:

regVersion - injected registration version

BaseApp

public BaseApp(String[] params)

Create the application.

Parameters:

params - console arguments

Method Details

getConfigurationParameter

public final String getConfigurationParameter(String key)

Get a configuration parameter/value.

Parameters:

key - key

Returns:

value or null

licenseAccepted

public final void licenseAccepted()

Set license accepted flag.

isLicenseAccepted

public final boolean isLicenseAccepted()

Is license accepted flag set?

Returns:

true, if so

initialize

protected abstract void initialize(String[] params)

Initialization.

Parameters:

params - program arguments (from console)

getAppVersion

public abstract String getAppVersion()

Get application version. It is also used for online upgrade checks, if applied.

Specified by:

getAppVersion in interface LicensedApplication

Returns:

application version

getAppTitle

public abstract String getAppTitle()

Get application title. Part of the online license check, if applied.

Specified by:

getAppTitle in interface LicensedApplication

Returns:

application title

initializeLogging

protected void initializeLogging(String logCfgFile)

Initialize logging.

Parameters:

logCfgFile - logging configuration file (usually 'cfg/logging.cml').

getBaseProperties

protected final Properties getBaseProperties()

Get base properties (properties from 'cfg/base.ifc'). Used for optional runtime checks.

Returns:

base properties

getBasePropertiesFile

protected final String getBasePropertiesFile()

Get base properties file ('cfg/base.ifc') for possible modifications; e.g. trial period, etc. Used for optional runtime checks.

Returns:

base properties

getInternalSecurityKey

public String getInternalSecurityKey()

Overwrite if you want to use an own internal security key. It is only used when this application is licensed through autumo's licensing mechanism that involves an autumo license server. Contact autumo for more information.

The default implementation reads the key from the resource autumo.isk, which is looked up relative to this class. The resource is read lazily on the first call and then kept in memory; it is also found when the library is packaged inside a JAR. The resource must carry a valid key (16 hex bytes) and a date entry, otherwise an IllegalStateException is thrown.

Specified by:

getInternalSecurityKey in interface SecureApplication

Returns:

internal security key

See Also:

• SecureApplication.getInternalSecurityKey()

getUniqueSecurityKey

public final String getUniqueSecurityKey()

Description copied from interface: SecureApplication

Returns an unique security key, which should different for every app. It is used for general encryption (transport and other secrets) in the app. Must be a HEX, 32 Bit long.

Specified by:

getUniqueSecurityKey in interface SecureApplication

Returns:

security key

See Also:

• SecureApplication.getUniqueSecurityKey()

getPassphrase

public String getPassphrase()

The pass phrase the Encoder asks for when a value is decoded on the console: the second half of the internal security key.

Specified by:

getPassphrase in interface SecureApplication

Returns:

pass-phrase

See Also:

• SecureApplication.getPassphrase()

initializeBaseConfig

public void initializeBaseConfig(String rootFolder)
                          throws Exception

Description copied from interface: LicensedApplication

Initializes the base configuration if any ('base.ifc'). The root folder is usually base application configuration path where the file application configuration 'app.cfg' lies. It is given as a parameter, because the base configuration will possibly be loaded on demand in different context (e.g. registration tool, GUI desktop, etc.). In some cases you might want to overwrite this method to get access to more encrypted base configuration values. The encrypted values follow the encryption scheme of Encoder. Use this encoder with the 'internal'-option to get such values.

Specified by:

initializeBaseConfig in interface LicensedApplication

Parameters:

rootFolder - base configuration root folder or null when the configuration context must be resolved differently, e.g. within a desktop application.

Throws:

Exception - if initialization fails

getLicensePath

public final String getLicensePath()

Description copied from interface: LicensedApplication

Get local path to license.

Specified by:

getLicensePath in interface LicensedApplication

Returns:

license path

getLicInfoTitle

public final String getLicInfoTitle()

Description copied from interface: LicensedApplication

Get license info title - unique for every application.

Specified by:

getLicInfoTitle in interface LicensedApplication

Returns:

license info title

isAllowed2ReadEnvData

public final boolean isAllowed2ReadEnvData()

Description copied from interface: LicensedApplication

Identifies if this application is allowed to read environment data during online registration.

Specified by:

isAllowed2ReadEnvData in interface LicensedApplication

Returns:

true if so

setAllowed2ReadEnvData

public final void setAllowed2ReadEnvData(boolean allow)

Description copied from interface: LicensedApplication

Set application to allow to read user's environment data through online registration process.

Specified by:

setAllowed2ReadEnvData in interface LicensedApplication

Parameters:

allow - allow to read client environment data

getRuntimeType

public String getRuntimeType()

Overwrite if there's a specific runtime version; e.g. Trial, Full version.

Specified by:

getRuntimeType in interface LicensedApplication

Returns:

RT type

See Also:

• LicenseHandler.checkRuntimeLicense(LicensedApplication, java.util.Properties, String)

getLicType

public String getLicType()

Overwrite if there's a specific license version; e.g. Basic, Professional, Enterprise.

Specified by:

getLicType in interface LicensedApplication

Returns:

lic type

getInlineChecks

public InlineChecks getInlineChecks()

Overwrite if inline-checks are used!

Specified by:

getInlineChecks in interface LicensedApplication

Returns:

inline checks

getApiKey

public String getApiKey()

Description copied from interface: LicensedApplication

Get API key for online license server.

Specified by:

getApiKey in interface LicensedApplication

Returns:

API key

getPublicKey

public String getPublicKey()

Description copied from interface: LicensedApplication

Get public key.

Specified by:

getPublicKey in interface LicensedApplication

Returns:

public key

getLicSrvUrl

public String getLicSrvUrl()

Description copied from interface: LicensedApplication

Get license server URL.

Specified by:

getLicSrvUrl in interface LicensedApplication

Returns:

license server URL

getProductKey

public String getProductKey()

You most likely want to overwrite this method if your application can be registered or is registered and product key is not read and decrypted from 'base.ifc'. Must match the product key configured at the autumo product license server. Part of the online license check, if applied.

Specified by:

getProductKey in interface LicensedApplication

Returns:

product key

getRegVersion

public RegistrationVersion getRegVersion()

You most likely want to overwrite this method if your application can be registered or is registered. Part of the whole licensing mechanism, if applied.

Specified by:

getRegVersion in interface LicensedApplication

Returns:

registration version

getInternalSecurityKeyDate

public static String getInternalSecurityKeyDate()

Get the date the internal security key was last changed (ISO-8601), read from the ISK_RESOURCE resource.

Returns:

the ISK date