org.opengts.db
Class DCServerFactory

java.lang.Object
  org.opengts.db.DCServerFactory

public class DCServerFactory
extends java.lang.Object

Nested Class Summary

static class

DCServerFactory.ResultCode ResultCode enumeration for server command responses

Field Summary

static java.lang.String	AGROBOT_NAME
static java.lang.String	ANTARES_NAME
static java.lang.String	ANTX_NAME
static java.lang.String[]	ARG_commandPort
static java.lang.String[]	ARG_tcpPort
static java.lang.String[]	ARG_udpPort
static java.lang.String	ARKNAV35_NAME
static java.lang.String	ASPICORE_NAME
static java.lang.String	ATRACK_NAME
static java.lang.String	ATTR_bindAddress
static java.lang.String	ATTR_rtPropPrefix
static java.lang.String	AXONN_NAME
static java.lang.String	BIGWATCHER_NAME
static java.lang.String	BIND_ADDRESS
static java.lang.String	BLUETREE_NAME
static java.lang.String	CALAMP_NAME
static java.lang.String	CFG_ackResponsePort
static java.lang.String	CFG_batteryLevelRange
static java.lang.String	CFG_clientCommandPort
static java.lang.String	CFG_clientCommandPort_tcp
static java.lang.String	CFG_clientCommandPort_udp
static java.lang.String	CFG_commandPort
static java.lang.String	CFG_commandProtocol
static java.lang.String	CFG_estimateOdometer
static java.lang.String	CFG_finalPacket
static java.lang.String	CFG_ignoreDeviceOdometer
static java.lang.String	CFG_ignoreInvalidGPSFlag
static java.lang.String	CFG_initialPacket
static java.lang.String	CFG_maximumHDOP
static java.lang.String	CFG_minimumMovedMeters
static java.lang.String	CFG_minimumSpeedKPH
static java.lang.String	CFG_port
static java.lang.String	CFG_saveRawDataPackets
static java.lang.String	CFG_saveSessionStatistics
static java.lang.String	CFG_simulateDigitalInputs
static java.lang.String	CFG_simulateGeozones
static java.lang.String	CFG_startStopSupported
static java.lang.String	CFG_statusLocationInMotion
static java.lang.String	CFG_tcpIdleTimeoutMS
static java.lang.String	CFG_tcpPacketTimeoutMS
static java.lang.String	CFG_tcpPort
static java.lang.String	CFG_tcpSessionTimeoutMS
static java.lang.String	CFG_udpIdleTimeoutMS
static java.lang.String	CFG_udpPacketTimeoutMS
static java.lang.String	CFG_udpPort
static java.lang.String	CFG_udpSessionTimeoutMS
static java.lang.String	CFG_uniqueIdPrefix
static java.lang.String	CFG_uniquePrefix
static java.lang.String	CFG_useLastValidGPSLocation
static java.lang.String	CITGT02_NAME
static java.lang.String	CITGT06_NAME
static java.lang.String	CMDARG_ACCOUNT
static java.lang.String	CMDARG_ARG
static java.lang.String	CMDARG_CMDNAME
static java.lang.String	CMDARG_CMDTYPE
static java.lang.String	CMDARG_DEVICE
static java.lang.String	CMDARG_SERVER
static java.lang.String	CMDARG_UNIQUE
static java.lang.String	CMDTYPE_ADMIN
static java.lang.String	CMDTYPE_ALL
static java.lang.String	CMDTYPE_GARMIN
static java.lang.String	CMDTYPE_MAP
static java.lang.String	CMDTYPE_SYSADMIN
static java.lang.String	DCSERVER_XML
static java.lang.String	DCSERVERS_DIR
static boolean	DEFAULT_WARN_PORT_CONFLICT
static java.lang.String	ELOC_NAME
static java.lang.String	ENFORA_NAME
static java.lang.String	EWING_NAME
static java.lang.String	FALCOM_NAME
static java.lang.String	GLOBALSAT_NAME
static java.lang.String	GOSAFE_NAME
static java.lang.String	GOTOP680_NAME
static java.lang.String	GSSPOT_NAME
static java.lang.String	GT68_NAME
static java.lang.String	GT95_NAME
static java.lang.String	GTS_HOME
static java.lang.String	GTSGEN1_NAME
static java.lang.String	GTSGEN2_NAME
static java.lang.String	ICARE_NAME
static java.lang.String	INCLUDE_DIR
static java.lang.String	INTELLITRAC_A_NAME
static java.lang.String	INTELLITRAC_NAME
static java.lang.String	JT600_NAME
static java.lang.String	K611_NAME
static java.lang.String	LAIPAC_NAME
static int	LISTEN_BACKLOG
static java.lang.String	MAJID_NAME
static java.lang.String	MEGASTEK_NAME
static java.lang.String	MEITRACK2_NAME
static java.lang.String	MOREY_NAME
static java.lang.String	NONE_NAME
static java.lang.String	OPENDMTP_NAME
static java.lang.String	PARATEL_NAME
static java.lang.String	PGT3000_NAME
static java.lang.String	PICCOLO_NAME
static int	PORT_OFFSET
static java.lang.String	PROP_Attribute_
static java.lang.String	PROP_Attribute_InputOffset
static java.lang.String	PROP_DCServer_
static java.lang.String	QGL200_NAME
static java.lang.String	QGV100_NAME
static java.lang.String	QGV200_NAME
static java.lang.String	QGV300_NAME
static java.lang.String	QINETIQ_NAME
static java.lang.String	RESPONSE_MESSAGE
static java.lang.String	RESPONSE_RESULT
static java.lang.String	RESPONSE_SERVER
static java.lang.String	RVCT03_NAME
static java.lang.String	RVCT04_NAME
static java.lang.String	SANAV_NAME
static java.lang.String	SIPGEAR_NAME
static java.lang.String	SNROVER9_NAME
static java.lang.String	STARSNAV_NAME
static java.lang.String	TAIP_NAME
static java.lang.String	TELGH3000_NAME
static java.lang.String	TELTONIKA_NAME
static java.lang.String	TEMPLATE_NAME
static java.lang.String	TK10X_NAME
static java.lang.String	TRIMTRAC_NAME
static java.lang.String	TZAVL05_NAME
static java.lang.String	TZAVL08_NAME
static java.lang.String	UPLOAD_NAME
static java.lang.String	WEBTECH_NAME
static java.lang.String	WONDE_NAME
static java.lang.String	XIRGO_NAME

