org.opengts.db
Class DBConfig

java.lang.Object
  org.opengts.db.DBConfig

public class DBConfig
extends java.lang.Object

Nested Class Summary

static interface

DBConfig.DBInitialization DBInitialization interface

Field Summary

static java.lang.String[]	ARG_SCHEMA
static java.lang.String	CLASS_RULE_EventRuleFactory
static java.lang.String	env_GTS_HOME The GTS_HOME environment variable name
static java.lang.String	PACKAGE_BCROSS_
static java.lang.String	PACKAGE_BCROSS_TABLES_
static java.lang.String	PACKAGE_EXTRA_
static java.lang.String	PACKAGE_EXTRA_DBTOOLS_
static java.lang.String	PACKAGE_EXTRA_TABLES_
static java.lang.String	PACKAGE_EXTRA_WAR_
static java.lang.String	PACKAGE_OPT
static java.lang.String	PACKAGE_OPT_
static java.lang.String	PACKAGE_OPT_AUDIT_
static java.lang.String	PACKAGE_OPT_WAR_
static java.lang.String	PACKAGE_RULE_
static java.lang.String	PACKAGE_RULE_TABLES_
static java.lang.String	PACKAGE_RULE_UTIL_
static java.lang.String	PACKAGE_WAR_
static java.lang.String	PACKAGE_WAR_TRACK_
static java.lang.String	PROP_db_defaultDeviceAuthorization Runtime Configuration Property True to allow account/user access to "ALL" device group, if no groups are defined. Type: Boolean
static java.lang.String	PROP_db_defaultDeviceAuthorization_ Runtime Configuration Property True to allow account/user access to "ALL" device group, if no groups are defined. (allows specifying specific Account IDs) Type: Boolean
static java.lang.String	PROP_Device_checkLastOdometer Runtime Configuration Property Check event odometer against previous/last save odometer in Device record Type: Boolean
static java.lang.String	PROP_Device_checkNotifySelector Runtime Configuration Property True to test the rule selector in column Device.notifySelector Type: Boolean
static java.lang.String	PROP_Device_checkNotifySelector_ENRE
static java.lang.String	PROP_Device_futureDate_action Runtime Configuration Property Action to perform when an Event date/time is in the future Type: Enum[disabled|ignore|truncate]
static java.lang.String	PROP_Device_futureDate_maximumSec Runtime Configuration Property Maximum number of seconds that an Event date/time may be in the future before the action is performed Type: Integer
static java.lang.String	PROP_Device_invalidSpeed_action Runtime Configuration Property Action to perform when an Event speed is invalid (ie.
static java.lang.String	PROP_Device_invalidSpeed_maximumKPH Runtime Configuration Property Maximum speed that an Event may have, beyond which ithe action is performed (not currently used) Type: Double
static java.lang.String	PROP_Device_keyedLastNotifyTime Runtime Configuration Property True to create an alternate key/index for column Device.lastNotifyTime (can be used for global "Last Notify Time" lookups) Type: Boolean
static java.lang.String	PROP_Device_keyedSimPhoneNumber Runtime Configuration Property True to create an alternate key/index for column Device.simPhoneNumber (can be used for "SIM Phone Number" lookups) Type: Boolean
static java.lang.String	PROP_Device_maintenanceOdometerCount Runtime Configuration Property Returns the number of periodic maintenance odometer values to support (must be less-than-or-equal-to the maximum supported by the Device record) Type: Integer
static java.lang.String	PROP_Device_maximumOdometerKM Runtime Configuration Property Maximum odometer value Type: Double
static java.lang.String	PROP_Device_maximumRuntimeHours Runtime Configuration Property Maximum engine-hours value Type: Double
static java.lang.String	PROP_DeviceInfo_DeviceCmdAlternate_ Runtime Configuration Property Prefix for looking up DeviceInfo.DeviceCmd alternate server IDs Type: String array
static java.lang.String	PROP_EventData_keyedCreationTime Runtime Configuration Property Create alternate keyed "creationTime" in EventData Type: Boolean
static java.lang.String	PROP_EventData_logMissingColumns Runtime Configuration Property Log missing columns on insert/update (defaults to 'true') Type: Boolean
static java.lang.String	PROP_EventFunctionMapFactory_class Runtime Configuration Property The name of the overriding Class used to provide the Rule handling EventFunctionMapFactory. Type: Class
static java.lang.String	PROP_EventIdentifierMapFactory_class Runtime Configuration Property The name of the overriding Class used to provide the Rule handling EventIdentifierMapFactory. Type: Class
static java.lang.String	PROP_FuelRegister_installFuelManager Runtime Configuration Property (optional) Enable FuelManager checking (requires FuelRegister installed). Type: Boolean
static java.lang.String	PROP_FuelRegister_levelDecreaseThreshold Runtime Configuration Property (optional) The FuelLevel "Decrease" percent threshold (between 0.0 and 1.0 inclusive). Type: Double
static java.lang.String	PROP_FuelRegister_levelIncreaseThreshold Runtime Configuration Property (optional) The FuelLevel "Increase" percent threshold (between 0.0 and 1.0 inclusive). Type: Double
static java.lang.String	PROP_Geozone_dftRadius_pointRadius Runtime Configuration Property Default Radius (in meters) for PointRadius Geozones Type: Integer
static java.lang.String	PROP_Geozone_dftRadius_polygon Runtime Configuration Property Default Radius (in meters) for Polygon Geozones Type: Integer
static java.lang.String	PROP_Geozone_dftRadius_sweptPointRadius Runtime Configuration Property Default Radius (in meters) for SweptPointRadius Geozones Type: Integer
static java.lang.String	PROP_GoogleKML_pushpinBaseURL Runtime Configuration Property The base URL for Google pushpins Type: String
static java.lang.String	PROP_RuleList_includeGroupRules Runtime Configuration Property (optional) True to enable checking Device "Group" lookup when triggering rules. Type: Boolean
static java.lang.String	PROP_ServiceAccount_Attr Runtime Configuration Property The customer "Service Account" Attributes (currently not used) Type: RTProperties
static java.lang.String	PROP_ServiceAccount_ID Runtime Configuration Property The customer "Service Account" ID Type: String
static java.lang.String	PROP_ServiceAccount_Key Runtime Configuration Property The customer "Service Account" Authorization Key Type: String
static java.lang.String	PROP_ServiceAccount_Name Runtime Configuration Property The customer "Service Account" Name/Description Type: String
static java.lang.String	PROP_StartupInit_class Runtime Configuration Property The name of the statup-initialization Class used to initialize custom features Type: Class
static java.lang.String	PROP_SubdivisionProvider_class Runtime Configuration Property The name of the overriding Class used to provide latitude/longitude subdivision data. Used for Border-Crossing detection. Type: Class
static java.lang.String	PROP_sysAdmin_account Runtime Configuration Property The name of the SystemAdmin Account ID. Type: String
static java.lang.String	PROP_sysAdminInfo_showEventsPerSecond Runtime Configuration Property Show the "Event-Per-Second" field Type: Boolean
static java.lang.String	PROP_track_baseURI Runtime Configuration Property Base URI used for accesing the GTS login (must match web.xml configuration) Type: String
static java.lang.String	PROP_track_enableService Runtime Configuration Property True to enable web-service access. Type: Boolean
static java.lang.String	PROP_track_js_directory Runtime Configuration Property The overriding directory, used to find the JavaScript code. Type: String
static java.lang.String	PROP_track_offlineFile Runtime Configuration Property The file which contains the text to display when the system is 'Offline'. Type: File
static java.lang.String	PROP_track_requireCookies Runtime Configuration Property True to require that cookies be enabled. If false, session information will be encoded in the URL Type: Boolean
static java.lang.String	PROP_Transport_queryEnabled Runtime Configuration Property True to enable Transport table unique-id lookup. (only required when the Device is separate from the Transport) Type: Boolean
static java.lang.String	PROP_UniqueXID_queryEnabled Runtime Configuration Property True to enable UniqueXID table unique-id lookup. (only required when the UniqueID is separate from the Device) Type: Boolean
protected static RTKey.Entry[]	runtimeKeys

Constructor Summary

DBConfig()

Method Summary

static int	_main(java.lang.String[] argv) Main entry point for providing command-line DB administration tools
static void	addTableFactories() Add the standard DBFactories as-is
static boolean	check_GTS_HOME() Compares the GTS_HOME environment variable to the current directory.
static int	cmdLineInit(java.lang.String[] argv, boolean interactive) Entry point for various programs/tools which initializes the DBFactories
static java.io.File	get_GTS_HOME() Compares the GTS_HOME environment variable to the current directory.
static boolean	GetDefaultDeviceAuthorization(java.lang.String acctID) Returns the Device group "ALL" authorization for the specified Account
static java.lang.String	getServiceAccountAttributes(java.lang.String dft) Return the ServiceAccount Attributes
static java.lang.String	getServiceAccountID(java.lang.String dft) Return the ServiceAccount ID
static java.lang.String	getServiceAccountName(java.lang.String dft) Return the ServiceAccount Name
static java.lang.String	getVersion() Return the GTS build version
static boolean	hasExtraPackage() Returns true if the "extra" package is present
static boolean	hasOptPackage() Returns true if the "opt" package is present
static boolean	hasRulePackage() Returns true if the "rule" package is present
static void	main(java.lang.String[] argv) Main entry point for providing command-line DB administration tools
static void	servletInit(java.util.Properties srvCtxProps)

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_OPT

public static final java.lang.String PACKAGE_OPT

See Also:

Constant Field Values

PACKAGE_OPT_

public static final java.lang.String PACKAGE_OPT_

See Also:

Constant Field Values

PACKAGE_OPT_AUDIT_

public static final java.lang.String PACKAGE_OPT_AUDIT_

See Also:

Constant Field Values

PACKAGE_OPT_WAR_

public static final java.lang.String PACKAGE_OPT_WAR_

See Also:

Constant Field Values

PACKAGE_EXTRA_

public static final java.lang.String PACKAGE_EXTRA_

See Also:

Constant Field Values

PACKAGE_EXTRA_TABLES_

public static final java.lang.String PACKAGE_EXTRA_TABLES_

See Also:

Constant Field Values

PACKAGE_EXTRA_DBTOOLS_

public static final java.lang.String PACKAGE_EXTRA_DBTOOLS_

See Also:

Constant Field Values

PACKAGE_EXTRA_WAR_

public static final java.lang.String PACKAGE_EXTRA_WAR_

See Also:

Constant Field Values

PACKAGE_RULE_

public static final java.lang.String PACKAGE_RULE_

See Also:

Constant Field Values

PACKAGE_RULE_UTIL_

public static final java.lang.String PACKAGE_RULE_UTIL_

See Also:

Constant Field Values

PACKAGE_RULE_TABLES_

public static final java.lang.String PACKAGE_RULE_TABLES_

See Also:

Constant Field Values

CLASS_RULE_EventRuleFactory

public static final java.lang.String CLASS_RULE_EventRuleFactory

See Also:

Constant Field Values

PACKAGE_BCROSS_

public static final java.lang.String PACKAGE_BCROSS_

See Also:

Constant Field Values

PACKAGE_BCROSS_TABLES_

public static final java.lang.String PACKAGE_BCROSS_TABLES_

See Also:

Constant Field Values

PACKAGE_WAR_

public static final java.lang.String PACKAGE_WAR_

See Also:

Constant Field Values

PACKAGE_WAR_TRACK_

public static final java.lang.String PACKAGE_WAR_TRACK_

See Also:

Constant Field Values

PROP_ServiceAccount_ID

public static final java.lang.String PROP_ServiceAccount_ID

Runtime Configuration Property
The customer "Service Account" ID
Type: String

See Also:

Constant Field Values

PROP_ServiceAccount_Name

public static final java.lang.String PROP_ServiceAccount_Name

Runtime Configuration Property
The customer "Service Account" Name/Description
Type: String

See Also:

Constant Field Values

PROP_ServiceAccount_Attr

public static final java.lang.String PROP_ServiceAccount_Attr

Runtime Configuration Property
The customer "Service Account" Attributes
(currently not used)
Type: RTProperties

See Also:

Constant Field Values

PROP_ServiceAccount_Key

public static final java.lang.String PROP_ServiceAccount_Key

Runtime Configuration Property
The customer "Service Account" Authorization Key
Type: String

See Also:

Constant Field Values

PROP_StartupInit_class

public static final java.lang.String PROP_StartupInit_class

Runtime Configuration Property
The name of the statup-initialization Class used to initialize custom features
Type: Class

See Also:

Constant Field Values

PROP_Device_futureDate_action

public static final java.lang.String PROP_Device_futureDate_action

Runtime Configuration Property
Action to perform when an Event date/time is in the future
Type: Enum[disabled|ignore|truncate]

See Also:

Constant Field Values

PROP_Device_futureDate_maximumSec

public static final java.lang.String PROP_Device_futureDate_maximumSec

Runtime Configuration Property
Maximum number of seconds that an Event date/time may be in the future before the action is performed
Type: Integer

See Also:

Constant Field Values

PROP_Device_invalidSpeed_action

public static final java.lang.String PROP_Device_invalidSpeed_action

Runtime Configuration Property
Action to perform when an Event speed is invalid (ie. < '0', or > max km/h)
(not currently used)
Type: Enum[disabled|ignore|truncate]

See Also:

Constant Field Values

PROP_Device_invalidSpeed_maximumKPH

public static final java.lang.String PROP_Device_invalidSpeed_maximumKPH

Runtime Configuration Property
Maximum speed that an Event may have, beyond which ithe action is performed
(not currently used)
Type: Double

See Also:

Constant Field Values

PROP_Device_checkLastOdometer

public static final java.lang.String PROP_Device_checkLastOdometer

Runtime Configuration Property
Check event odometer against previous/last save odometer in Device record
Type: Boolean

See Also:

Constant Field Values

PROP_Device_maximumOdometerKM

public static final java.lang.String PROP_Device_maximumOdometerKM

Runtime Configuration Property
Maximum odometer value
Type: Double

See Also:

Constant Field Values

PROP_Device_maximumRuntimeHours

public static final java.lang.String PROP_Device_maximumRuntimeHours

Runtime Configuration Property
Maximum engine-hours value
Type: Double

See Also:

Constant Field Values

PROP_Device_keyedSimPhoneNumber

public static final java.lang.String PROP_Device_keyedSimPhoneNumber

Runtime Configuration Property
True to create an alternate key/index for column Device.simPhoneNumber
(can be used for "SIM Phone Number" lookups)
Type: Boolean

See Also:

Constant Field Values

PROP_Device_keyedLastNotifyTime

public static final java.lang.String PROP_Device_keyedLastNotifyTime

Runtime Configuration Property
True to create an alternate key/index for column Device.lastNotifyTime
(can be used for global "Last Notify Time" lookups)
Type: Boolean

See Also:

Constant Field Values

PROP_Device_checkNotifySelector

public static final java.lang.String PROP_Device_checkNotifySelector

Runtime Configuration Property
True to test the rule selector in column Device.notifySelector
Type: Boolean

See Also:

Constant Field Values

PROP_Device_checkNotifySelector_ENRE

public static final java.lang.String PROP_Device_checkNotifySelector_ENRE

See Also:

Constant Field Values

PROP_Device_maintenanceOdometerCount

public static final java.lang.String PROP_Device_maintenanceOdometerCount

Runtime Configuration Property
Returns the number of periodic maintenance odometer values to support
(must be less-than-or-equal-to the maximum supported by the Device record)
Type: Integer

See Also:

Constant Field Values

PROP_DeviceInfo_DeviceCmdAlternate_

public static final java.lang.String PROP_DeviceInfo_DeviceCmdAlternate_

Runtime Configuration Property
Prefix for looking up DeviceInfo.DeviceCmd alternate server IDs
Type: String array

See Also:

Constant Field Values

PROP_sysAdminInfo_showEventsPerSecond

public static final java.lang.String PROP_sysAdminInfo_showEventsPerSecond

Runtime Configuration Property
Show the "Event-Per-Second" field
Type: Boolean

See Also:

Constant Field Values

PROP_EventData_keyedCreationTime

public static final java.lang.String PROP_EventData_keyedCreationTime

Runtime Configuration Property
Create alternate keyed "creationTime" in EventData
Type: Boolean

See Also:

Constant Field Values

PROP_EventData_logMissingColumns

public static final java.lang.String PROP_EventData_logMissingColumns

Runtime Configuration Property
Log missing columns on insert/update (defaults to 'true')
Type: Boolean

See Also:

Constant Field Values

PROP_Geozone_dftRadius_pointRadius

public static final java.lang.String PROP_Geozone_dftRadius_pointRadius

Runtime Configuration Property
Default Radius (in meters) for PointRadius Geozones
Type: Integer

See Also:

Constant Field Values

PROP_Geozone_dftRadius_polygon

public static final java.lang.String PROP_Geozone_dftRadius_polygon

Runtime Configuration Property
Default Radius (in meters) for Polygon Geozones
Type: Integer

See Also:

Constant Field Values

PROP_Geozone_dftRadius_sweptPointRadius

public static final java.lang.String PROP_Geozone_dftRadius_sweptPointRadius

Runtime Configuration Property
Default Radius (in meters) for SweptPointRadius Geozones
Type: Integer

See Also:

Constant Field Values

PROP_RuleList_includeGroupRules

public static final java.lang.String PROP_RuleList_includeGroupRules

Runtime Configuration Property (optional)
True to enable checking Device "Group" lookup when triggering rules.
Type: Boolean

See Also:

Constant Field Values

PROP_FuelRegister_installFuelManager

public static final java.lang.String PROP_FuelRegister_installFuelManager

Runtime Configuration Property (optional)
Enable FuelManager checking (requires FuelRegister installed).
Type: Boolean

See Also:

Constant Field Values

PROP_FuelRegister_levelIncreaseThreshold

public static final java.lang.String PROP_FuelRegister_levelIncreaseThreshold

Runtime Configuration Property (optional)
The FuelLevel "Increase" percent threshold (between 0.0 and 1.0 inclusive).
Type: Double

See Also:

Constant Field Values

PROP_FuelRegister_levelDecreaseThreshold

public static final java.lang.String PROP_FuelRegister_levelDecreaseThreshold

Runtime Configuration Property (optional)
The FuelLevel "Decrease" percent threshold (between 0.0 and 1.0 inclusive).
Type: Double

See Also:

Constant Field Values

PROP_track_baseURI

public static final java.lang.String PROP_track_baseURI

Runtime Configuration Property
Base URI used for accesing the GTS login (must match web.xml configuration)
Type: String

See Also:

Constant Field Values

PROP_track_requireCookies

public static final java.lang.String PROP_track_requireCookies

Runtime Configuration Property
True to require that cookies be enabled.
If false, session information will be encoded in the URL
Type: Boolean

See Also:

Constant Field Values

PROP_track_js_directory

public static final java.lang.String PROP_track_js_directory

Runtime Configuration Property
The overriding directory, used to find the JavaScript code.
Type: String

See Also:

Constant Field Values

PROP_track_offlineFile

public static final java.lang.String PROP_track_offlineFile

Runtime Configuration Property
The file which contains the text to display when the system is 'Offline'.
Type: File

See Also:

Constant Field Values

PROP_track_enableService

public static final java.lang.String PROP_track_enableService

Runtime Configuration Property
True to enable web-service access.
Type: Boolean

See Also:

Constant Field Values

PROP_SubdivisionProvider_class

public static final java.lang.String PROP_SubdivisionProvider_class

Runtime Configuration Property
The name of the overriding Class used to provide latitude/longitude subdivision data.
Used for Border-Crossing detection.
Type: Class

See Also:

Constant Field Values

PROP_EventFunctionMapFactory_class

public static final java.lang.String PROP_EventFunctionMapFactory_class

Runtime Configuration Property
The name of the overriding Class used to provide the Rule handling EventFunctionMapFactory.
Type: Class

See Also:

Constant Field Values

PROP_EventIdentifierMapFactory_class

public static final java.lang.String PROP_EventIdentifierMapFactory_class

Runtime Configuration Property
The name of the overriding Class used to provide the Rule handling EventIdentifierMapFactory.
Type: Class

See Also:

Constant Field Values

PROP_Transport_queryEnabled

public static final java.lang.String PROP_Transport_queryEnabled

Runtime Configuration Property
True to enable Transport table unique-id lookup.
(only required when the Device is separate from the Transport)
Type: Boolean

See Also:

Constant Field Values

PROP_UniqueXID_queryEnabled

public static final java.lang.String PROP_UniqueXID_queryEnabled

Runtime Configuration Property
True to enable UniqueXID table unique-id lookup.
(only required when the UniqueID is separate from the Device)
Type: Boolean

See Also:

Constant Field Values

PROP_db_defaultDeviceAuthorization

public static final java.lang.String PROP_db_defaultDeviceAuthorization

Runtime Configuration Property
True to allow account/user access to "ALL" device group, if no groups are defined.
Type: Boolean

See Also:

Constant Field Values

PROP_db_defaultDeviceAuthorization_

public static final java.lang.String PROP_db_defaultDeviceAuthorization_

Runtime Configuration Property
True to allow account/user access to "ALL" device group, if no groups are defined.
(allows specifying specific Account IDs)
Type: Boolean

See Also:

Constant Field Values

PROP_sysAdmin_account

public static final java.lang.String PROP_sysAdmin_account

Runtime Configuration Property
The name of the SystemAdmin Account ID.
Type: String

See Also:

Constant Field Values

PROP_GoogleKML_pushpinBaseURL

public static final java.lang.String PROP_GoogleKML_pushpinBaseURL

Runtime Configuration Property
The base URL for Google pushpins
Type: String

See Also:

Constant Field Values

runtimeKeys

protected static RTKey.Entry[] runtimeKeys

env_GTS_HOME

public static final java.lang.String env_GTS_HOME

The GTS_HOME environment variable name

See Also:

Constant Field Values

ARG_SCHEMA

public static final java.lang.String[] ARG_SCHEMA

Constructor Detail

DBConfig

public DBConfig()

Method Detail

hasExtraPackage

public static boolean hasExtraPackage()

Returns true if the "extra" package is present

Returns:

True if the "extra" package is present

hasRulePackage

public static boolean hasRulePackage()

Returns true if the "rule" package is present

Returns:

True if the "rule" package is present

hasOptPackage

public static boolean hasOptPackage()

Returns true if the "opt" package is present

Returns:

True if the "opt" package is present

getVersion

public static java.lang.String getVersion()

Return the GTS build version

Returns:

The GTS build version

GetDefaultDeviceAuthorization

public static boolean GetDefaultDeviceAuthorization(java.lang.String acctID)

Returns the Device group "ALL" authorization for the specified Account

Parameters:

acctID - The account ID for which the Device group "ALL" authorizatio is returned

Returns:

True is Device group "ALL" is authoriized

get_GTS_HOME

public static java.io.File get_GTS_HOME()

Compares the GTS_HOME environment variable to the current directory.

Returns:

True if GTS_HOME matches current directory, false otherwise

check_GTS_HOME

public static boolean check_GTS_HOME()

Compares the GTS_HOME environment variable to the current directory.

Returns:

True if GTS_HOME matches current directory, false otherwise

addTableFactories

public static void addTableFactories()

Add the standard DBFactories as-is

servletInit

public static void servletInit(java.util.Properties srvCtxProps)

cmdLineInit

public static int cmdLineInit(java.lang.String[] argv,
                              boolean interactive)

Entry point for various programs/tools which initializes the DBFactories

Parameters:

argv - The Command-Line arguments, if any

interactive - True if this is invoked from a user interactive command-line tool, False if this is invoked from a server non-interactive command-line tool.

getServiceAccountID

public static java.lang.String getServiceAccountID(java.lang.String dft)

Return the ServiceAccount ID

Parameters:

dft - The default value to return if the ServiceAccount ID is not available

Returns:

The ServiceAccount ID

getServiceAccountName

public static java.lang.String getServiceAccountName(java.lang.String dft)

Return the ServiceAccount Name

Parameters:

dft - The default value to return if the ServiceAccount Name is not available

Returns:

The ServiceAccount Name

getServiceAccountAttributes

public static java.lang.String getServiceAccountAttributes(java.lang.String dft)

Return the ServiceAccount Attributes

Parameters:

dft - The default value to return if the ServiceAccount Attributes are not available

Returns:

The ServiceAccount Attributes

_main

public static int _main(java.lang.String[] argv)

Main entry point for providing command-line DB administration tools

Parameters:

argv - The command-line arguments

main

public static void main(java.lang.String[] argv)

Main entry point for providing command-line DB administration tools

Parameters:

argv - The command-line arguments