Constructor Summary

DCServerFactory()

Method Summary

static DCServerConfig	_getServerConfig(java.lang.String name) Returns the DCServerConfig instance for the specified device communication server name
static DCServerConfig	addDCS(java.lang.String name, java.lang.String desc, int[] tcpPorts, int[] udpPorts, int commandPort, long flags, java.lang.String... uniqPfx) Adds the named server to the list of registered servers
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, double lat, double lon) Add device-id to UnassignedDevice table
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, GeoPoint geoPoint) Add device-id to UnassignedDevice table
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, java.lang.String ipAddr, boolean isDuplex, double lat, double lon) Add device-id to UnassignedDevice table
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, java.lang.String ipAddr, boolean isDuplex, double lat, double lon, java.lang.String data) Add device-id to UnassignedDevice table
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, java.lang.String ipAddr, boolean isDuplex, GeoPoint geoPoint) Add device-id to UnassignedDevice table
static boolean	addUnassignedDevice(java.lang.String dcName, java.lang.String mobID, java.lang.String ipAddr, boolean isDuplex, GeoPoint geoPoint, java.lang.String data) Add device-id to UnassignedDevice table
static double	calculateOdometerKM(EventData prevEvent, GeoPoint toPoint) Calculates/returns the next odometer value
static void	checkMemoryUsage() Analyzes/Prints the current memory usage.
static java.lang.String[]	CONFIG_ackResponsePort(java.lang.String name) Return an array of "ACK Response port" property names
static java.lang.String[]	CONFIG_batteryLevelRange(java.lang.String name) Return an array of "Battery Level Range" property names
static java.lang.String[]	CONFIG_clientCommandPort_tcp(java.lang.String name) Return an array of "Client Command port" property names
static java.lang.String[]	CONFIG_clientCommandPort_udp(java.lang.String name) Return an array of "Client Command port" property names
static java.lang.String[]	CONFIG_commandPort(java.lang.String name) Return an array of "Command port" property names
static java.lang.String[]	CONFIG_commandProtocol(java.lang.String name) Return an array of "Command Protocol" property names Return command protocol to used when communicating with remote devices
static java.lang.String[]	CONFIG_estimateOdometer(java.lang.String name) Return an array of "Estimate Odometer" property names
static java.lang.String[]	CONFIG_finalPacket(java.lang.String name) Return an array of "Final Packet" property names
static java.lang.String[]	CONFIG_ignoreDeviceOdometer(java.lang.String name) Return an array of "Ignore Device Odometer" property names
static java.lang.String[]	CONFIG_ignoreInvalidGPSFlag(java.lang.String name) Return an array of "Ignore Invalid GPS Flag" property names
static java.lang.String[]	CONFIG_initialPacket(java.lang.String name) Return an array of "Initial Packet" property names
static java.lang.String[]	CONFIG_maximumHDOP(java.lang.String name) Return an array of "Maximum HDOP" property names
static java.lang.String[]	CONFIG_minimumMovedMeters(java.lang.String name) Return an array of "Minimum Moved Meters" property names
static java.lang.String[]	CONFIG_minimumSpeedKPH(java.lang.String name) Return an array of "Minimum SpeedKPH" property names
static java.lang.String[]	CONFIG_saveRawDataPackets(java.lang.String name) Return an array of "Save Raw Data Packet" property names
static java.lang.String[]	CONFIG_saveSessionStatistics(java.lang.String name) Return an array of "Save Session Statistics" property names
static java.lang.String[]	CONFIG_simulateDigitalInputs(java.lang.String name) Return an array of "Simulate Digital Inputs" property names
static java.lang.String[]	CONFIG_simulateGeozones(java.lang.String name) Return an array of "Simulate Geozone Arrival/Departure" property names
static java.lang.String[]	CONFIG_startStopSupported(java.lang.String name) Return an array of "Start/Stop StatusCode supported" property names
static java.lang.String[]	CONFIG_statusLocationInMotion(java.lang.String name) Return an array of "Status Location/InMotion Translation" property names
static java.lang.String[]	CONFIG_tcpIdleTimeoutMS(java.lang.String name) Return an array of "TCP idle timeout" property names
static java.lang.String[]	CONFIG_tcpPacketTimeoutMS(java.lang.String name) Return an array of "TCP packet timeout" property names
static java.lang.String[]	CONFIG_tcpPort(java.lang.String name) Return an array of "TCP port" property names
static java.lang.String[]	CONFIG_tcpSessionTimeoutMS(java.lang.String name) Return an array of "TCP session timeout" property names
static java.lang.String[]	CONFIG_udpIdleTimeoutMS(java.lang.String name) Return an array of "UDP idle timeout" property names
static java.lang.String[]	CONFIG_udpPacketTimeoutMS(java.lang.String name) Return an array of "UDP packet timeout" property names
static java.lang.String[]	CONFIG_udpPort(java.lang.String name) Return an array of "UDP port" property names
static java.lang.String[]	CONFIG_udpSessionTimeoutMS(java.lang.String name) Return an array of "UDP session timeout" property names
static java.lang.String[]	CONFIG_uniquePrefix(java.lang.String name) Return an array of UniquID prefix property names
static java.lang.String[]	CONFIG_useLastValidGPSLocation(java.lang.String name) Return an array of "Use Last Valid GPS Location" property names
static RTProperties	createRTProperties(java.lang.String accountID, java.lang.String deviceID, java.lang.String uniqueID, java.lang.String cmdType, java.lang.String cmdName, java.lang.String[] cmdArgs)
static java.lang.String	Garmin_getStopStatusDescription(java.util.Locale locale, int stopStatus)
static int	getCommandDispatcherPort(java.lang.String serverName) Gets the server 'command' port
static java.lang.String	getCommandResultID(RTProperties r) Gets the Command ResultCode ID
static java.lang.String	getCommandResultMessage(RTProperties r) Gets the Command ResultCode Message
static int	getPort(int port) Returns the server port (with constant offset applied)
static int[]	getPorts(int... ports) Returns an array of server ports (with constant offset applied)
static EventData	getPreviousEventData(Device device, long fixtime) Returns the EventData record previous to the specified fixtime
static DCServerFactory.ResultCode	GetResultCode(java.lang.String code, DCServerFactory.ResultCode dft)
static DCServerConfig	getServerConfig(java.lang.String name) Returns the DCServerConfig instance for the specified device communication server name
static java.lang.String	getServerConfigDescription(java.lang.String serverName) Gets the server config description
static java.util.List<DCServerConfig>	getServerConfigList(boolean inclAll) Returns a list of all DCServerConfig instances
static java.lang.String	GetSpecificDCServerName() Gets the specific DCServerConfig name, or null if there is no specific DCServerConfig.
static java.util.List<java.lang.String>	getUndefinedServerList() (used by CheckInstall) Returns the list of referenced, but undefined, servers
static java.lang.String	getUniquePrefixString(java.lang.String[] pfx) Returns a String representation of the unique-id prefix array
static boolean	hasDigitalInputs(java.lang.String serverName) Returns true if this device supports digital inputs
static boolean	hasDigitalOutputs(java.lang.String serverName) Returns true if this device supports digital outputs
static boolean	hasServerConfig(java.lang.String name) Returns True if the named DCServerConfig has been registered
static boolean	HasSpecificDCServerName() Returns true if a specific DCServerConfig name is defined.
static boolean	hasUndefinedServers() (used by CheckInstall) Return the number of refererenced servers which are undefined
static void	init()
static void	InitSpecificDCServerName() Initialize the specific DCServerConfig name
static boolean	isCommandResultOK(DCServerFactory.ResultCode rid) Return true if the ResultCode represents a successful request/operation
static boolean	isCommandResultOK(RTProperties r) Return true if the ResultCode represents a successful request/operation
static boolean	isCommandTypeAll(java.lang.String type)
static boolean	isValidPort(int port) Returns true if the specified port is valid
static boolean	isValidPort(int[] port) Returns true if the specified port array is valid
static void	loadDCServerXML(java.io.File xmlFile)
static Device	loadDeviceByAcountDeviceID(java.lang.String accountID, java.lang.String deviceID) Load device record from account-id/device-id
static Device	loadDeviceByPrefixedModemID(java.lang.String[] prefix, java.lang.String modemID) Load device record from unique-id
static Device	loadDeviceByPrefixedModemID(java.lang.String[] prefix, java.lang.String modemID, boolean saveUnassigned, java.lang.String serverID, java.lang.String ipAddress, boolean isDuplex, GeoPoint geoPoint) Load device record from unique-id
static Device	loadDeviceByPrefixedModemID(java.lang.String[] prefix, java.lang.String modemID, java.lang.String serverID, java.lang.String ipAddress, boolean isDuplex, GeoPoint geoPoint) Load device record from unique-id
static Device[]	lookupUniqueID(java.lang.String mobileID) Lookup the specified mobile-id in the Transport/Device tables, use all available DC servers unique-id prefixes.
static void	main(java.lang.String[] args) Command-line main entry point
static RTProperties	sendServerCommand(Device device, java.lang.String cmdType, java.lang.String cmdName, java.lang.String[] cmdArgs) Send a command request to the server command port for the specified Device
static DCServerFactory.ResultCode	SendSMSCommand(java.lang.String handlerName, Device device, java.lang.String commandStr) Send SMS command to device
static boolean	serverJarExists(java.lang.String name) Returns true if the named server is defined
static void	SetSpecificDCServerName(java.lang.String name) Sets the specific DCServerConfig name
static boolean	supportsCommandDispatcher(Device device) Returns true if the server for the specified Device supports a command port
static boolean	supportsCommandDispatcher(java.lang.String serverName) Returns true if the named server supports a command port

Methods inherited from class java.lang.Object

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

Field Detail

DCSERVERS_DIR

public static final java.lang.String DCSERVERS_DIR

See Also:

Constant Field Values

DCSERVER_XML

public static final java.lang.String DCSERVER_XML

See Also:

Constant Field Values

DEFAULT_WARN_PORT_CONFLICT

public static boolean DEFAULT_WARN_PORT_CONFLICT

PROP_Attribute_

public static final java.lang.String PROP_Attribute_

See Also:

Constant Field Values

PROP_Attribute_InputOffset

public static final java.lang.String PROP_Attribute_InputOffset

See Also:

Constant Field Values

PROP_DCServer_

public static final java.lang.String PROP_DCServer_

See Also:

Constant Field Values

CMDTYPE_ALL

public static final java.lang.String CMDTYPE_ALL

See Also:

Constant Field Values

CMDTYPE_MAP

public static final java.lang.String CMDTYPE_MAP

See Also:

Constant Field Values

CMDTYPE_ADMIN

public static final java.lang.String CMDTYPE_ADMIN

See Also:

Constant Field Values

CMDTYPE_GARMIN

public static final java.lang.String CMDTYPE_GARMIN

See Also:

Constant Field Values

CMDTYPE_SYSADMIN

public static final java.lang.String CMDTYPE_SYSADMIN

See Also:

Constant Field Values

NONE_NAME

public static final java.lang.String NONE_NAME

See Also:

Constant Field Values

OPENDMTP_NAME

public static final java.lang.String OPENDMTP_NAME

See Also:

Constant Field Values

ICARE_NAME

public static final java.lang.String ICARE_NAME

See Also:

Constant Field Values

SIPGEAR_NAME

public static final java.lang.String SIPGEAR_NAME

See Also:

Constant Field Values

TEMPLATE_NAME

public static final java.lang.String TEMPLATE_NAME

See Also:

Constant Field Values

ASPICORE_NAME

public static final java.lang.String ASPICORE_NAME

See Also:

Constant Field Values

TK10X_NAME

public static final java.lang.String TK10X_NAME

See Also:

Constant Field Values

TAIP_NAME

public static final java.lang.String TAIP_NAME

See Also:

Constant Field Values

CALAMP_NAME

public static final java.lang.String CALAMP_NAME

See Also:

Constant Field Values

SANAV_NAME

public static final java.lang.String SANAV_NAME

See Also:

Constant Field Values

FALCOM_NAME

public static final java.lang.String FALCOM_NAME

See Also:

Constant Field Values

WONDE_NAME

public static final java.lang.String WONDE_NAME

See Also:

Constant Field Values

LAIPAC_NAME

public static final java.lang.String LAIPAC_NAME

See Also:

Constant Field Values

INTELLITRAC_NAME

public static final java.lang.String INTELLITRAC_NAME

See Also:

Constant Field Values

INTELLITRAC_A_NAME

public static final java.lang.String INTELLITRAC_A_NAME

See Also:

Constant Field Values

ANTX_NAME

public static final java.lang.String ANTX_NAME

See Also:

Constant Field Values

MEGASTEK_NAME

public static final java.lang.String MEGASTEK_NAME

See Also:

Constant Field Values

ARKNAV35_NAME

public static final java.lang.String ARKNAV35_NAME

See Also:

Constant Field Values

SNROVER9_NAME

public static final java.lang.String SNROVER9_NAME

See Also:

Constant Field Values

QINETIQ_NAME

public static final java.lang.String QINETIQ_NAME

See Also:

Constant Field Values

PICCOLO_NAME

public static final java.lang.String PICCOLO_NAME

See Also:

Constant Field Values

BIGWATCHER_NAME

public static final java.lang.String BIGWATCHER_NAME

See Also:

Constant Field Values

MOREY_NAME

public static final java.lang.String MOREY_NAME

See Also:

Constant Field Values

EWING_NAME

public static final java.lang.String EWING_NAME

See Also:

Constant Field Values

GT95_NAME

public static final java.lang.String GT95_NAME

See Also:

Constant Field Values

K611_NAME

public static final java.lang.String K611_NAME

See Also:

Constant Field Values

GT68_NAME

public static final java.lang.String GT68_NAME

See Also:

Constant Field Values

ENFORA_NAME

public static final java.lang.String ENFORA_NAME

See Also:

Constant Field Values

GOTOP680_NAME

public static final java.lang.String GOTOP680_NAME

See Also:

Constant Field Values

RVCT03_NAME

public static final java.lang.String RVCT03_NAME

See Also:

Constant Field Values

MEITRACK2_NAME

public static final java.lang.String MEITRACK2_NAME

See Also:

Constant Field Values

RVCT04_NAME

public static final java.lang.String RVCT04_NAME

See Also:

Constant Field Values

ELOC_NAME

public static final java.lang.String ELOC_NAME

See Also:

Constant Field Values

QGL200_NAME

public static final java.lang.String QGL200_NAME

See Also:

Constant Field Values

QGV100_NAME

public static final java.lang.String QGV100_NAME

See Also:

Constant Field Values

QGV200_NAME

public static final java.lang.String QGV200_NAME

See Also:

Constant Field Values

QGV300_NAME

public static final java.lang.String QGV300_NAME

See Also:

Constant Field Values

TZAVL05_NAME

public static final java.lang.String TZAVL05_NAME

See Also:

Constant Field Values

TZAVL08_NAME

public static final java.lang.String TZAVL08_NAME

See Also:

Constant Field Values

ANTARES_NAME

public static final java.lang.String ANTARES_NAME

See Also:

Constant Field Values

ATRACK_NAME

public static final java.lang.String ATRACK_NAME

See Also:

Constant Field Values

WEBTECH_NAME

public static final java.lang.String WEBTECH_NAME

See Also:

Constant Field Values

TELTONIKA_NAME

public static final java.lang.String TELTONIKA_NAME

See Also:

Constant Field Values

TELGH3000_NAME

public static final java.lang.String TELGH3000_NAME

See Also:

Constant Field Values

JT600_NAME

public static final java.lang.String JT600_NAME

See Also:

Constant Field Values

PGT3000_NAME

public static final java.lang.String PGT3000_NAME

See Also:

Constant Field Values

CITGT02_NAME

public static final java.lang.String CITGT02_NAME

See Also:

Constant Field Values

CITGT06_NAME

public static final java.lang.String CITGT06_NAME

See Also:

Constant Field Values

GOSAFE_NAME

public static final java.lang.String GOSAFE_NAME

See Also:

Constant Field Values

TRIMTRAC_NAME

public static final java.lang.String TRIMTRAC_NAME

See Also:

Constant Field Values

XIRGO_NAME

public static final java.lang.String XIRGO_NAME

See Also:

Constant Field Values

GLOBALSAT_NAME

public static final java.lang.String GLOBALSAT_NAME

See Also:

Constant Field Values

STARSNAV_NAME

public static final java.lang.String STARSNAV_NAME

See Also:

Constant Field Values

BLUETREE_NAME

public static final java.lang.String BLUETREE_NAME

See Also:

Constant Field Values

MAJID_NAME

public static final java.lang.String MAJID_NAME

See Also:

Constant Field Values

GSSPOT_NAME

public static final java.lang.String GSSPOT_NAME

See Also:

Constant Field Values

AXONN_NAME

public static final java.lang.String AXONN_NAME

See Also:

Constant Field Values

PARATEL_NAME

public static final java.lang.String PARATEL_NAME

See Also:

Constant Field Values

GTSGEN1_NAME

public static final java.lang.String GTSGEN1_NAME

See Also:

Constant Field Values

GTSGEN2_NAME

public static final java.lang.String GTSGEN2_NAME

See Also:

Constant Field Values

AGROBOT_NAME

public static final java.lang.String AGROBOT_NAME

See Also:

Constant Field Values

UPLOAD_NAME

public static final java.lang.String UPLOAD_NAME

See Also:

Constant Field Values

CMDARG_ACCOUNT

public static final java.lang.String CMDARG_ACCOUNT

See Also:

Constant Field Values

CMDARG_DEVICE

public static final java.lang.String CMDARG_DEVICE

See Also:

Constant Field Values

CMDARG_UNIQUE

public static final java.lang.String CMDARG_UNIQUE

See Also:

Constant Field Values

CMDARG_CMDTYPE

public static final java.lang.String CMDARG_CMDTYPE

See Also:

Constant Field Values

CMDARG_CMDNAME

public static final java.lang.String CMDARG_CMDNAME

See Also:

Constant Field Values

CMDARG_ARG

public static final java.lang.String CMDARG_ARG

See Also:

Constant Field Values

CMDARG_SERVER

public static final java.lang.String CMDARG_SERVER

See Also:

Constant Field Values

RESPONSE_SERVER

public static final java.lang.String RESPONSE_SERVER

See Also:

Constant Field Values

RESPONSE_RESULT

public static final java.lang.String RESPONSE_RESULT

See Also:

Constant Field Values

RESPONSE_MESSAGE

public static final java.lang.String RESPONSE_MESSAGE

See Also:

Constant Field Values

ATTR_bindAddress

public static final java.lang.String ATTR_bindAddress

See Also:

Constant Field Values

ATTR_rtPropPrefix

public static final java.lang.String ATTR_rtPropPrefix

See Also:

Constant Field Values

BIND_ADDRESS

public static java.lang.String BIND_ADDRESS

LISTEN_BACKLOG

public static int LISTEN_BACKLOG

PORT_OFFSET

public static int PORT_OFFSET

INCLUDE_DIR

public static java.lang.String INCLUDE_DIR

GTS_HOME

public static java.lang.String GTS_HOME

ARG_udpPort

public static final java.lang.String[] ARG_udpPort

ARG_tcpPort

public static final java.lang.String[] ARG_tcpPort

ARG_commandPort

public static final java.lang.String[] ARG_commandPort

CFG_uniquePrefix

public static final java.lang.String CFG_uniquePrefix

See Also:

Constant Field Values

CFG_uniqueIdPrefix

public static final java.lang.String CFG_uniqueIdPrefix

See Also:

Constant Field Values

CFG_tcpPort

public static final java.lang.String CFG_tcpPort

See Also:

Constant Field Values

CFG_udpPort

public static final java.lang.String CFG_udpPort

See Also:

Constant Field Values

CFG_port

public static final java.lang.String CFG_port

See Also:

Constant Field Values

CFG_commandPort

public static final java.lang.String CFG_commandPort

See Also:

Constant Field Values

CFG_commandProtocol

public static final java.lang.String CFG_commandProtocol

See Also:

Constant Field Values

CFG_ackResponsePort

public static final java.lang.String CFG_ackResponsePort

See Also:

Constant Field Values

CFG_clientCommandPort

public static final java.lang.String CFG_clientCommandPort

See Also:

Constant Field Values

CFG_clientCommandPort_udp

public static final java.lang.String CFG_clientCommandPort_udp

See Also:

Constant Field Values

CFG_clientCommandPort_tcp

public static final java.lang.String CFG_clientCommandPort_tcp

See Also:

Constant Field Values

CFG_tcpIdleTimeoutMS

public static final java.lang.String CFG_tcpIdleTimeoutMS

See Also:

Constant Field Values

CFG_tcpPacketTimeoutMS

public static final java.lang.String CFG_tcpPacketTimeoutMS

See Also:

Constant Field Values

CFG_tcpSessionTimeoutMS

public static final java.lang.String CFG_tcpSessionTimeoutMS

See Also:

Constant Field Values

CFG_udpIdleTimeoutMS

public static final java.lang.String CFG_udpIdleTimeoutMS

See Also:

Constant Field Values

CFG_udpPacketTimeoutMS

public static final java.lang.String CFG_udpPacketTimeoutMS

See Also:

Constant Field Values

CFG_udpSessionTimeoutMS

public static final java.lang.String CFG_udpSessionTimeoutMS

See Also:

Constant Field Values

CFG_minimumSpeedKPH

public static final java.lang.String CFG_minimumSpeedKPH

See Also:

Constant Field Values

CFG_estimateOdometer

public static final java.lang.String CFG_estimateOdometer

See Also:

Constant Field Values

CFG_ignoreDeviceOdometer

public static final java.lang.String CFG_ignoreDeviceOdometer

See Also:

Constant Field Values

CFG_maximumHDOP

public static final java.lang.String CFG_maximumHDOP

See Also:

Constant Field Values

CFG_simulateGeozones

public static final java.lang.String CFG_simulateGeozones

See Also:

Constant Field Values

CFG_simulateDigitalInputs

public static final java.lang.String CFG_simulateDigitalInputs

See Also:

Constant Field Values

CFG_minimumMovedMeters

public static final java.lang.String CFG_minimumMovedMeters

See Also:

Constant Field Values

CFG_saveRawDataPackets

public static final java.lang.String CFG_saveRawDataPackets

See Also:

Constant Field Values

CFG_startStopSupported

public static final java.lang.String CFG_startStopSupported

See Also:

Constant Field Values

CFG_statusLocationInMotion

public static final java.lang.String CFG_statusLocationInMotion

See Also:

Constant Field Values

CFG_ignoreInvalidGPSFlag

public static final java.lang.String CFG_ignoreInvalidGPSFlag

See Also:

Constant Field Values

CFG_useLastValidGPSLocation

public static final java.lang.String CFG_useLastValidGPSLocation

See Also:

Constant Field Values

CFG_initialPacket

public static final java.lang.String CFG_initialPacket

See Also:

Constant Field Values

CFG_finalPacket

public static final java.lang.String CFG_finalPacket

See Also:

Constant Field Values

CFG_saveSessionStatistics

public static final java.lang.String CFG_saveSessionStatistics

See Also:

Constant Field Values

CFG_batteryLevelRange

public static final java.lang.String CFG_batteryLevelRange

See Also:

Constant Field Values

Constructor Detail

DCServerFactory

public DCServerFactory()

Method Detail

isCommandTypeAll

public static boolean isCommandTypeAll(java.lang.String type)

Garmin_getStopStatusDescription

public static java.lang.String Garmin_getStopStatusDescription(java.util.Locale locale,
                                                               int stopStatus)

GetSpecificDCServerName

public static java.lang.String GetSpecificDCServerName()

Gets the specific DCServerConfig name, or null if there is no specific DCServerConfig.

Returns:

The name of the specific DCServerConfig entry

HasSpecificDCServerName

public static boolean HasSpecificDCServerName()

Returns true if a specific DCServerConfig name is defined.

Returns:

True if a specific DCServerConfig name is defined.

SetSpecificDCServerName

public static void SetSpecificDCServerName(java.lang.String name)

Sets the specific DCServerConfig name

Parameters:

name - The name of the DCServerConfig entry

InitSpecificDCServerName

public static void InitSpecificDCServerName()

Initialize the specific DCServerConfig name

isValidPort

public static boolean isValidPort(int port)

Returns true if the specified port is valid

Parameters:

port - The port to validate

Returns:

True if the specified port is valid

isValidPort

public static boolean isValidPort(int[] port)

Returns true if the specified port array is valid

Parameters:

port - The ports to validate

Returns:

True if the specified port array is valid

serverJarExists

public static boolean serverJarExists(java.lang.String name)

Returns true if the named server is defined

GetResultCode

public static DCServerFactory.ResultCode GetResultCode(java.lang.String code,
                                                       DCServerFactory.ResultCode dft)

loadDCServerXML

public static void loadDCServerXML(java.io.File xmlFile)

init

public static void init()

addDCS

public static DCServerConfig addDCS(java.lang.String name,
                                    java.lang.String desc,
                                    int[] tcpPorts,
                                    int[] udpPorts,
                                    int commandPort,
                                    long flags,
                                    java.lang.String... uniqPfx)

Adds the named server to the list of registered servers

_getServerConfig

public static DCServerConfig _getServerConfig(java.lang.String name)

Returns the DCServerConfig instance for the specified device communication server name

Parameters:

name - The name of the device communication server

Returns:

The DCServerConfig instance

getServerConfig

public static DCServerConfig getServerConfig(java.lang.String name)

Returns the DCServerConfig instance for the specified device communication server name

Parameters:

name - The name of the device communication server

Returns:

The DCServerConfig instance

getServerConfigDescription

public static java.lang.String getServerConfigDescription(java.lang.String serverName)

Gets the server config description

Parameters:

serverName - The server name

Returns:

The server config description

hasServerConfig

public static boolean hasServerConfig(java.lang.String name)

Returns True if the named DCServerConfig has been registered

Parameters:

name - The name of the device communication server

Returns:

True if the named DCServerConfig has been registered

getServerConfigList

public static java.util.List<DCServerConfig> getServerConfigList(boolean inclAll)

Returns a list of all DCServerConfig instances

Returns:

A list of DCServerConfig instances

hasUndefinedServers

public static boolean hasUndefinedServers()

(used by CheckInstall) Return the number of refererenced servers which are undefined

getUndefinedServerList

public static java.util.List<java.lang.String> getUndefinedServerList()

(used by CheckInstall) Returns the list of referenced, but undefined, servers

supportsCommandDispatcher

public static boolean supportsCommandDispatcher(java.lang.String serverName)

Returns true if the named server supports a command port

supportsCommandDispatcher

public static boolean supportsCommandDispatcher(Device device)

Returns true if the server for the specified Device supports a command port

hasDigitalInputs

public static boolean hasDigitalInputs(java.lang.String serverName)

Returns true if this device supports digital inputs

Returns:

True if this device supports digital inputs

hasDigitalOutputs

public static boolean hasDigitalOutputs(java.lang.String serverName)

Returns true if this device supports digital outputs

Returns:

True if this device supports digital outputs

getPort

public static int getPort(int port)

Returns the server port (with constant offset applied)

Parameters:

port - server port (without offset applied)

Returns:

The server port

getPorts

public static int[] getPorts(int... ports)

Returns an array of server ports (with constant offset applied)

Parameters:

ports - array of server ports (without offset applied)

Returns:

The server port array

getCommandResultID

public static java.lang.String getCommandResultID(RTProperties r)

Gets the Command ResultCode ID

isCommandResultOK

public static boolean isCommandResultOK(RTProperties r)

Return true if the ResultCode represents a successful request/operation

isCommandResultOK

public static boolean isCommandResultOK(DCServerFactory.ResultCode rid)

Return true if the ResultCode represents a successful request/operation

getCommandResultMessage

public static java.lang.String getCommandResultMessage(RTProperties r)

Gets the Command ResultCode Message

SendSMSCommand

public static DCServerFactory.ResultCode SendSMSCommand(java.lang.String handlerName,
                                                        Device device,
                                                        java.lang.String commandStr)

Send SMS command to device

Parameters:

handlerName - The name of the SMS gateway handler

device - The device to which the SMS command is sent

commandStr - The SMS command which is sent

Returns:

The ResultCode

getCommandDispatcherPort

public static int getCommandDispatcherPort(java.lang.String serverName)

Gets the server 'command' port

Parameters:

serverName - The server name

Returns:

The server command port, or '0' if not supported

sendServerCommand

public static RTProperties sendServerCommand(Device device,
                                             java.lang.String cmdType,
                                             java.lang.String cmdName,
                                             java.lang.String[] cmdArgs)

Send a command request to the server command port for the specified Device

createRTProperties

public static RTProperties createRTProperties(java.lang.String accountID,
                                              java.lang.String deviceID,
                                              java.lang.String uniqueID,
                                              java.lang.String cmdType,
                                              java.lang.String cmdName,
                                              java.lang.String[] cmdArgs)

calculateOdometerKM

public static double calculateOdometerKM(EventData prevEvent,
                                         GeoPoint toPoint)

Calculates/returns the next odometer value

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          java.lang.String ipAddr,
                                          boolean isDuplex,
                                          double lat,
                                          double lon,
                                          java.lang.String data)

Add device-id to UnassignedDevice table

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          GeoPoint geoPoint)

Add device-id to UnassignedDevice table

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          java.lang.String ipAddr,
                                          boolean isDuplex,
                                          GeoPoint geoPoint)

Add device-id to UnassignedDevice table

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          java.lang.String ipAddr,
                                          boolean isDuplex,
                                          GeoPoint geoPoint,
                                          java.lang.String data)

Add device-id to UnassignedDevice table

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          double lat,
                                          double lon)

Add device-id to UnassignedDevice table

addUnassignedDevice

public static boolean addUnassignedDevice(java.lang.String dcName,
                                          java.lang.String mobID,
                                          java.lang.String ipAddr,
                                          boolean isDuplex,
                                          double lat,
                                          double lon)

Add device-id to UnassignedDevice table

getPreviousEventData

public static EventData getPreviousEventData(Device device,
                                             long fixtime)

Returns the EventData record previous to the specified fixtime

Parameters:

device - The Device record handle

fixtime - The current event fixtime

Returns:

The previous event, or null if there is no previous event

checkMemoryUsage

public static void checkMemoryUsage()

Analyzes/Prints the current memory usage. (see OSTools.checkMemoryUsage)

loadDeviceByAcountDeviceID

public static Device loadDeviceByAcountDeviceID(java.lang.String accountID,
                                                java.lang.String deviceID)

Load device record from account-id/device-id

Parameters:

accountID - The Account ID

deviceID - The DeviceID

Returns:

The Device record

loadDeviceByPrefixedModemID

public static Device loadDeviceByPrefixedModemID(java.lang.String[] prefix,
                                                 java.lang.String modemID)

Load device record from unique-id

Parameters:

prefix - An array of unique-id prefixes

modemID - The unique modem ID (IMEI, ESN, etc)

Returns:

The Device record

loadDeviceByPrefixedModemID

public static Device loadDeviceByPrefixedModemID(java.lang.String[] prefix,
                                                 java.lang.String modemID,
                                                 java.lang.String serverID,
                                                 java.lang.String ipAddress,
                                                 boolean isDuplex,
                                                 GeoPoint geoPoint)

Load device record from unique-id

Parameters:

prefix - An array of unique-id prefixes

modemID - The unique modem ID (IMEI, ESN, etc)

serverID - The server-id (also 'device code'), used for UnassignedDevice entries

ipAddress - The inbound IP address, used for UnassignedDevice entries

isDuplex - True if duplex, false if simplex, used for UnassignedDevice entries

geoPoint - The GPS location of the device, used for UnassignedDevice entries

Returns:

The Device record

loadDeviceByPrefixedModemID

public static Device loadDeviceByPrefixedModemID(java.lang.String[] prefix,
                                                 java.lang.String modemID,
                                                 boolean saveUnassigned,
                                                 java.lang.String serverID,
                                                 java.lang.String ipAddress,
                                                 boolean isDuplex,
                                                 GeoPoint geoPoint)

Load device record from unique-id

Parameters:

prefix - An array of unique-id prefixes

modemID - The unique modem ID (IMEI, ESN, etc)

saveUnassigned - True to save Device to UnassignedDevices, if device is not found

serverID - The server-id (also 'device code'), used for UnassignedDevice entries

ipAddress - The inbound IP address, used for UnassignedDevice entries

isDuplex - True if duplex, false if simplex, used for UnassignedDevice entries

geoPoint - The GPS location of the device, used for UnassignedDevice entries

Returns:

The Device record

lookupUniqueID

public static Device[] lookupUniqueID(java.lang.String mobileID)

Lookup the specified mobile-id in the Transport/Device tables, use all available DC servers unique-id prefixes.

Parameters:

mobileID - The mobile ID to search for

Returns:

An array of matching Devices, or null if no Device was found

getUniquePrefixString

public static java.lang.String getUniquePrefixString(java.lang.String[] pfx)

Returns a String representation of the unique-id prefix array

Parameters:

pfx - The UniqueID prefixes

Returns:

A String representation of the unique-id prefix array

CONFIG_tcpPort

public static java.lang.String[] CONFIG_tcpPort(java.lang.String name)

Return an array of "TCP port" property names

Parameters:

name - The server name

Returns:

An array of "TCP port" property names

CONFIG_udpPort

public static java.lang.String[] CONFIG_udpPort(java.lang.String name)

Return an array of "UDP port" property names

Parameters:

name - The server name

Returns:

An array of "UDP port" property names

CONFIG_commandPort

public static java.lang.String[] CONFIG_commandPort(java.lang.String name)

Return an array of "Command port" property names

Parameters:

name - The server name

Returns:

An array of "Command port" property names

CONFIG_commandProtocol

public static java.lang.String[] CONFIG_commandProtocol(java.lang.String name)

Return an array of "Command Protocol" property names Return command protocol to used when communicating with remote devices

Parameters:

name - The server name

Returns:

An array of "Command Protocol" property names

CONFIG_clientCommandPort_udp

public static java.lang.String[] CONFIG_clientCommandPort_udp(java.lang.String name)

Return an array of "Client Command port" property names

Parameters:

name - The server name

Returns:

An array of "Client Command port" property names

CONFIG_clientCommandPort_tcp

public static java.lang.String[] CONFIG_clientCommandPort_tcp(java.lang.String name)

Return an array of "Client Command port" property names

Parameters:

name - The server name

Returns:

An array of "Client Command port" property names

CONFIG_ackResponsePort

public static java.lang.String[] CONFIG_ackResponsePort(java.lang.String name)

Return an array of "ACK Response port" property names

Parameters:

name - The server name

Returns:

An array of "ACK Response port" property names

CONFIG_tcpIdleTimeoutMS

public static java.lang.String[] CONFIG_tcpIdleTimeoutMS(java.lang.String name)

Return an array of "TCP idle timeout" property names

Parameters:

name - The server name

Returns:

An array of "TCP idle timeout" property names

CONFIG_tcpPacketTimeoutMS

public static java.lang.String[] CONFIG_tcpPacketTimeoutMS(java.lang.String name)

Return an array of "TCP packet timeout" property names

Parameters:

name - The server name

Returns:

An array of "TCP packet timeout" property names

CONFIG_tcpSessionTimeoutMS

public static java.lang.String[] CONFIG_tcpSessionTimeoutMS(java.lang.String name)

Return an array of "TCP session timeout" property names

Parameters:

name - The server name

Returns:

An array of "TCP session timeout" property names

CONFIG_udpIdleTimeoutMS

public static java.lang.String[] CONFIG_udpIdleTimeoutMS(java.lang.String name)

Return an array of "UDP idle timeout" property names

Parameters:

name - The server name

Returns:

An array of "UDP idle timeout" property names

CONFIG_udpPacketTimeoutMS

public static java.lang.String[] CONFIG_udpPacketTimeoutMS(java.lang.String name)

Return an array of "UDP packet timeout" property names

Parameters:

name - The server name

Returns:

An array of "UDP packet timeout" property names

CONFIG_udpSessionTimeoutMS

public static java.lang.String[] CONFIG_udpSessionTimeoutMS(java.lang.String name)

Return an array of "UDP session timeout" property names

Parameters:

name - The server name

Returns:

An array of "UDP session timeout" property names

CONFIG_uniquePrefix

public static java.lang.String[] CONFIG_uniquePrefix(java.lang.String name)

Return an array of UniquID prefix property names

Parameters:

name - The server name

Returns:

An array of UniquID prefix property names

CONFIG_minimumMovedMeters

public static java.lang.String[] CONFIG_minimumMovedMeters(java.lang.String name)

Return an array of "Minimum Moved Meters" property names

Parameters:

name - The server name

Returns:

An array of "Minimum Moved Meters" names

CONFIG_minimumSpeedKPH

public static java.lang.String[] CONFIG_minimumSpeedKPH(java.lang.String name)

Return an array of "Minimum SpeedKPH" property names

Parameters:

name - The server name

Returns:

An array of "Minimum SpeedKPH" names

CONFIG_estimateOdometer

public static java.lang.String[] CONFIG_estimateOdometer(java.lang.String name)

Return an array of "Estimate Odometer" property names

Parameters:

name - The server name

Returns:

An array of "Estimate Odometer" names

CONFIG_ignoreDeviceOdometer

public static java.lang.String[] CONFIG_ignoreDeviceOdometer(java.lang.String name)

Return an array of "Ignore Device Odometer" property names

Parameters:

name - The server name

Returns:

An array of "Ignore Device Odometer" names

CONFIG_simulateGeozones

public static java.lang.String[] CONFIG_simulateGeozones(java.lang.String name)

Return an array of "Simulate Geozone Arrival/Departure" property names

Parameters:

name - The server name

Returns:

An array of "Simulate Geozone Arrival/Departure" names

CONFIG_maximumHDOP

public static java.lang.String[] CONFIG_maximumHDOP(java.lang.String name)

Return an array of "Maximum HDOP" property names

Parameters:

name - The server name

Returns:

An array of "Maximum HDOP" names

CONFIG_simulateDigitalInputs

public static java.lang.String[] CONFIG_simulateDigitalInputs(java.lang.String name)

Return an array of "Simulate Digital Inputs" property names

Parameters:

name - The server name

Returns:

An array of "Simulate Digital Inputs" names

CONFIG_startStopSupported

public static java.lang.String[] CONFIG_startStopSupported(java.lang.String name)

Return an array of "Start/Stop StatusCode supported" property names

Parameters:

name - The server name

Returns:

An array of "Start/Stop StatusCode supported" property names

CONFIG_saveRawDataPackets

public static java.lang.String[] CONFIG_saveRawDataPackets(java.lang.String name)

Return an array of "Save Raw Data Packet" property names

Parameters:

name - The server name

Returns:

An array of "Save Raw Data Packet" property names

CONFIG_statusLocationInMotion

public static java.lang.String[] CONFIG_statusLocationInMotion(java.lang.String name)

Return an array of "Status Location/InMotion Translation" property names

Parameters:

name - The server name

Returns:

An array of "Status Location/InMotion Translation" property names

CONFIG_ignoreInvalidGPSFlag

public static java.lang.String[] CONFIG_ignoreInvalidGPSFlag(java.lang.String name)

Return an array of "Ignore Invalid GPS Flag" property names

Parameters:

name - The server name

Returns:

An array of "Ignore Invalid GPS Flag" property names

CONFIG_useLastValidGPSLocation

public static java.lang.String[] CONFIG_useLastValidGPSLocation(java.lang.String name)

Return an array of "Use Last Valid GPS Location" property names

Parameters:

name - The server name

Returns:

An array of "Use Last Valid GPS Location" property names

CONFIG_initialPacket

public static java.lang.String[] CONFIG_initialPacket(java.lang.String name)

Return an array of "Initial Packet" property names

Parameters:

name - The server name

Returns:

An array of "Initial Packet" property names

CONFIG_finalPacket

public static java.lang.String[] CONFIG_finalPacket(java.lang.String name)

Return an array of "Final Packet" property names

Parameters:

name - The server name

Returns:

An array of "Final Packet" property names

CONFIG_saveSessionStatistics

public static java.lang.String[] CONFIG_saveSessionStatistics(java.lang.String name)

Return an array of "Save Session Statistics" property names

Parameters:

name - The server name

Returns:

An array of "Save Session Statistics" property names

CONFIG_batteryLevelRange

public static java.lang.String[] CONFIG_batteryLevelRange(java.lang.String name)

Return an array of "Battery Level Range" property names

Parameters:

name - The server name

Returns:

An array of "Battery Level Range" property names

main

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

Command-line main entry point