// ---------------------------------------------------------------------------- // Copyright 2007-2013, GeoTelematic Solutions, Inc. // All rights reserved // ---------------------------------------------------------------------------- // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // // ---------------------------------------------------------------------------- // Notes: // This 'Device' table currently assumes a 1-1 relationship between the device hardware // used to perform the tracking and communication, and the Vehicle being tracked. // However, it is possible to have more than one device on a given vehicle, or a single // hardware device may be moved between vehicles. Ideally, this table should be split // into 2 separate tables: The Device table, and the MobileAsset table. // ---------------------------------------------------------------------------- // Change History: // 2006/03/26 Martin D. Flynn // -Initial release // 2006/04/09 Martin D. Flynn // -Integrate DBException // 2006/05/23 Martin D. Flynn // -Changed column 'uniqueID' to a 'VARCHAR(40)' // 2007/01/25 Martin D. Flynn // -Moved to "OpenGTS" // -Various new fields added // 2007/03/25 Martin D. Flynn // -Added 'equipmentType', 'groupID' // -Moved to 'org.opengts.db.tables' // 2007/04/15 Martin D. Flynn // -Added 'borderCrossing' column. // 2007/06/30 Martin D. Flynn // -Added 'getFirstEvent', 'getLastEvent' // 2007/07/14 Martin D. Flynn // -Added '-uniqueid' command-line option. // 2007/07/27 Martin D. Flynn // -Added 'notifyAction' column // 2007/08/09 Martin D. Flynn // -Renamed command-line option "uniqid" to "uniqueid" // -Set 'deviceExists' to true when creating a new device. // 2007/09/16 Martin D. Flynn // -Integrated DBSelect // -Added handlers for client device errors, diagnostics, and properties. // -Added device lookup for the specified unique-id. // 2007/11/28 Martin D. Flynn // -Added columns 'lastBorderCrossTime', 'simPhoneNumber', 'lastInputState'. // -Added additional 'Entity' methods // -Added OpenDMTP 'CommandErrors' definition section. // -Added '-editall' command-line option to display all fields. // 2007/12/13 Martin D. Flynn // -Added an EventData filter to check for invalid odometer values. // 2007/01/10 Martin D. Flynn // -Added column 'notes', 'imeiNumber' // -Removed handlers for client device errors, diagnostics, and properties // (these handlers have been implemented in 'DeviceDBImpl.java') // 2008/02/11 Martin D. Flynn // -Added columns 'FLD_deviceCode', 'FLD_vehicleID' // 2008/03/12 Martin D. Flynn // -Added column 'FLD_notifyPriority' // 2008/05/14 Martin D. Flynn // -Integrated Device DataTransport interface // 2008/05/20 Martin D. Flynn // -Fixed 'UniqueID" to again make it visible to the CLI record editor. // 2008/06/20 Martin D. Flynn // -Added column 'FLD_notifyDescription' // 2008/07/21 Martin D. Flynn // -Added column 'FLD_linkURL' // 2008/08/24 Martin D. Flynn // -Added 'validGPS' argument to 'getRangeEvents' and 'getLatestEvents' // 2008/09/01 Martin D. Flynn // -Added optional field list "FixedLocationFieldInfo" // -Added field/column "FLD_smsEmail" // 2008/10/16 Martin D. Flynn // -Added FLD_lastPingTime, FLD_totalPingCount // 2008/12/01 Martin D. Flynn // -Added FLD_linkDescription, FLD_pushpinID // -Added optional field list 'GeoCorridorFieldInfo' // 2009/05/24 Martin D. Flynn // -Added FLD_pendingPingCommand, FLD_remotePortCurrent // -Added FLD_lastValidLatitude/Longitude to optimize Geozone calculations. // -Added FLS_lastOdometerKM to optimize GPS odometer calculations. // 2009/06/01 Martin D. Flynn // -Increased background thread pool size/limit to 25. // 2009/09/23 Martin D. Flynn // -Added support for ignoring/truncating events with future timestamps // -Added FLD_maxPingCount // 2009/10/02 Martin D. Flynn // -Changed "checkGeozoneTransitions" to return an array of Geozone transitions, // fixing the case where 2 adjacent events occur in 2 different geozones. // 2009/11/01 Martin D. Flynn // -Added FLD_expectAck, FLD_lastAckCommand, FLD_lastAckTime // 2009/12/16 Martin D. Flynn // -Added command-line check for "Periodic Maintenance/Service Due" (-maintkm=email) // 2010/01/29 Martin D. Flynn // -Added FLD_listenPortCurrent // 2010/04/11 Martin D. Flynn // -Added FLD_dataKey, FLD_displayColor, FLD_licensePlate // -Added 'deleteEventDataPriorTo' to delete old historical EventData records. // 2010/07/04 Martin D. Flynn // -Added FLD_expirationTime, FLD_maintIntervalKM1, FLD_maintOdometerKM1 // 2010/07/18 Martin D. Flynn // -Added FLD_lastBatteryLevel, FLD_fuelCapacity // 2010/09/09 Martin D. Flynn // -Added "deleteOldEvents" option // 2010/11/29 Martin D. Flynn // -Added FLD_lastFuelLevel // -Added configurable "maximum odometer km" // 2011/01/28 Martin D. Flynn // -Added FLD_lastOilLevel // 2011/03/08 Martin D. Flynn // -Added "getFieldValueString" // -Added alternate key "simphone" to field FLD_simPhoneNumber. // -Added "loadDeviceBySimPhoneNumber(...)" // -Added column FLD_speedLimitKPH // 2011/04/01 Martin D. Flynn // -Added FuelManager module support (requires installed FuelManager) // -If "ALLOW_USE_EMAIL_WRAPPER" is false, "getNotifyUseWrapper()" returns false. // 2011/05/13 Martin D. Flynn // -Change to invalid speed maximum checking. // 2011/06/16 Martin D. Flynn // -"lastNotifyTime"/"lastNotifyCode" now only changed if modified. // (ie. removed from "DefaultUpdatedFieldsList") // -Added FLD_fuelEconomy (approximate fuel economy), FLD_lastEngineHours // 2011/07/01 Martin D. Flynn // -Added "CheckNotifySelector()" // -Added FLD_lastValidHeading // 2011/08/21 Martin D. Flynn // -Added convenience setting check for geozone arrive/depart auto-notify // 2011/10/03 Martin D. Flynn // -Added FLD_parkedLatitude, FLD_parkedLongitude, FLD_parkedRadius, FLD_lastFuelTotal // 2011/12/06 Martin D. Flynn // -Added FLD_jobNumber, FLD_jobLatitude, FLD_jobLongitude, FLD_jobRadius, FLD_planDistanceKM // -Added KEY_DRIVERID, KEY_DRIVER to "getFieldValueString" // -Updated "getFieldValueString" to also search for matching table fields. // 2012/02/03 Martin D. Flynn // -Added FLD_lastIgnitionOffTime // -Added optimization for "getCurrentIgnitionState()" // 2012/04/03 Martin D. Flynn // -Validate both last ignition on/off times in "getCurrentIgnitionState()" // before comparing timestamps. // -Added FLD_simID, FLD_lastTcpSessionID // -Added runtime config settings for "GetSimulateEngineHours()". // -Added checking for ".isDeviceInGroup(...)" during Geozone arrive/depart detection. // -Added "appendLastFaultCode(...)" to append new OBDII fault codes to old. // -Renamed "getFieldValueString" to "getKeyFieldValue", and added title support. // 2012/05/27 Martin D. Flynn // -Added option to save EventData "driverID" to Device. (see SAVE_EVENT_DRIVER_ID) // -Fixed NPE in "_getKeyFieldString" // 2012/06/29 Martin D. Flynn // -Added FLD_lastAckResponse (pending, not yet fully implemented) // 2012/08/01 Martin D. Flynn // -Added FLD_assignedUserID, FLD_lastServiceTime, FLD_nextServiceTime // 2012/10/16 Martin D. Flynn // -Added FLD_expectAckCode // 2012/12/24 Martin D. Flynn // -Fix Reverse-Geocoding for cell-tower locations when RG 'alwaysFast' is true. // 2013/02/06 Martin D. Flynn // -Added check for ".getSmsEnabled()" before sending SMS messages. // 2013/03/01 Martin D. Flynn // -Added check for past event timestamps (see "pastEventDateAction") // -Ignore Geozone check ("checkGeozoneTransitions") for events that are older than // the last received event. // -Set event "inputMask" to last device input state, if unset by DCS. // 2013/04/08 Martin D. Flynn // -Added "zero"/"setzero" to invalid speed action (see "invalidSpeedAction") // -Added check for duplicate STATUS_GFMI_STOP_STATUS_# events // -Added FLD_installTime, FLD_resetTime, FLD_vehicleMake, FLD_vehicleModel // -Added FLD_commandStateMask, FLD_hoursOfOperation // 2013/05/28 Martin D. Flynn // -Added FLD_lastDistanceKM to default update list // -Updated handling of DriverID // 2013/08/06 Martin D. Flynn // -Added FLD_lastEngineOnTime/FLD_lastEngineOffTime // -Support engine-hour accumulation based on Engine On/Off events. // ---------------------------------------------------------------------------- package org.opengts.db.tables; import java.lang.*; import java.util.*; import java.math.*; import java.io.*; import java.sql.*; import org.opengts.util.*; import org.opengts.geocoder.*; import org.opengts.cellid.*; import org.opengts.dbtools.*; import org.opengts.dbtypes.*; import org.opengts.db.*; import org.opengts.db.RuleFactory.NotifyAction; import org.opengts.db.tables.Transport.Encodings; /** *** This class represents a tracked asset (ie. something that is being tracked). *** Currently, this DBRecord also represents the tracking hardware device as well. **/ public class Device // Asset extends DeviceRecord implements DataTransport { // ------------------------------------------------------------------------ private static int LogEventDataInsertion = Print.LOG_UNDEFINED; public static void SetLogEventDataInsertion(int logLevel) { if (logLevel >= Print.LOG_WARN) { Device.LogEventDataInsertion = logLevel; } else { Print.logWarn("'SetLogEventDataInsertion' ignoring excessive log level: " + Print.getLogLevelString(logLevel) + " (using LOG_WARN instead)"); Device.LogEventDataInsertion = Print.LOG_WARN; } } // ------------------------------------------------------------------------ /* optimization for caching status code descriptions */ public static boolean CACHE_STATUS_CODE_DESCRIPTIONS = true; /* ReverseGeocodeProvider required on command-line "-insertGP" */ public static boolean INSERT_REVERSEGEOCODE_REQUIRED = false; /* allow Device record specified "notifyUseWrapper" value */ public static boolean ALLOW_USE_EMAIL_WRAPPER = false; /* auto-generate non-moving event just prior to motion-change */ public static boolean AUTO_GENERATE_NON_MOVING_EVENT = false; public static long MAX_STOPPED_DELTA_SEC = DateTime.MinuteSeconds(20); // ------------------------------------------------------------------------ public static final Device EMPTY_ARRAY[] = new Device[0]; public static int LastFaultCodeColumnLength = -1; // ------------------------------------------------------------------------ /* optional columns */ public static final String OPTCOLS_NotificationFieldInfo = "startupInit.Device.NotificationFieldInfo"; public static final String OPTCOLS_BorderCrossingFieldInfo = "startupInit.Device.BorderCrossingFieldInfo"; public static final String OPTCOLS_LinkFieldInfo = "startupInit.Device.LinkFieldInfo"; public static final String OPTCOLS_FixedLocationFieldInfo = "startupInit.Device.FixedLocationFieldInfo"; public static final String OPTCOLS_GeoCorridorFieldInfo = "startupInit.Device.GeoCorridorFieldInfo"; public static final String OPTCOLS_MaintOdometerFieldInfo = "startupInit.Device.MaintOdometerFieldInfo"; public static final String OPTCOLS_WorkOrderInfo = "startupInit.Device.WorkOrderInfo"; public static final String OPTCOLS_DataPushInfo = "startupInit.Device.DataPushInfo"; // ------------------------------------------------------------------------ /* Event update background thread */ private static final int BACKGROUND_THREAD_POOL_SIZE = 30; private static ThreadPool BackgroundThreadPool = new ThreadPool("DeviceEventUpdate", BACKGROUND_THREAD_POOL_SIZE); // ------------------------------------------------------------------------ // new asset defaults private static final String NEW_DEVICE_NAME_ = "New Device"; // ------------------------------------------------------------------------ private static final int EXT_UPDATE_MASK = 0xFFFF; private static final int EXT_UPDATE_NONE = 0x0000; private static final int EXT_UPDATE_CELLGPS = 0x0001; private static final int EXT_UPDATE_ADDRESS = 0x0002; private static final int EXT_UPDATE_BORDER = 0x0004; private static final int EXT_UPDATE_JMS = 0x0008; // ------------------------------------------------------------------------ private static boolean EPS_did_init = false; public static long EPS_RANGE_SECONDS = 3600L; // 1 hour public static long EPS_RANGE_MS = EPS_RANGE_SECONDS * 1000L; public static double EPS_WEIGHT = 0.90; public static double EPS_ALPHA = 1.0 - Math.exp(Math.log(1.0 - EPS_WEIGHT) / (double)EPS_RANGE_MS); public static long MinMax(long val, long min, long max) { return (val < min)? min : (val > max)? max : val; } public static double MinMax(double val, double min, double max) { return (val < min)? min : (val > max)? max : val; } public static void initEventsPerSecond() { // synchronized if (!EPS_did_init) { synchronized (DBConfig.PROP_Device_eventsPerSecond) { if (!EPS_did_init) { double E[] = RTConfig.getDoubleArray(DBConfig.PROP_Device_eventsPerSecond,null); if (!ListTools.isEmpty(E)) { // , // Range Seconds long rangeSec = (E.length > 0)? Math.round(E[0]) : EPS_RANGE_SECONDS; // Weight double weight = (E.length > 1)? E[1] : EPS_WEIGHT; if (weight >= 2.0) { weight = weight / 100.0; } // adjust EPS vars EPS_RANGE_SECONDS = MinMax(rangeSec, 10L, DateTime.DaySeconds(1));; EPS_RANGE_MS = EPS_RANGE_SECONDS * 1000L; EPS_WEIGHT = MinMax(weight, 0.05, 0.999); EPS_ALPHA = 1.0 - Math.exp(Math.log(1.0 - EPS_WEIGHT) / (double)EPS_RANGE_MS); } else { // leave as-is } EPS_did_init = true; } } } } // ------------------------------------------------------------------------ /* Default "Device" title (ie. "Taxi", "Tractor", "Vehicle", etc) */ public static String[] GetTitles(Locale loc) { I18N i18n = I18N.getI18N(Device.class, loc); return new String[] { i18n.getString("Device.title.singular", "Vehicle"), i18n.getString("Device.title.plural" , "Vehicles"), }; } // ------------------------------------------------------------------------ // border crossing flags (see 'borderCrossing' column) /** *** BorderCrossing enabled state enumeration **/ public enum BorderCrossingState implements EnumTools.StringLocale, EnumTools.IntValue { OFF ( 0, I18N.getString(Device.class,"Device.boarderCrossing.off","off")), ON ( 1, I18N.getString(Device.class,"Device.boarderCrossing.on" ,"on" )); // --- private int vv = 0; private I18N.Text aa = null; BorderCrossingState(int v, I18N.Text a) { vv = v; aa = a; } public int getIntValue() { return vv; } public String toString() { return aa.toString(); } public String toString(Locale loc) { return aa.toString(loc); } }; // ------------------------------------------------------------------------ // Reminder type /** *** Reminder Type enumeration **/ public enum ReminderType implements EnumTools.StringLocale, EnumTools.IntValue { PERIODIC_INTERVAL ( 0, I18N.getString(Device.class,"Device.reminderType.periodicInterval","Periodic Interval")), SINGLE_INTERVAL ( 1, I18N.getString(Device.class,"Device.reminderType.singleInterval" ,"Single Interval" )); // --- private int vv = 0; private I18N.Text aa = null; ReminderType(int v, I18N.Text a) { vv = v; aa = a; } public int getIntValue() { return vv; } public String toString() { return aa.toString(); } public String toString(Locale loc) { return aa.toString(loc); } }; /** *** Returns the defined ReminderType for the specified device. *** @param d The device from which the ReminderType will be obtained. *** If null, the default ReminderType will be returned. *** @return The ReminderType [0=periodic, 1=single] **/ public static ReminderType getReminderType(Device d) { return (d != null)? EnumTools.getValueOf(ReminderType.class,d.getReminderType()) : EnumTools.getDefault(ReminderType.class); } // ------------------------------------------------------------------------ // FuelEconomy type /** *** FuelEconomy Type enumeration **/ public enum FuelEconomyType implements EnumTools.StringLocale, EnumTools.IntValue { UNKNOWN ( 0, I18N.getString(Device.class,"Device.fuelEconomyType.notAvail","n/a" ), I18N.getString(Device.class,"Device.fuelEconomyType.unknown" ,"Unknown" )), FUEL_CONSUMED ( 1, I18N.getString(Device.class,"Device.fuelEconomyType.used" ,"Used" ), I18N.getString(Device.class,"Device.fuelEconomyType.fuelUsed" ,"Fuel Used" )), FUEL_REMAINING ( 2, I18N.getString(Device.class,"Device.fuelEconomyType.tank" ,"Tank" ), I18N.getString(Device.class,"Device.fuelEconomyType.tankRemaining","Tank Remaining")), FUEL_LEVEL ( 3, I18N.getString(Device.class,"Device.fuelEconomyType.level" ,"Level" ), I18N.getString(Device.class,"Device.fuelEconomyType.fuelLevel" ,"Fuel Level" )), EVENT_ECONOMY ( 8, I18N.getString(Device.class,"Device.fuelEconomyType.event" ,"Event" ), I18N.getString(Device.class,"Device.fuelEconomyType.eventEconomy" ,"Event Economy" )), DEVICE_ECONOMY ( 9, I18N.getString(Device.class,"Device.fuelEconomyType.device" ,"Device"), I18N.getString(Device.class,"Device.fuelEconomyType.deviceEconomy","Device Economy")); // --- private int vv = 0; private I18N.Text aa = null; // abbreviation private I18N.Text dd = null; // description FuelEconomyType(int v, I18N.Text a, I18N.Text d) { vv = v; aa = a; dd = d; } public int getIntValue() { return vv; } public String getAbbrev() { return aa.toString(); } public String getAbbrev(Locale loc) { return aa.toString(loc); } public String toString() { return dd.toString(); } public String toString(Locale loc) { return dd.toString(loc); } } // ------------------------------------------------------------------------ // maximum reasonable odometer value for a vehicle // TODO: this should be device dependent public static final boolean CHECK_LAST_ODOMETER = false; /** *** Get configured maximum allowed odometer value *** @return Maximum configured allowed odometer value **/ public static boolean GetCheckLastOdometer() { // TODO: optimize return RTConfig.getBoolean(DBConfig.PROP_Device_checkLastOdometer, CHECK_LAST_ODOMETER); } // ------------------------------------------------------------------------ // (EXPERIMENTAL) Simulate Engine Hours from ignition state // TODO: this should be device dependent public static boolean SIMULATE_ENGINE_HOURS = false; /** *** Get configured state of estimating engine hours based on ignition state *** @return Estimating engine hours based on ignition state **/ public static boolean GetSimulateEngineHours(Device dev) { // TODO: optimize return RTConfig.getBoolean(DBConfig.PROP_Device_simulateEngineHours, SIMULATE_ENGINE_HOURS); } // ------------------------------------------------------------------------ // (EXPERIMENTAL) Update Event loc if invalid and it has a valid GeozoneID // TODO: this should be device dependent public static boolean UPDATE_EVENT_WITH_GEOZONE_LOC = false; /** *** Get configured state obtaining lat/lon from Geozone *** @return Obtain lat/lon from Geozone **/ public static boolean UpdateEventWithGeozoneLocation() { // TODO: optimize return RTConfig.getBoolean(DBConfig.PROP_Device_updateEventWithGeozoneLoc, UPDATE_EVENT_WITH_GEOZONE_LOC); } // ------------------------------------------------------------------------ // maximum reasonable odometer value for a vehicle // TODO: this should be device dependent public static final double MAX_DEVICE_ODOM_KM = 1000000.0 * GeoPoint.KILOMETERS_PER_MILE; /** *** Get configured maximum allowed odometer value *** @return Maximum configured allowed odometer value **/ public static double GetMaximumOdometerKM() { // TODO: optimize return RTConfig.getDouble(DBConfig.PROP_Device_maximumOdometerKM, MAX_DEVICE_ODOM_KM); } // ------------------------------------------------------------------------ // maximum reasonable odometer value for a vehicle // TODO: this should be device dependent private static final double MAX_DEVICE_RUNTIME_HOURS = DateTime.DaySeconds(365*30)/3600.0; /** *** Get configured maximum allowed engine-hours value *** @return Maximum configured allowed engine-hours value **/ public static double GetMaximumRuntimeHours() { return RTConfig.getDouble(DBConfig.PROP_Device_maximumRuntimeHours, MAX_DEVICE_RUNTIME_HOURS); } // ------------------------------------------------------------------------ // check notify rule selector /* check device rule selector */ private static final boolean CHECK_NOTIFY_SELECTOR = true; /** *** True to test notify rule selector, false to ignore *** @return True to test notify rule selector, false to ignore **/ public static boolean CheckNotifySelector() { if (!Device.hasRuleFactory()) { // no rule factory, do not check selector return false; } else if (!RTConfig.getBoolean(DBConfig.PROP_Device_checkNotifySelector,CHECK_NOTIFY_SELECTOR)) { // explicit false return false; } else if (Device.hasENRE()) { // check ENRE specific setting return RTConfig.getBoolean(DBConfig.PROP_Device_checkNotifySelector_ENRE,false); } else { // true return true; } } // ------------------------------------------------------------------------ // save DriverID from EventData record into Device and Driver record // TODO: this should be device dependent public static final boolean SAVE_EVENT_DRIVER_ID = true; /** *** Returns true if configured to save the EventData "driverID" into the Device record *** @return True to save EventData "driverID", false otherwise. **/ public static boolean GetSaveEventDriverID() { // TODO: optimize return RTConfig.getBoolean(DBConfig.PROP_Device_saveEventDriverID, SAVE_EVENT_DRIVER_ID); } // ------------------------------------------------------------------------ // CellTower Location API private static boolean cellTower_initDefault = false; private static MobileLocationProvider cellTower_GetLocation = null; /** *** Sets the MobileLocationProvider *** @param ctgl The MobileLocationProvider **/ public static void setCellTowerGetLocation(MobileLocationProvider ctgl) { Device.cellTower_initDefault = true; if (ctgl != null) { Device.cellTower_GetLocation = ctgl; Print.logDebug("Device CellTower.GetLocation installed: " + StringTools.className(ctgl)); } else if (Device.cellTower_GetLocation != null) { Device.cellTower_GetLocation = null; Print.logDebug("Device CellTower.GetLocation removed."); } } /** *** Returns true if a MobileLocationProvider is defined *** @return True if a MobileLocationProvider is defined **/ public static boolean hasCellTowerGetLocation() { return (Device.cellTower_GetLocation != null); } /** *** Gets the MobileLocationProvider *** @return The MobileLocationProvider **/ public static MobileLocationProvider getMobileLocationProvider() { if (!Device.cellTower_initDefault) { Device.cellTower_initDefault = true; if (Device.cellTower_GetLocation == null) { Device.cellTower_GetLocation = null; // CellTower.GetDefaultCellTowerLocationInterface(); // may still be null } } return Device.cellTower_GetLocation; } // ------------------------------------------------------------------------ // (Vehicle) Rule factory private static RuleFactory ruleFactory = null; /** *** Sets the RuleFactory *** @param rf The RuleFactory **/ public static void setRuleFactory(RuleFactory rf) { if (rf != null) { Device.ruleFactory = rf; Print.logDebug("Device RuleFactory installed: " + StringTools.className(rf)); } else if (Device.ruleFactory != null) { Device.ruleFactory = null; Print.logDebug("Device RuleFactory removed."); } } /** *** Returns true if a RuleFactory is defined *** @return True if a RuleFactory is defined **/ public static boolean hasRuleFactory() { return (Device.ruleFactory != null); } /** *** Returns true if the defined RuleFactory is the ENRE *** @return True if the defined RuleFactory is the ENRE **/ public static boolean hasENRE() { if (Device.ruleFactory != null) { //return Device.ruleFactory.getName().equals("GTSRulesEngine"); //return DBConfig.hasRulePackage(); return OSTools.instanceOf(Device.ruleFactory, DBConfig.CLASS_RULE_EventRuleFactory); } else { return false; } } /** *** Gets the RuleFactory *** @return The RuleFactory **/ public static RuleFactory getRuleFactory() { return Device.ruleFactory; } /** *** Gets the RuleFactory *** @param checkRuntime True to peform the RuleFactory runtime validation *** @return The RuleFactory **/ public static RuleFactory getRuleFactory(boolean checkRuntime) { if (checkRuntime && (Device.ruleFactory != null)) { return Device.ruleFactory.checkRuntime()? Device.ruleFactory : null; } else { return Device.ruleFactory; } } // ------------------------------------------------------------------------ // (Device) Session statistics private static SessionStatsFactory statsFactory = null; /** *** Sets the SessionStatsFactory *** @param rf The SessionStatsFactory **/ public static void setSessionStatsFactory(SessionStatsFactory rf) { if (rf != null) { Device.statsFactory = rf; Print.logDebug("Device SessionStatsFactory installed: " + StringTools.className(Device.statsFactory)); } else if (Device.statsFactory != null) { Device.statsFactory = null; Print.logDebug("Device SessionStatsFactory removed."); } } /** *** Returns true if a SessionStatsFactory has been defined *** @return True if a SessionStatsFactory has been defined **/ public static boolean hasSessionStatsFactory() { return (Device.statsFactory != null); } /** *** Gets the SessionStatsFactory *** @return The SessionStatsFactory **/ public static SessionStatsFactory getSessionStatsFactory() { return Device.statsFactory; } // ------------------------------------------------------------------------ // (Vehicle) Entity manager private static EntityManager entityManager = null; /** *** Sets the EntityManager *** @param ef The EntityManager **/ public static void setEntityManager(EntityManager ef) { if (ef != null) { Device.entityManager = ef; //Print.logDebug("Device EntityManager installed: " + StringTools.className(Device.entityManager)); } else if (Device.entityManager != null) { Device.entityManager = null; //Print.logDebug("Device EntityManager removed."); } } /** *** Returns true if an EntityManager has been defined *** @return True if an EntityManager has been defined **/ public static boolean hasEntityManager() { return (Device.entityManager != null); } /** *** Gets the defined EntityManager *** @return The defined EntityManager **/ public static EntityManager getEntityManager() { return Device.entityManager; } // -------------------------------- /** *** Gets the Description for the specified Entity ID *** @param accountID The Account ID *** @param entityID The Entity ID *** @param etype The Entity type *** @return The Entity Description **/ public static String getEntityDescription(String accountID, String entityID, EntityManager.EntityType etype) { EntityManager.EntityType et = EntityManager.getEntityType(etype); return Device.getEntityDescription(accountID, entityID, et.getIntValue()); } /** *** Gets the Description for the specified Entity ID *** @param accountID The Account ID *** @param entityID The Entity ID *** @param etype The Entity type *** @return The Entity Description **/ public static String getEntityDescription(String accountID, String entityID, int etype) { String eid = StringTools.trim(entityID); if (!eid.equals("") && Device.hasEntityManager()) { eid = Device.getEntityManager().getEntityDescription(accountID, eid, etype); } return eid; } // -------------------------------- /** *** Returns true if the specified Entity is attached to the specified Device ID *** @param accountID The Account ID *** @param deviceID The Device ID *** @param entityID The Entity ID *** @param etype The Entity type *** @return True if the Entity is attached to the device **/ public static boolean isEntityAttached(String accountID, String deviceID, String entityID, EntityManager.EntityType etype) { EntityManager.EntityType et = EntityManager.getEntityType(etype); return Device.isEntityAttached(accountID, deviceID, entityID, et.getIntValue()); } /** *** Returns true if the specified Entity is attached to the specified Device ID *** @param accountID The Account ID *** @param deviceID The Device ID *** @param entityID The Entity ID *** @param etype The Entity type *** @return True if the Entity is attached to the device **/ public static boolean isEntityAttached(String accountID, String deviceID, String entityID, int etype) { String eid = StringTools.trim(entityID); if (!eid.equals("") && Device.hasEntityManager()) { return Device.getEntityManager().isEntityAttached(accountID, deviceID, eid, etype); } else { return false; } } // ------------------------------------------------------------------------ // (Vehicle) Fuel manager private static FuelManager fuelManager = null; /** *** Sets the FuelManager *** @param fm The FuelManager **/ public static void setFuelManager(FuelManager fm) { if (fm != null) { Device.fuelManager = fm; //Print.logDebug("Device FuelManager installed: " + StringTools.className(Device.fuelManager)); } else if (Device.fuelManager != null) { Device.fuelManager = null; //Print.logDebug("Device FuelManager removed."); } } /** *** Returns true if a FuelManager has been defined *** @return True if a FuelManager has been defined **/ public static boolean hasFuelManager() { return (Device.fuelManager != null); } /** *** Gets the FuelManager *** @return The FuelManager **/ public static FuelManager getFuelManager() { return Device.fuelManager; } // ------------------------------------------------------------------------ // (Vehicle) "Ping" dispatcher private static PingDispatcher pingDispatcher = null; /** *** Sets the PingDispatcher *** @param pd The PingDispatcher **/ public static void setPingDispatcher(PingDispatcher pd) { if (pd != null) { Device.pingDispatcher = pd; Print.logDebug("Device PingDispatcher installed: " + StringTools.className(Device.pingDispatcher)); } else if (Device.pingDispatcher != null) { Device.pingDispatcher = null; Print.logDebug("Device PingDispatcher removed."); } } /** *** Returns true if a PingDispatcher has been defined *** @return True if a PingDispatcher has been defined **/ public static boolean hasPingDispatcher() { return (Device.pingDispatcher != null); } /** *** Gets the PingDispatcher *** @return The PingDispatcher **/ public static PingDispatcher getPingDispatcher() { return Device.pingDispatcher; } // ------------------------------------------------------------------------ // Past EventDate timestamp check public static final int PAST_DATE_UNDEFINED = -999; public static final int PAST_DATE_IGNORE = -1; public static final int PAST_DATE_DISABLED = 0; public static final int PAST_DATE_TRUNCATE = 1; private static int PastEventDateAction = PAST_DATE_UNDEFINED; /** *** Gets the action to perform when a past event date is detected *** @return The action to perform when a past event date is detected **/ public static int pastEventDateAction() { if (PastEventDateAction == PAST_DATE_UNDEFINED) { // TODO: synchronize? // "Device.pastDate.action=" String act = RTConfig.getString(DBConfig.PROP_Device_pastDate_action,""); if (act.equalsIgnoreCase("ignore") || act.equalsIgnoreCase("skip") || act.equalsIgnoreCase("-1") ) { PastEventDateAction = PAST_DATE_IGNORE; } else if (act.equalsIgnoreCase("truncate") || act.equalsIgnoreCase("1") ) { PastEventDateAction = PAST_DATE_TRUNCATE; } else if (StringTools.isBlank(act) || act.equalsIgnoreCase("disabled") || act.equalsIgnoreCase("disable") || act.equalsIgnoreCase("0") ) { PastEventDateAction = PAST_DATE_DISABLED; } else { Print.logError("Invalid property value %s => %s", DBConfig.PROP_Device_pastDate_action, act); PastEventDateAction = PAST_DATE_DISABLED; } } return PastEventDateAction; } private static long PastEventDateMaxSec = -999L; /** *** Gets the maximum number of seconds an event is allowed to be into the past *** @return The maximum number of seconds into the past **/ public static long pastEventDateMaximumSec() { if (PastEventDateMaxSec == -999L) { // TODO: synchronize? String M = RTConfig.getString(DBConfig.PROP_Device_pastDate_maximumSec,""); if (!StringTools.isBlank(M)) { long S = StringTools.parseLong(M,0L); if (StringTools.endsWithIgnoreCase(M,"d")) { S = DateTime.DaySeconds(S); } PastEventDateMaxSec = Math.abs(S); } else { PastEventDateMaxSec = 0L; } } return PastEventDateMaxSec; } // ------------------------------------------------------------------------ // Future EventDate timestamp check public static final int FUTURE_DATE_UNDEFINED = -999; public static final int FUTURE_DATE_IGNORE = -1; public static final int FUTURE_DATE_DISABLED = 0; public static final int FUTURE_DATE_TRUNCATE = 1; private static int FutureEventDateAction = FUTURE_DATE_UNDEFINED; /** *** Gets the action to perform when a future event date is detected *** @return The action to perform when a future event date is detected **/ public static int futureEventDateAction() { if (FutureEventDateAction == FUTURE_DATE_UNDEFINED) { // TODO: synchronize? // "Device.futureDate.action=" String act = RTConfig.getString(DBConfig.PROP_Device_futureDate_action,""); if (act.equalsIgnoreCase("ignore") || act.equalsIgnoreCase("skip") || act.equalsIgnoreCase("-1") ) { FutureEventDateAction = FUTURE_DATE_IGNORE; } else if (act.equalsIgnoreCase("truncate") || act.equalsIgnoreCase("1") ) { FutureEventDateAction = FUTURE_DATE_TRUNCATE; } else if (StringTools.isBlank(act) || act.equalsIgnoreCase("disabled") || act.equalsIgnoreCase("disable") || act.equalsIgnoreCase("0") ) { FutureEventDateAction = FUTURE_DATE_DISABLED; } else { Print.logError("Invalid property value %s => %s", DBConfig.PROP_Device_futureDate_action, act); FutureEventDateAction = FUTURE_DATE_DISABLED; } } return FutureEventDateAction; } private static long FutureEventDateMaxSec = -999L; /** *** Gets the maximum number of seconds an event is allowed to be into the future *** @return The maximum number of seconds into the future **/ public static long futureEventDateMaximumSec() { if (FutureEventDateMaxSec == -999L) { // TODO: synchronize? String M = RTConfig.getString(DBConfig.PROP_Device_futureDate_maximumSec,""); if (!StringTools.isBlank(M)) { long S = StringTools.parseLong(M,0L); if (StringTools.endsWithIgnoreCase(M,"d")) { S = DateTime.DaySeconds(S); } FutureEventDateMaxSec = Math.abs(S); } else { FutureEventDateMaxSec = 0L; } } return FutureEventDateMaxSec; } // ------------------------------------------------------------------------ // Invalid speed check public static final int INVALID_SPEED_UNDEFINED = -999; public static final int INVALID_SPEED_IGNORE = -1; public static final int INVALID_SPEED_DISABLED = 0; public static final int INVALID_SPEED_TRUNCATE = 1; public static final int INVALID_SPEED_ZERO = 2; private static int InvalidSpeedAction = INVALID_SPEED_UNDEFINED; public static int invalidSpeedAction() { // TODO: synchronize? if (InvalidSpeedAction == INVALID_SPEED_UNDEFINED) { // "Device.invalidSpeed.action=" String act = RTConfig.getString(DBConfig.PROP_Device_invalidSpeed_action,""); if (act.equalsIgnoreCase("ignore") || act.equalsIgnoreCase("skip") || act.equalsIgnoreCase("-1") ) { // events with invalid speed will be ignored InvalidSpeedAction = INVALID_SPEED_IGNORE; } else if (act.equalsIgnoreCase("truncate") || act.equalsIgnoreCase("1") ) { // event speeds exceeding the max allowed speed will be set to the max allowed speed InvalidSpeedAction = INVALID_SPEED_TRUNCATE; } else if (act.equalsIgnoreCase("zero") || act.equalsIgnoreCase("setzero") || act.equalsIgnoreCase("2") ) { // event speeds exceeding the max allowed speed will be set to zero speed InvalidSpeedAction = INVALID_SPEED_ZERO; } else if (StringTools.isBlank(act) || act.equalsIgnoreCase("disabled") || act.equalsIgnoreCase("disable") || act.equalsIgnoreCase("0") ) { // maximum allowed speed will not be checked InvalidSpeedAction = INVALID_SPEED_DISABLED; } else { Print.logError("Invalid property value %s => %s", DBConfig.PROP_Device_invalidSpeed_action, act); InvalidSpeedAction = INVALID_SPEED_DISABLED; } } return InvalidSpeedAction; } private static double InvalidSpeedMaxKPH = -999.0; public static double invalidSpeedMaximumKPH() { // TODO: synchronize? if (InvalidSpeedMaxKPH <= -999.0) { String spdMaxProp = DBConfig.PROP_Device_invalidSpeed_maximumKPH; InvalidSpeedMaxKPH = RTConfig.getDouble(spdMaxProp, 0.0); if (InvalidSpeedMaxKPH <= 0.0) { // essentially "disabled" InvalidSpeedMaxKPH = 0.0; } else if (InvalidSpeedMaxKPH <= 100.0) { // a low maximum speed warning Print.logWarn("**** \""+spdMaxProp+"\" set to " + InvalidSpeedMaxKPH + " km/h ****"); } } return InvalidSpeedMaxKPH; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /* keyed FLD_simPhoneNumber? */ private static String _simPhoneNumber_attr() { // FLD_simPhoneNumber String commonAttr = "edit=2"; if (RTConfig.getBoolean(DBConfig.PROP_Device_keyedSimPhoneNumber,false)) { return commonAttr + " altkey=simphone"; } else { return commonAttr; } } /* keyed FLD_lastNotifyTime? */ private static String _lastNotifyTime_attr() { // FLD_lastNotifyTime String commonAttr = "format=time"; if (RTConfig.getBoolean(DBConfig.PROP_Device_keyedLastNotifyTime,false)) { return commonAttr + " altkey=notifyTime"; } else { return commonAttr; } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // SQL table definition below // Note: The following fields should be updated upon each connection from the client device: // - FLD_lastInputState // - FLD_ipAddressCurrent // - FLD_remotePortCurrent // - FLD_lastTotalConnectTime // - FLD_lastDuplexConnectTime (OpenDMTP clients, otherwise optional) // - FLD_totalProfileMask (OpenDMTP clients) // - FLD_duplexProfileMask (OpenDMTP clients) // - etc ... (see "DefaultUpdatedFieldsList") /* table name */ public static final String _TABLE_NAME = "Device"; // "Asset" public static String TABLE_NAME() { return DBProvider._translateTableName(_TABLE_NAME); } /* field definition */ // Device/Asset specific information: public static final String FLD_groupID = "groupID"; // vehicle group (user informational only) public static final String FLD_equipmentType = "equipmentType"; // equipment/vehicle type public static final String FLD_vehicleMake = "vehicleMake"; // vehicle make (ie "Toyota") public static final String FLD_vehicleModel = "vehicleModel"; // vehicle model (ie. "L150F") public static final String FLD_vehicleID = "vehicleID"; // vehicle id number (ie VIN) public static final String FLD_licensePlate = "licensePlate"; // licensePlate / registration id public static final String FLD_driverID = "driverID"; // driver id public static final String FLD_driverStatus = "driverStatus"; // driver status public static final String FLD_fuelCapacity = "fuelCapacity"; // fuel capacity liters public static final String FLD_fuelEconomy = "fuelEconomy"; // approximate fuel economy km/L public static final String FLD_speedLimitKPH = "speedLimitKPH"; // Maximum speed km/h public static final String FLD_planDistanceKM = "planDistanceKM"; // Planned trip distance traveled public static final String FLD_installTime = "installTime"; // install time (date/time when device was installed) public static final String FLD_resetTime = "resetTime"; // reset time (date/time when device was reset - typically odometer, fuel, etc) public static final String FLD_expirationTime = "expirationTime"; // expiration time // DataTransport specific attributes (see also Transport.java) // (These fields contain the default DataTransport attributes) public static final String FLD_uniqueID = "uniqueID"; // unique device ID public static final String FLD_deviceCode = "deviceCode"; // DCServerConfig ID ("serverID") public static final String FLD_deviceType = "deviceType"; // reserved public static final String FLD_pushpinID = "pushpinID"; // map pushpin ID public static final String FLD_displayColor = "displayColor"; // display color (maps, reports, etc). public static final String FLD_serialNumber = "serialNumber"; // device hardware serial#. public static final String FLD_simPhoneNumber = "simPhoneNumber"; // SIM phone number public static final String FLD_simID = "simID"; // SIM ID public static final String FLD_smsEmail = "smsEmail"; // SMS email address (to the device itself) //public static final String FLD_smsGatewayProps = "smsGatewayProps"; // SMS gateway properties public static final String FLD_imeiNumber = "imeiNumber"; // IMEI number (or moblie ID) public static final String FLD_dataKey = "dataKey"; // Data key (IE. Device PIN number) public static final String FLD_ignitionIndex = "ignitionIndex"; // hardware ignition I/O index public static final String FLD_codeVersion = "codeVersion"; // code version installed on device public static final String FLD_featureSet = "featureSet"; // device features public static final String FLD_ipAddressValid = "ipAddressValid"; // valid IP address block // Last Device IP Address:Port public static final String FLD_lastTcpSessionID = "lastTcpSessionID"; // last TCP session ID public static final String FLD_ipAddressCurrent = "ipAddressCurrent"; // current(last) IP address public static final String FLD_remotePortCurrent = "remotePortCurrent"; // current(last) remote port public static final String FLD_listenPortCurrent = "listenPortCurrent"; // current(last) local/listen port // Ping/Command public static final String FLD_pingCommandURI = "pingCommandURI"; // ping command URL public static final String FLD_pendingPingCommand = "pendingPingCommand"; // pending ping command (should just be 'pendingCommand') public static final String FLD_lastPingTime = "lastPingTime"; // last ping time public static final String FLD_totalPingCount = "totalPingCount"; // total ping count public static final String FLD_maxPingCount = "maxPingCount"; // maximum allowed ping count public static final String FLD_commandStateMask = "commandStateMask"; // command state mask (set by command sent) public static final String FLD_expectAck = "expectAck"; // expecting a returned ACK public static final String FLD_expectAckCode = "expectAckCode"; // expected ACK status code public static final String FLD_lastAckCommand = "lastAckCommand"; // last command expecting an ACK public static final String FLD_lastAckResponse = "lastAckResponse"; // last command response public static final String FLD_lastAckTime = "lastAckTime"; // last received ACK time // Device Communication Server Configuration public static final String FLD_dcsPropertiesID = "dcsPropertiesID"; // DCS property group name public static final String FLD_dcsCommandHost = "dcsCommandHost"; // DCS Command host name public static final String FLD_dcsConfigMask = "dcsConfigMask"; // DCS Config Mask public static final String FLD_dcsConfigString = "dcsConfigString"; // DCS Config String // DMTP public static final String FLD_supportsDMTP = "supportsDMTP"; // DMTP public static final String FLD_supportedEncodings = "supportedEncodings"; // DMTP public static final String FLD_unitLimitInterval = "unitLimitInterval"; // DMTP public static final String FLD_maxAllowedEvents = "maxAllowedEvents"; // DMTP public static final String FLD_totalProfileMask = "totalProfileMask"; // DMTP public static final String FLD_totalMaxConn = "totalMaxConn"; // DMTP public static final String FLD_totalMaxConnPerMin = "totalMaxConnPerMin"; // DMTP public static final String FLD_duplexProfileMask = "duplexProfileMask"; // DMTP public static final String FLD_duplexMaxConn = "duplexMaxConn"; // DMTP public static final String FLD_duplexMaxConnPerMin = "duplexMaxConnPerMin"; // DMTP // Last Event values public static final String FLD_lastTotalConnectTime = "lastTotalConnectTime"; // last connect time public static final String FLD_lastDuplexConnectTime = "lastDuplexConnectTime"; // last TCP connect time public static final String FLD_lastInputState = "lastInputState"; // last known digital input state (GPIO/inputMask) public static final String FLD_lastOutputState = "lastOutputState"; // last known digital output state (GPIO/outputMask) public static final String FLD_statusCodeState = "statusCodeState"; // selected statusCode on/off states public static final String FLD_lastBatteryLevel = "lastBatteryLevel"; // last known battery level (%) public static final String FLD_lastFuelLevel = "lastFuelLevel"; // last fuelLevel value public static final String FLD_lastFuelTotal = "lastFuelTotal"; // last fuelTotal value public static final String FLD_lastOilLevel = "lastOilLevel"; // last oilLevel value public static final String FLD_lastValidLatitude = "lastValidLatitude"; // last known valid latitude public static final String FLD_lastValidLongitude = "lastValidLongitude"; // last known valid longitude public static final String FLD_lastValidHeading = "lastValidHeading"; // last known valid heading public static final String FLD_lastGPSTimestamp = "lastGPSTimestamp"; // timestamp of last valid GPS Location public static final String FLD_lastEventTimestamp = "lastEventTimestamp"; // timestamp of last event public static final String FLD_lastCellServingInfo = "lastCellServingInfo"; // last Serving CellTower info public static final String FLD_lastDistanceKM = "lastDistanceKM"; // last distance value (may be simulated) public static final String FLD_lastOdometerKM = "lastOdometerKM"; // last odometer value (may be simulated) public static final String FLD_odometerOffsetKM = "odometerOffsetKM"; // offset to reported odometer public static final String FLD_lastEngineOnTime = "lastEngineOnTime"; // last engine-on time (may be '0' if engine is off) public static final String FLD_lastEngineOffTime = "lastEngineOffTime"; // last engine-off time (may be '0' if engine is on) public static final String FLD_lastEngineHours = "lastEngineHours"; // last engine-hours value (may be simulated) public static final String FLD_engineHoursOffset = "engineHoursOffset"; // offset to reported engine hours public static final String FLD_lastIgnitionOnTime = "lastIgnitionOnTime"; // last ignition-on time (may be '0' if ignition is off) public static final String FLD_lastIgnitionOffTime = "lastIgnitionOffTime"; // last ignition-off time (may be '0' if ignition is on) public static final String FLD_lastIgnitionHours = "lastIgnitionHours"; // last ignition hours at time of last ignition-on public static final String FLD_lastStopTime = "lastStopTime"; // last Stop time ('0' if not stopped) public static final String FLD_lastStartTime = "lastStartTime"; // last Start time ('0' if stopped) public static final String FLD_lastMalfunctionLamp = "lastMalfunctionLamp"; // last MIL state public static final String FLD_lastFaultCode = "lastFaultCode"; // last fault code properties // private static DBField FieldInfo[] = { // Asset/Vehicle specific fields newField_accountID(true), newField_deviceID(true), new DBField(FLD_groupID , String.class , DBField.TYPE_GROUP_ID() , I18N.getString(Device.class,"Device.fld.groupID" , "Group ID" ), "edit=2"), new DBField(FLD_equipmentType , String.class , DBField.TYPE_STRING(40) , I18N.getString(Device.class,"Device.fld.equipmentType" , "Equipment Type" ), "edit=2"), new DBField(FLD_vehicleMake , String.class , DBField.TYPE_STRING(40) , I18N.getString(Device.class,"Device.fld.vehicleMake" , "Vehicle Make" ), "edit=2"), new DBField(FLD_vehicleModel , String.class , DBField.TYPE_STRING(40) , I18N.getString(Device.class,"Device.fld.vehicleModel" , "Vehicle Model" ), "edit=2"), new DBField(FLD_vehicleID , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.vehicleID" , "VIN" ), "edit=2"), new DBField(FLD_licensePlate , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.licensePlate" , "License Plate" ), "edit=2"), new DBField(FLD_driverID , String.class , DBField.TYPE_DRIVER_ID() , I18N.getString(Device.class,"Device.fld.driverID" , "Driver ID" ), "edit=2"), new DBField(FLD_driverStatus , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.driverStatus" , "Driver Status" ), "edit=2"), new DBField(FLD_fuelCapacity , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.fuelCapacity" , "Fuel Capacity" ), "edit=2 format=#0.0"), new DBField(FLD_fuelEconomy , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.fuelEconomy" , "Approx. Fuel Economy" ), "edit=2 format=#0.0"), new DBField(FLD_speedLimitKPH , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.speedLimitKPH" , "Max Speed km/h" ), "edit=2 format=#0.0"), new DBField(FLD_planDistanceKM , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.planDistance" , "Planned Trip Distance" ), "edit=2 format=#0.0"), new DBField(FLD_installTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.installTime" , "Install Time" ), "edit=2 format=time"), new DBField(FLD_resetTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.resetTime" , "Reset Time" ), "edit=2 format=time"), new DBField(FLD_expirationTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.expirationTime" , "Expiration Time" ), "edit=2 format=time"), // DataTransport fields (These fields contain the default DataTransport attributes) new DBField(FLD_uniqueID , String.class , DBField.TYPE_UNIQ_ID() , I18N.getString(Device.class,"Device.fld.uniqueID" , "Unique ID" ), "edit=2 altkey=true presep"), new DBField(FLD_deviceCode , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.deviceCode" , "Server ID" ), "edit=2"), new DBField(FLD_deviceType , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.deviceType" , "Device Type" ), "edit=2"), new DBField(FLD_pushpinID , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.pushpinID" , "Pushpin ID" ), "edit=2"), new DBField(FLD_displayColor , String.class , DBField.TYPE_STRING(16) , I18N.getString(Device.class,"Device.fld.displayColor" , "Display Color" ), "edit=2"), new DBField(FLD_serialNumber , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.serialNumber" , "Serial Number" ), "edit=2"), new DBField(FLD_simPhoneNumber , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.simPhoneNumber" , "SIM Phone Number" ), Device._simPhoneNumber_attr()), new DBField(FLD_simID , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.simID" , "SIM ID" ), "edit=2"), new DBField(FLD_smsEmail , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.smsEmail" , "SMS EMail Address" ), "edit=2"), new DBField(FLD_imeiNumber , String.class , DBField.TYPE_STRING(24) , I18N.getString(Device.class,"Device.fld.imeiNumber" , "IMEI Number" ), "edit=2"), new DBField(FLD_dataKey , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.dataKey" , "Data Key" ), "edit=2"), new DBField(FLD_ignitionIndex , Integer.TYPE , DBField.TYPE_INT16 , I18N.getString(Device.class,"Device.fld.ignitionIndex" , "Ignition I/O Index" ), "edit=2"), new DBField(FLD_codeVersion , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.codeVersion" , "Code Version" ), ""), new DBField(FLD_featureSet , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.featureSet" , "Feature Set" ), ""), new DBField(FLD_ipAddressValid , DTIPAddrList.class , DBField.TYPE_STRING(128) , I18N.getString(Device.class,"Device.fld.ipAddressValid" , "Valid IP Addresses" ), "edit=2"), new DBField(FLD_lastTotalConnectTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastTotalConnectTime" , "Last Total Connect Time" ), "format=time"), new DBField(FLD_lastDuplexConnectTime, Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastDuplexConnectTime", "Last Duplex Connect Time" ), "format=time"), // Ping/Command //new DBField(FLD_pingCommandURI , String.class , DBField.TYPE_STRING(128) , I18N.getString(Device.class,"Device.fld.pingCommandURI" , "Ping Command URL" , "edit=2"), new DBField(FLD_pendingPingCommand , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.pendingPingCommand" , "Pending Ping Command" ), "edit=2"), new DBField(FLD_lastPingTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastPingTime" , "Last 'Ping' Time" ), "format=time"), new DBField(FLD_totalPingCount , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.totalPingCount" , "Total 'Ping' Count" ), ""), new DBField(FLD_maxPingCount , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.maxPingCount" , "Maximum 'Ping' Count" ), "edit=2"), new DBField(FLD_commandStateMask , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.commandStateMask" , "Command State Mask" ), "edit=2"), new DBField(FLD_expectAck , Boolean.TYPE , DBField.TYPE_BOOLEAN , I18N.getString(Device.class,"Device.fld.expectAck" , "Expecting an ACK" ), "edit=2"), new DBField(FLD_expectAckCode , Integer.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.expectAckStatusCode" , "Expected ACK Status Code" ), "edit=2"), new DBField(FLD_lastAckCommand , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.lastAckCommand" , "Last Command Expecting ACK" ), ""), //new DBField(FLD_lastAckResponse , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.lastAckResponse" , "Last Command Response" ), ""), new DBField(FLD_lastAckTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastAckTime" , "Last Received 'ACK' Time" ), "format=time"), // Device Communication Server Configuration new DBField(FLD_dcsPropertiesID , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.dcsPropertiesID" , "DCS Properties ID" ), "edit=2"), new DBField(FLD_dcsCommandHost , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.dcsCommandHost" , "DCS Command Host" ), "edit=2"), new DBField(FLD_dcsConfigMask , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.dcsConfigMask" , "DCS Configuration Mask" ), "edit=2"), //new DBField(FLD_dcsConfigString , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.dcsConfigString" , "DCS Configuration String" ), "edit=2"), // DMTP new DBField(FLD_supportsDMTP , Boolean.TYPE , DBField.TYPE_BOOLEAN , I18N.getString(Device.class,"Device.fld.supportsDMTP" , "Supports DMTP" ), "edit=2"), new DBField(FLD_supportedEncodings , Integer.TYPE , DBField.TYPE_UINT8 , I18N.getString(Device.class,"Device.fld.supportedEncodings" , "Supported Encodings" ), "edit=2 format=X1 editor=encodings mask=Transport$Encodings"), new DBField(FLD_unitLimitInterval , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.unitLimitInterval" , "Accounting Time Interval Min"), "edit=2"), new DBField(FLD_maxAllowedEvents , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.maxAllowedEvents" , "Max Events per Interval" ), "edit=2"), new DBField(FLD_totalProfileMask , DTProfileMask.class , DBField.TYPE_BLOB , I18N.getString(Device.class,"Device.fld.totalProfileMask" , "Total Profile Mask" ), ""), new DBField(FLD_totalMaxConn , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.totalMaxConn" , "Max Total Conn per Interval" ), "edit=2"), new DBField(FLD_totalMaxConnPerMin , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.totalMaxConnPerMin" , "Max Total Conn per Minute" ), "edit=2"), new DBField(FLD_duplexProfileMask , DTProfileMask.class , DBField.TYPE_BLOB , I18N.getString(Device.class,"Device.fld.duplexProfileMask" , "Duplex Profile Mask" ), ""), new DBField(FLD_duplexMaxConn , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.duplexMaxConn" , "Max Duplex Conn per Interval"), "edit=2"), new DBField(FLD_duplexMaxConnPerMin , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.duplexMaxConnPerMin" , "Max Duplex Conn per Minute" ), "edit=2"), // Last Event new DBField(FLD_lastTcpSessionID , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.tcpSessionID" , "Last TCP Session ID" ), ""), new DBField(FLD_ipAddressCurrent , DTIPAddress.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.ipAddressCurrent" , "Current IP Address" ), ""), new DBField(FLD_remotePortCurrent , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.remotePortCurrent" , "Current Remote Port" ), ""), new DBField(FLD_listenPortCurrent , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.listenPortCurrent" , "Current Listen Port" ), ""), new DBField(FLD_lastInputState , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastInputState" , "Last Input State" ), ""), new DBField(FLD_lastOutputState , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastOutputState" , "Last Output State" ), ""), new DBField(FLD_statusCodeState , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.statusCodeState" , "StatusCode On/Off State" ), ""), new DBField(FLD_lastBatteryLevel , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastBatteryLevel" , "Last Battery Level" ), "format=#0.0 units=percent"), new DBField(FLD_lastFuelLevel , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastFuelLevel" , "Last Fuel Level" ), "format=#0.0 units=percent"), new DBField(FLD_lastFuelTotal , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastFuelTotal" , "Last Fuel Total Liters" ), "format=#0.0 units=volume"), new DBField(FLD_lastOilLevel , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastOilLevel" , "Last Oil Level" ), "format=#0.0"), new DBField(FLD_lastValidLatitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastValidLatitude" , "Last Valid Latitude" ), "format=#0.00000"), new DBField(FLD_lastValidLongitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastValidLongitude" , "Last Valid Longitude" ), "format=#0.00000"), new DBField(FLD_lastValidHeading , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastValidHeading" , "Last Valid Heading" ), "format=#0.00000"), new DBField(FLD_lastGPSTimestamp , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastGPSTimestamp" , "Last Valid GPS Timestamp" ), "format=time"), new DBField(FLD_lastEventTimestamp , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastEventTimestamp" , "Last Event Timestamp" ), "format=time"), new DBField(FLD_lastCellServingInfo , String.class , DBField.TYPE_STRING(100) , I18N.getString(Device.class,"Device.fld.lastCellServingInfo" , "Last Serving Cell Info" ), ""), new DBField(FLD_lastDistanceKM , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastDistanceKM" , "Last Distance km" ), "format=#0.0 units=distance"), new DBField(FLD_lastOdometerKM , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastOdometerKM" , "Last Odometer km" ), "format=#0.0 units=distance"), new DBField(FLD_odometerOffsetKM , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.odometerOffsetKM" , "Odometer Offset km" ), "format=#0.0 units=distance"), new DBField(FLD_lastEngineOnTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastEngineOnTime" , "Last Engine On Time" ), "format=time"), new DBField(FLD_lastEngineOffTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastEngineOffTime" , "Last Engine Off Time" ), "format=time"), new DBField(FLD_lastEngineHours , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastEngineHours" , "Last Engine Hours" ), "format=#0.0"), new DBField(FLD_engineHoursOffset , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.ngineHoursOffset" , "Engine Hours Offset" ), "format=#0.0"), new DBField(FLD_lastIgnitionOnTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastIgnitionOnTime" , "Last Ignition On Time" ), "format=time"), new DBField(FLD_lastIgnitionOffTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastIgnitionOffTime" , "Last Ignition Off Time" ), "format=time"), new DBField(FLD_lastIgnitionHours , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastIgnitionHours" , "Last Ignition Hours" ), "format=#0.0"), new DBField(FLD_lastStopTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastStopTime" , "Last Stop Time" ), "format=time"), new DBField(FLD_lastStartTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastStartTime" , "Last Start Time" ), "format=time"), new DBField(FLD_lastMalfunctionLamp , Boolean.TYPE , DBField.TYPE_BOOLEAN , I18N.getString(Device.class,"Device.fld.lastMalfunctionLamp" , "Last MIL" ), "edit=2"), new DBField(FLD_lastFaultCode , String.class , DBField.TYPE_STRING(96) , I18N.getString(Device.class,"Device.fld.lastFaultCode" , "Last Fault Code" ), ""), // Common fields newField_isActive(), newField_displayName(), newField_description(), newField_notes(), newField_lastUpdateTime(), newField_lastUpdateUser(true), newField_creationTime(), }; // Default Notification (RulesEngine support) // startupInit.Device.NotificationFieldInfo=true public static final String FLD_allowNotify = "allowNotify"; // allow notification public static final String FLD_lastNotifyTime = "lastNotifyTime"; // last notification time public static final String FLD_lastNotifyCode = "lastNotifyCode"; // last notification status code public static final String FLD_lastNotifyRule = "lastNotifyRule"; // last notification rule id public static final String FLD_notifyEmail = "notifyEmail"; // notification email address public static final String FLD_notifySelector = "notifySelector"; // notification rule public static final String FLD_notifyAction = "notifyAction"; // notification action public static final String FLD_notifyDescription = "notifyDescription"; // notification description public static final String FLD_notifySubject = "notifySubject"; // notification subject public static final String FLD_notifyText = "notifyText"; // notification message public static final String FLD_notifyUseWrapper = "notifyUseWrapper"; // notification email wrapper public static final String FLD_notifyPriority = "notifyPriority"; // notification priority public static final String FLD_parkedLatitude = "parkedLatitude"; // parked latitude public static final String FLD_parkedLongitude = "parkedLongitude"; // parked longitude public static final String FLD_parkedRadius = "parkedRadius"; // parked radius meters public static final String FLD_assignedUserID = "assignedUserID"; // assigned/preferred user-id public static final String FLD_thermalProfile = "thermalProfile"; // temperature profile public static final String FLD_hoursOfOperation = "hoursOfOperation"; // hours of operation (RTP) //public static final String FLD_rentalStartDate = "rentalStartDate"; // rental start date //public static final String FLD_rentalEndDate = "rentalEndDate"; // rental end date //public static final String FLD_rentalAllowedKM = "rentalAllowedKM"; // rental allowed kilometers public static final String FLD_lastEventsPerSecond = "lastEventsPerSecond"; // estimated events per second public static final String FLD_lastEventsPerSecondMS = "lastEventsPerSecondMS"; // system time of last events per second calculation public static final DBField NotificationFieldInfo[] = { new DBField(FLD_allowNotify , Boolean.TYPE , DBField.TYPE_BOOLEAN , I18N.getString(Device.class,"Device.fld.allowNotify" , "Allow Notification" ), "edit=2"), new DBField(FLD_lastNotifyTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastNotifyTime" , "Last Notify Time" ), _lastNotifyTime_attr()), new DBField(FLD_lastNotifyCode , Integer.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastNotifyCode" , "Last Notify Status Code" ), "format=X2"), new DBField(FLD_lastNotifyRule , String.class , DBField.TYPE_RULE_ID() , I18N.getString(Device.class,"Device.fld.lastNotifyRule" , "Last Notify Rule ID" ), ""), new DBField(FLD_notifyEmail , String.class , DBField.TYPE_EMAIL_LIST(), I18N.getString(Device.class,"Device.fld.notifyEmail" , "Notification EMail Address" ), "edit=2"), new DBField(FLD_notifySelector , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.notifySelector" , "Notification Selector" ), "edit=2 editor=ruleSelector"), new DBField(FLD_notifyAction , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.notifyAction" , "Notification Action" ), "edit=2 format=X2 editor=ruleAction mask=RuleFactory$NotifyAction"), new DBField(FLD_notifyDescription , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.notifyDescription" , "Notification Description" ), "edit=2 utf8=true"), new DBField(FLD_notifySubject , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.notifySubject" , "Notification Subject" ), "edit=2 utf8=true"), new DBField(FLD_notifyText , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.notifyText" , "Notification Message" ), "edit=2 editor=textArea utf8=true"), new DBField(FLD_notifyUseWrapper , Boolean.TYPE , DBField.TYPE_BOOLEAN , I18N.getString(Device.class,"Device.fld.notifyUseWrapper" , "Notification Use Wrapper" ), "edit=2"), new DBField(FLD_notifyPriority , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.notifyPriority" , "Notification Priority" ), "edit=2"), new DBField(FLD_parkedLatitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.parkedLatitude" , "Parked Latitude" ), "format=#0.00000 edit=2"), new DBField(FLD_parkedLongitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.parkedLongitude" , "Parked Longitude" ), "format=#0.00000 edit=2"), new DBField(FLD_parkedRadius , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.parkedRadius" , "Parked Radius" ), "format=#0.0 edit=2"), new DBField(FLD_assignedUserID , String.class , DBField.TYPE_USER_ID() , I18N.getString(Device.class,"Device.fld.assignedUserID" , "Assigned User" ), "edit=2"), new DBField(FLD_thermalProfile , String.class , DBField.TYPE_STRING(200) , I18N.getString(Device.class,"Device.fld.thermalProfile" , "Temperature Profile" ), "edit=2"), new DBField(FLD_hoursOfOperation , String.class , DBField.TYPE_STRING(200) , I18N.getString(Device.class,"Device.fld.hoursOfOperation" , "Hours Of Operation" ), "edit=2"), new DBField(FLD_lastEventsPerSecond , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.lastEventsPerSecond" , "Last Event per Second" ), "format=#0.00"), new DBField(FLD_lastEventsPerSecondMS, Long.TYPE , DBField.TYPE_INT64 , I18N.getString(Device.class,"Device.fld.lastEventsPerSecondMS", "Last Event/Second time MS" ), "format=time"), }; // Border Crossing // startupInit.Device.BorderCrossingFieldInfo=true public static final String FLD_borderCrossing = "borderCrossing"; // border crossing flags public static final String FLD_lastBorderCrossTime = "lastBorderCrossTime"; // timestamp of last border crossing calcs public static final DBField BorderCrossingFieldInfo[] = { new DBField(FLD_borderCrossing , Integer.TYPE , DBField.TYPE_UINT8 , I18N.getString(Device.class,"Device.fld.borderCrossing" , "Border Crossing Flags" ), "edit=2 enum=Device$BorderCrossingState"), new DBField(FLD_lastBorderCrossTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastBorderCrossTime" , "Last Border Crossing Time" ), "format=time"), }; // Device/Asset Link information // startupInit.Device.LinkFieldInfo=true public static final String FLD_linkURL = "linkURL"; // Link URL public static final String FLD_linkDescription = "linkDescription"; // Link Description public static final DBField LinkFieldInfo[] = { new DBField(FLD_linkURL , String.class , DBField.TYPE_STRING(128) , I18N.getString(Device.class,"Device.fld.linkURL" , "Link URL" ), "edit=2"), new DBField(FLD_linkDescription , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.linkDescription" , "Link Description" ), "edit=2"), }; // Fixed device location fields // startupInit.Device.FixedLocationFieldInfo=true public static final String FLD_fixedLatitude = "fixedLatitude"; // fixed latitude public static final String FLD_fixedLongitude = "fixedLongitude"; // fixed longitude public static final String FLD_fixedAddress = "fixedAddress"; // fixed address public static final String FLD_fixedContactPhone = "fixedContactPhone"; // fixed contact phone# public static final String FLD_fixedServiceTime = "fixedServiceTime"; // timestamp of last service public static final DBField FixedLocationFieldInfo[] = { new DBField(FLD_fixedLatitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.fixedLatitude" , "Fixed Latitude" ), "format=#0.00000 edit=2"), new DBField(FLD_fixedLongitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.fixedLongitude" , "Fixed Longitude" ), "format=#0.00000 edit=2"), new DBField(FLD_fixedAddress , String.class , DBField.TYPE_STRING(90) , I18N.getString(Device.class,"Device.fld.fixedAddress" , "Fixed Address (Physical)" ), "utf8=true"), new DBField(FLD_fixedContactPhone , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.fixedContactPhone" , "Fixed Contact Phone" ), "utf8=true"), new DBField(FLD_fixedServiceTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.fixedServiceTime" , "Last Service Time" ), "format=time edit=2"), }; // GeoCorridor fields // startupInit.Device.GeoCorridorFieldInfo=true public static final String FLD_activeCorridor = "activeCorridor"; // active GeoCorridor public static final DBField GeoCorridorFieldInfo[] = { new DBField(FLD_activeCorridor , String.class , DBField.TYPE_CORR_ID() , "Active GeoCorridor" , ""), }; // Maintenance odometer fields // startupInit.Device.MaintOdometerFieldInfo=true public static final String FLD_maintIntervalKM0 = "maintIntervalKM0"; // odometer maint #0 interval distance to next public static final String FLD_maintOdometerKM0 = "maintOdometerKM0"; // odometer maint #0 last Odometer public static final String FLD_maintIntervalKM1 = "maintIntervalKM1"; // odometer maint #1 interval distance to next public static final String FLD_maintOdometerKM1 = "maintOdometerKM1"; // odometer maint #1 last Odometer public static final String FLD_maintIntervalHR0 = "maintIntervalHR0"; // hours maint #0 interval hours to next public static final String FLD_maintEngHoursHR0 = "maintEngHoursHR0"; // hours maint #0 last EngineHours public static final String FLD_maintNotes = "maintNotes"; public static final String FLD_reminderType = "reminderType"; public static final String FLD_reminderMessage = "reminderMessage"; public static final String FLD_reminderInterval = "reminderInterval"; // String: public static final String FLD_reminderTime = "reminderTime"; // timestamp public static final String FLD_lastServiceTime = "lastServiceTime"; // timestamp (last reminder time) public static final String FLD_nextServiceTime = "nextServiceTime"; // timestamp public static final DBField MaintOdometerFieldInfo[] = { new DBField(FLD_maintIntervalKM0 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintIntervalKM0" , "#0 Maint Distance" ), "format=#0.0 edit=2"), new DBField(FLD_maintOdometerKM0 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintOdometerKM0" , "#0 Maint Last Odom" ), "format=#0.0"), new DBField(FLD_maintIntervalKM1 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintIntervalKM1" , "#1 Maint Distance " ), "format=#0.0 edit=2"), new DBField(FLD_maintOdometerKM1 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintOdometerKM1" , "#1 Maint Last Odom" ), "format=#0.0"), new DBField(FLD_maintIntervalHR0 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintIntervalHR0" , "#0 Maint ElapsedHours" ), "format=#0.0 edit=2"), new DBField(FLD_maintEngHoursHR0 , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.maintEngHoursHR0" , "#0 Maint Last EngineHours" ), "format=#0.0"), new DBField(FLD_maintNotes , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.maintNotes" , "Maint Notes" ), "edit=2 editor=textArea utf8=true"), //new DBField(FLD_reminderType , Integer.TYPE , DBField.TYPE_UINT16 , I18N.getString(Device.class,"Device.fld.reminderType" , "Reminder Type" ), "edit=2"), new DBField(FLD_reminderMessage , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.reminderMessage" , "Reminder Message" ), "edit=2 editor=textArea utf8=true"), new DBField(FLD_reminderInterval , String.class , DBField.TYPE_STRING(64) , I18N.getString(Device.class,"Device.fld.reminderInterval" , "Reminder Interval" ), "edit=2"), new DBField(FLD_reminderTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.reminderTime" , "Last Reminder Time" ), "format=time"), new DBField(FLD_lastServiceTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastServiceTime" , "Last Service Time" ), "format=time"), new DBField(FLD_nextServiceTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.nextServiceTime" , "Next Service Time" ), "format=time"), }; // Misc fields // startupInit.Device.WorkOrderInfo=true public static final String FLD_workOrderID = "workOrderID"; // WorkOrder ID public static final String FLD_jobNumber = "jobNumber"; // associated job number public static final String FLD_jobLatitude = "jobLatitude"; // job latitude public static final String FLD_jobLongitude = "jobLongitude"; // job longitude public static final String FLD_jobRadius = "jobRadius"; // job radius meters public static final String FLD_customAttributes = "customAttributes"; // custom attributes public static final DBField WorkOrderInfo[] = { new DBField(FLD_workOrderID , String.class , DBField.TYPE_STRING(512) , I18N.getString(Device.class,"Device.fld.workOrderID" , "Work Order ID" ), "edit=2"), new DBField(FLD_jobNumber , String.class , DBField.TYPE_STRING(32) , I18N.getString(Device.class,"Device.fld.jobNumber" , "Job Number" ), "edit=2"), new DBField(FLD_jobLatitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.jobLatitude" , "Job Latitude" ), "format=#0.00000 edit=2"), new DBField(FLD_jobLongitude , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.jobLongitude" , "Job Longitude" ), "format=#0.00000 edit=2"), new DBField(FLD_jobRadius , Double.TYPE , DBField.TYPE_DOUBLE , I18N.getString(Device.class,"Device.fld.jobRadius" , "Job Radius" ), "format=#0.0 edit=2"), new DBField(FLD_customAttributes , String.class , DBField.TYPE_TEXT , I18N.getString(Device.class,"Device.fld.customFields" , "Custom Fields" ), "edit=2"), }; // Data "Push" fields // startupInit.Device.DataPushInfo=true public static final String FLD_lastDataPushTime = "lastDataPushTime"; // timestamp of last data push public static final String FLD_lastEventCreateMillis = "lastEventCreateMillis"; // timestamp of last data push event creation time public static final DBField DataPushInfo[] = { new DBField(FLD_lastDataPushTime , Long.TYPE , DBField.TYPE_UINT32 , I18N.getString(Device.class,"Device.fld.lastDataPushTime" , "Last Data Push Time (sec)" ), "format=time"), new DBField(FLD_lastEventCreateMillis, Long.TYPE , DBField.TYPE_INT64 , I18N.getString(Device.class,"Device.fld.lastEventCreateMillis", "Last Event Create Time (MS)" ), "format=time"), }; /** *** Device record key **/ public static class Key extends DeviceKey { public Key() { super(); } public Key(String acctId, String devId) { super.setFieldValue(FLD_accountID, ((acctId != null)? acctId.toLowerCase() : "")); super.setFieldValue(FLD_deviceID , ((devId != null)? devId.toLowerCase() : "")); } public DBFactory getFactory() { return Device.getFactory(); } } /* factory constructor */ private static DBFactory factory = null; /** *** Gets the Device DBFactory *** @return The Device DBFactory **/ public static DBFactory getFactory() { if (factory == null) { EnumTools.registerEnumClass(NotifyAction.class); factory = DBFactory.createDBFactory( Device.TABLE_NAME(), Device.FieldInfo, DBFactory.KeyType.PRIMARY, Device.class, Device.Key.class, true/*editable*/, true/*viewable*/); factory.addParentTable(Account.TABLE_NAME()); factory.setLogMissingColumnWarnings(RTConfig.getBoolean(DBConfig.PROP_Device_logMissingColumns,true)); // FLD_lastFaultCode max length DBField lastFCFld = factory.getField(FLD_lastFaultCode); Device.LastFaultCodeColumnLength = (lastFCFld != null)? lastFCFld.getStringLength() : 0; } return factory; } /* Bean instance */ public Device() { super(); } /* database record */ public Device(Device.Key key) { super(key); } // ------------------------------------------------------------------------ /* table description */ public static String getTableDescription(Locale loc) { I18N i18n = I18N.getI18N(Device.class, loc); return i18n.getString("Device.description", "This table defines " + "Device/Vehicle specific information for an Account. " + "A 'Device' record typically represents something that is being 'tracked', such as a Vehicle." ); } // SQL table definition above // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // Bean access fields below // ------------------------------------------------------------------------ /** *** Gets the user informational Group ID
*** (user informational only, not used by DeviceGroup)
*** (currently used in various ReportLayout subclasses) *** @return The groupID used for user informational purposes only **/ public String getGroupID() { String v = (String)this.getFieldValue(FLD_groupID); return StringTools.trim(v); } /** *** Sets the user informational Group ID
*** (user informational only, not used by DeviceGroup)
*** (currently used in various ReportLayout subclasses) *** @param v The user informational group id **/ public void setGroupID(String v) { this.setFieldValue(FLD_groupID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the equipment type *** @return The equipment type **/ public String getEquipmentType() { String v = (String)this.getFieldValue(FLD_equipmentType); return StringTools.trim(v); } /** *** Sets the equipment type *** @param v The equipment type **/ public void setEquipmentType(String v) { this.setFieldValue(FLD_equipmentType, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the vehicle make *** @return The vehicle make **/ public String getVehicleMake() { String v = (String)this.getFieldValue(FLD_vehicleMake); return StringTools.trim(v); } /** *** Sets the vehicle make *** @param v The vehicle make **/ public void setVehicleMake(String v) { this.setFieldValue(FLD_vehicleMake, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the vehicle model *** @return The vehicle model **/ public String getVehicleModel() { String v = (String)this.getFieldValue(FLD_vehicleModel); return StringTools.trim(v); } /** *** Sets the vehicle model *** @param v The vehicle model **/ public void setVehicleModel(String v) { this.setFieldValue(FLD_vehicleModel, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the Vehicle Identification Number (VIN) *** @return The Vehicle ID (VIN) **/ public String getVehicleID() // VIN { String v = (String)this.getFieldValue(FLD_vehicleID); return StringTools.trim(v); } /** *** Sets the Vehicle Identification Number (VIN) *** @param v The Vehicle ID (VIN) **/ public void setVehicleID(String v) { this.setFieldValue(FLD_vehicleID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the Vehicle License Plate *** @return The License Plate **/ public String getLicensePlate() { String v = (String)this.getFieldValue(FLD_licensePlate); return StringTools.trim(v); } /** *** Sets the Vehicle License Plate *** @param v The License Plate **/ public void setLicensePlate(String v) { this.setFieldValue(FLD_licensePlate, StringTools.trim(v)); } // ------------------------------------------------------------------------ private Driver driver = null; /** *** Returns true if a driver-id is defined for this Device *** @return True if this Device record defines a DriverID **/ public boolean hasDriverID() { return !StringTools.isBlank(this.getDriverID()); } /** *** Returns true if the specified driver-id matches the current driver-id. *** If either the specified driver-id or current driver-id are blank, then returns false. *** @return True if the specified driver-id matches the current driver-id. **/ public boolean isDriverID(String drvID) { if (!StringTools.isBlank(drvID)) { // returns false if current driver-id is blank return this.getDriverID().equalsIgnoreCase(drvID); } else { // specified driver-id is blank return false; } } /** *** Gets the Driver-ID, or blank if not defined *** @return The Driver-ID **/ public String getDriverID() { String v = (String)this.getFieldValue(FLD_driverID); return StringTools.trim(v); } /** *** Sets the Driver-ID *** @param v The Driver-ID **/ public void setDriverID(String v) { this.setFieldValue(FLD_driverID, StringTools.trim(v)); this.addOtherChangedFieldNames(FLD_driverID); this.driver = null; } /** *** Gets the Driver record, or null if not defined *** @return The Driver record, or null if undefined **/ public Driver getDriver() { if (this.driver == null) { String driverID = this.getDriverID(); if (!StringTools.isBlank(driverID)) { try { this.driver = Driver.getDriver(this.getAccount(), driverID); } catch (DBException dbe) { this.driver = null; } } } return this.driver; } // ------------------------------------------------------------------------ /** *** Returns true if a driver-status is defined for this Device *** @return True if a driver-status is defined for this Device **/ public boolean hasDriverStatus() { return (this.getDriverStatus() > Driver.DutyStatus_UNKNOWN)? true : false; } /** *** Gets the driver status *** @return The driver status **/ public long getDriverStatus() { Long v = (Long)this.getFieldValue(FLD_driverStatus); return (v != null)? v.longValue() : Driver.DutyStatus_UNKNOWN; } /** *** Sets the driver status *** @param v The driver status **/ public void setDriverStatus(long v) { long ds = (v >= Driver.DutyStatus_UNKNOWN)? v : Driver.DutyStatus_UNKNOWN; this.setFieldValue(FLD_driverStatus, ds); this.addOtherChangedFieldNames(FLD_driverStatus); } // ------------------------------------------------------------------------ /** *** Gets the tank Fuel Capacity, in Liters *** @return The tank Fuel Capacity, in Liters **/ public double getFuelCapacity() { Double v = (Double)this.getFieldValue(FLD_fuelCapacity); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the tank Fuel Capacity, in Liters *** @param v The tank Fuel Capacity, in Liters **/ public void setFuelCapacity(double v) { this.setFieldValue(FLD_fuelCapacity, (v >= 0.0)? v : 0.0); } // ------------------------------------------------------------------------ /** *** Gets the approximate Fuel Economy, in Km/Liter *** @return The approximate Fuel Economy, in Km/Liter **/ public double getFuelEconomy() { Double v = (Double)this.getFieldValue(FLD_fuelEconomy); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the approximate Fuel Economy, in Km/Liter *** @param v The approximate Fuel Economy, in Km/Liter **/ public void setFuelEconomy(double v) { this.setFieldValue(FLD_fuelEconomy, (v >= 0.0)? v : 0.0); } // ------------------------------------------------------------------------ /** *** Gets the assigned speed limit for this device, in km/h *** @return The assigned speed limit for this device, in km/h **/ public double getSpeedLimitKPH() { Double v = (Double)this.getFieldValue(FLD_speedLimitKPH); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the assigned speed limit for this device, in km/h *** @param v The assigned speed limit for this device, in km/h **/ public void setSpeedLimitKPH(double v) { this.setFieldValue(FLD_speedLimitKPH, (v >= 0.0)? v : 0.0); } // ------------------------------------------------------------------------ /** *** Gets the assigned "Plan Distance" for this device, in kilometers *** @return The assigned "Plan Distance" for this device, in kilometers **/ public double getPlanDistanceKM() { Double v = (Double)this.getFieldValue(FLD_planDistanceKM); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the assigned "Plan Distance" for this device, in kilometers *** @param v The assigned "Plan Distance" for this device, in kilometers **/ public void setPlanDistanceKM(double v) { this.setFieldValue(FLD_planDistanceKM, (v >= 0.0)? v : 0.0); } // ------------------------------------------------------------------------ /** *** Gets the install time of this Device (in Unix Epoch time format) *** @return The install time of this Device, or '0' if undefined. **/ public long getInstallTime() { Long v = (Long)this.getFieldValue(FLD_installTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the install time of this Device (in Unix Epoch time format) *** @param v The install time of this Device, or '0' if undefined. **/ public void setInstallTime(long v) { this.setFieldValue(FLD_installTime, (v >= 0L)? v : 0L); } // ------------------------------------------------------------------------ /** *** Gets the reset time of this Device (in Unix Epoch time format) *** @return The reset time of this Device, or '0' if undefined. **/ public long getResetTime() { Long v = (Long)this.getFieldValue(FLD_resetTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the reset time of this Device (in Unix Epoch time format) *** @param v The reset time of this Device, or '0' if undefined. **/ public void setResetTime(long v) { this.setFieldValue(FLD_resetTime, (v >= 0L)? v : 0L); } // ------------------------------------------------------------------------ /** *** Gets the expiration time of this Device (in Unix Epoch time format) *** @return The expiration time of this Device, or '0' if this Device never expires. **/ public long getExpirationTime() { Long v = (Long)this.getFieldValue(FLD_expirationTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the expiration time of this Device (in Unix Epoch time format) *** @param v The expiration time of this Device, or '0' if this Device never expires. **/ public void setExpirationTime(long v) { this.setFieldValue(FLD_expirationTime, (v >= 0L)? v : 0L); } /** *** Returns true if this Device has expired *** @return True if this Device has expired **/ public boolean isExpired() { /* device expired? */ long expireTime = this.getExpirationTime(); if ((expireTime > 0L) && (expireTime < DateTime.getCurrentTimeSec())) { return true; } /* account expired? */ //Account account = this.getAccount(); //if ((account != null) && account.isExpired()) { // return true; //} /* not expired */ return false; } /** *** Returns true if this Device has an expiry date *** @return True if this Device has an expiry date **/ public boolean doesExpire() { long expireTime = this.getExpirationTime(); return (expireTime > 0L); } /** *** Returns true if this Device will expire within the specified number of seconds *** @param withinSec The tested expiry time range (in seconds) *** @return True if this Device will expire within the specified number of seconds **/ public boolean willExpire(long withinSec) { /* will device expire? */ long expireTime = this.getExpirationTime(); if ((expireTime > 0L) && ((withinSec < 0L) || (expireTime < (DateTime.getCurrentTimeSec() + withinSec)))) { return true; } /* will account expire */ //Account account = this.getAccount(); //if ((account != null) && account.willExpire(withinSec)) { // return true; //} /* will not expired */ return false; } // ------------------------------------------------------------------------ /** *** Returns true if this Device record supports the "linkURL" field *** @return True if this Device record supports the "linkURL" field **/ public static boolean supportsLinkURL() { return Device.getFactory().hasField(FLD_linkURL); } /** *** Returns true if this Device record defines a non-blank Link-URL value *** @return True if this Device record defines a non-blank Link-URL value **/ public boolean hasLink() { return !StringTools.isBlank(this.getLinkURL()); } /** *** Gets the Link-URL for this Device *** @return The Link-URL for this Device **/ public String getLinkURL() { String v = (String)this.getOptionalFieldValue(FLD_linkURL); return StringTools.trim(v); } /** *** Sets the Link-URL for this Device *** @param v The Link-URL for this Device **/ public void setLinkURL(String v) { this.setOptionalFieldValue(FLD_linkURL, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the Link-Description for this Device *** @return The Link-Description for this Device **/ public String getLinkDescription() { String v = (String)this.getOptionalFieldValue(FLD_linkDescription); return StringTools.trim(v); } /** *** Sets the Link-Description for this Device *** @param v The Link-Description for this Device **/ public void setLinkDescription(String v) { this.setOptionalFieldValue(FLD_linkDescription, StringTools.trim(v)); } // ------------------------------------------------------------------------ private static final boolean CHECK_ACCOUNT_ALLOWNOTIFY = false; /** *** Returns true if this Device record supports the "allowNotify" field *** @return True if this Device record supports the "allowNotify" field **/ public static boolean supportsNotification() { // hasOption return Device.getFactory().hasField(FLD_allowNotify); } /** *** Returns true if this device is to allow notifications *** @return True if this device is to allow notifications **/ public boolean getAllowNotify() { Boolean v = (Boolean)this.getOptionalFieldValue(FLD_allowNotify); return (v != null)? v.booleanValue() : false; } /** *** Sets the "Allow Notification" state for this Device *** @param v The "Allow Notification" state for this Device **/ public void setAllowNotify(boolean v) { this.setOptionalFieldValue(FLD_allowNotify, v); } /** *** Returns true if this device is to allow notifications *** @param checkAccount True to also check Account *** @return True if this device is to allow notifications **/ public boolean getAllowNotify(boolean checkAccount) { /* without regard to account setting? */ if (!checkAccount) { // explicit, do not check account return this.getAllowNotify(); } else if (!RTConfig.getBoolean(DBConfig.PROP_Device_checkAccountAllowNotify,CHECK_ACCOUNT_ALLOWNOTIFY)) { // property says to not check account return this.getAllowNotify(); } /* check account */ Account acct = this.getAccount(); return (acct != null)? acct.getAllowNotify() : false; } // ------------------------------------------------------------------------ /** *** Gets the Last Notification time for this Device (in Unix Epoch time format) *** @return The Last Notification time for this Device (in Unix Epoch time format) **/ public long getLastNotifyTime() { Long v = (Long)this.getOptionalFieldValue(FLD_lastNotifyTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the Last Notification time for this Device (in Unix Epoch time format) *** @param v The Last Notification time for this Device (in Unix Epoch time format) **/ public void setLastNotifyTime(long v) { this.setOptionalFieldValue(FLD_lastNotifyTime, v); } // --- /** *** Gets the Last Notification Status-Code for this Device *** @return The Last Notification Status-Code for this Device **/ public int getLastNotifyCode() { Integer v = (Integer)this.getOptionalFieldValue(FLD_lastNotifyCode); return (v != null)? v.intValue() : StatusCodes.STATUS_NONE; } /** *** Sets the Last Notification Status-Code for this Device *** @param v The Last Notification Status-Code for this Device **/ public void setLastNotifyCode(int v) { this.setOptionalFieldValue(FLD_lastNotifyCode, v); } // --- /** *** Gets the Rule-ID which triggered the Last Notification for this Device *** @return The Rule-ID which triggered the Last Notification for this Device **/ public String getLastNotifyRule() { String v = (String)this.getOptionalFieldValue(FLD_lastNotifyRule); return StringTools.trim(v); } /** *** Sets the Rule-ID which triggered the Last Notification for this Device *** @param v The Rule-ID which triggered the Last Notification for this Device **/ public void setLastNotifyRule(String v) { this.setOptionalFieldValue(FLD_lastNotifyRule, StringTools.trim(v)); } // --- /** *** Sets the event information for the last rule-triggered notification *** @param timestamp The timestamp (Unix Epoch format) of the notification *** @param ruleID The Rule-ID which triggered the notification *** @param update True to update the Device record now **/ public void setLastNotifyEvent(long timestamp, String ruleID, boolean update) throws DBException { if (timestamp >= 0L) { this.setLastNotifyTime(timestamp); // FLD_lastNotifyTime this.setLastNotifyCode(StatusCodes.STATUS_NONE); // FLD_lastNotifyCode } else { this.setLastNotifyTime(0L); // FLD_lastNotifyTime this.setLastNotifyCode(StatusCodes.STATUS_NONE); // FLD_lastNotifyCode } this.setLastNotifyRule(ruleID); // FLD_lastNotifyRule if (update) { this.update( Device.FLD_lastNotifyTime, Device.FLD_lastNotifyCode, Device.FLD_lastNotifyRule ); } else { this.addOtherChangedFieldNames( Device.FLD_lastNotifyTime, Device.FLD_lastNotifyCode, Device.FLD_lastNotifyRule ); } } /** *** Sets the event information for the last rule-triggered notification *** @param event The EventData record of the notification *** @param ruleID The Rule-ID which triggered the notification *** @param update True to update the Device record now **/ public void setLastNotifyEvent(EventData event, String ruleID, boolean update) throws DBException { if (event != null) { this.setLastNotifyTime(event.getTimestamp()); // FLD_lastNotifyTime this.setLastNotifyCode(event.getStatusCode()); // FLD_lastNotifyCode } else { this.setLastNotifyTime(0L); // FLD_lastNotifyTime this.setLastNotifyCode(StatusCodes.STATUS_NONE); // FLD_lastNotifyCode } this.setLastNotifyRule(ruleID); // FLD_lastNotifyRule if (update) { this.update( Device.FLD_lastNotifyTime, Device.FLD_lastNotifyCode, Device.FLD_lastNotifyRule ); } else { this.addOtherChangedFieldNames( Device.FLD_lastNotifyTime, Device.FLD_lastNotifyCode, Device.FLD_lastNotifyRule ); } } /** *** Clears the last notification for this Device *** @param update True to update the Device record after clearing **/ public void clearLastNotifyEvent(boolean update) throws DBException { this.setLastNotifyEvent(null/*EventData*/, ""/*RuleID*/, update); } /** *** Gets the EventData record for the last notification *** @return The EventData record for the last notification **/ public EventData getLastNotifyEvent() { long ts = this.getLastNotifyTime(); int sc = this.getLastNotifyCode(); /* no active notify event */ if ((ts <= 0L) || (sc <= 0)) { return null; } /* get event */ String A = this.getAccountID(); String D = this.getDeviceID(); try { EventData ev = EventData.getEventData(A, D, ts, sc); if (ev == null) { Print.logWarn("LastNofityEvent not found: "+A+"/"+D+", " + ts + " " + StatusCodes.ToString(sc)); return null; } else { return ev; } } catch (DBException dbe) { Print.logError("Error reading Device notify event ["+A+"/"+D+"]: " + dbe); return null; } } // ------------------------------------------------------------------------ /** *** Gets the Notification Email address *** @return The Notification Email Address **/ public String getNotifyEmail() { String v = (String)this.getOptionalFieldValue(FLD_notifyEmail); return StringTools.trim(v); } /** *** Sets the Notification Email address *** @param v The Notification Email Address **/ public void setNotifyEmail(String v) { this.setOptionalFieldValue(FLD_notifyEmail, StringTools.trim(v)); } /** *** Returns a String containing all email address that should be notified for this Device *** @param inclAccount True to include the Account notify email address *** @param inclUser True to include the assigned User notify email address *** @return The String containing email addresses to notify **/ public String getNotifyEmail(boolean inclAccount, boolean inclUser) { StringBuffer sb = new StringBuffer(); sb.append(this.getNotifyEmail()); // start with just Device notifyEmail /* include Account notify email addresses */ if (inclAccount) { Account acct = this.getAccount(); if (acct == null) { // skip (should not occur) } else { String ae = acct.getNotifyEmail(); if (!StringTools.isBlank(ae)) { if (sb.length() > 0) { sb.append(","); } sb.append(ae); } } } /* include User notify email addresses */ if (inclUser) { User user = this.getAssignedUser(); try { if (user == null) { // skip (invalid/blank user-d) } else if (!user.isAuthorizedDevice(this.getDeviceID())) { // DBException // skip (not authorized) } else { String ue = user.getNotifyEmail(); if (!StringTools.isBlank(ue)) { if (sb.length() > 0) { sb.append(","); } sb.append(ue); } } } catch (DBException dbe) { Print.logException("Checking User authorization", dbe); // skip (exception) } } /* return accumulated addresses */ return sb.toString(); } // --- /** *** Gets the Rule Selector to be evaluated by the installed RuleFactory.
*** This rule-selector is currently only used by default with the "RuleFactoryLite" module. *** @return The rule-selector to evaluate **/ public String getNotifySelector() { // see CHECK_NOTIFY_SELECTOR String v = (String)this.getOptionalFieldValue(FLD_notifySelector); return StringTools.trim(v); } /** *** Sets the Rule Selector to be evaluated by the installed RuleFactory.
*** This rule-selector is currently only used by default with the "RuleFactoryLite" module. *** @param v The rule-selector to evaluate **/ public void setNotifySelector(String v) { this.setOptionalFieldValue(FLD_notifySelector, StringTools.trim(v)); } // --- /** *** Gets the Notify Actions to be executed if the Notify Rule-Selector is triggered.
*** This notify action is currently only used by default with the "RuleFactoryLite" module. *** @return The notify action mask **/ public int getNotifyAction() { Integer v = (Integer)this.getOptionalFieldValue(FLD_notifyAction); return (v != null)? RuleFactoryAdapter.ValidateActionMask(v.intValue()) : RuleFactory.ACTION_DEFAULT; } /** *** Sets the Notify Actions to be executed if the Notify Rule-Selector is triggered.
*** This notify action is currently only used by default with the "RuleFactoryLite" module. *** @param v The notify action mask **/ public void setNotifyAction(int v) { this.setOptionalFieldValue(FLD_notifyAction, RuleFactoryAdapter.ValidateActionMask(v)); } // --- /** *** Gets the Notify Description for the rule-selector specified.
*** This notify description is currently only used by default with the "RuleFactoryLite" module. *** @return The notify description **/ public String getNotifyDescription() { String v = (String)this.getOptionalFieldValue(FLD_notifyDescription); return StringTools.trim(v); } /** *** Sets the Notify Description for the rule-selector specified.
*** This notify description is currently only used by default with the "RuleFactoryLite" module. *** @param v The notify description **/ public void setNotifyDescription(String v) { this.setOptionalFieldValue(FLD_notifyDescription, StringTools.trim(v)); } // --- /** *** Gets the Email Subject for the triggered notification email .
*** This email subject is currently only used by default with the "RuleFactoryLite" module. *** @return The notify email subject **/ public String getNotifySubject() { String v = (String)this.getFieldValue(FLD_notifySubject); return (v != null)? v : ""; } /** *** Sets the Email Subject for the triggered notification email .
*** This email subject is currently only used by default with the "RuleFactoryLite" module. *** @param v The notify email subject **/ public void setNotifySubject(String v) { this.setFieldValue(FLD_notifySubject, ((v != null)? v : "")); } // --- /** *** Gets the Email Body/Text for the triggered notification email .
*** This email body/text is currently only used by default with the "RuleFactoryLite" module. *** @return The notify email body **/ public String getNotifyText() { String v = (String)this.getFieldValue(FLD_notifyText); return (v != null)? v : ""; } /** *** Sets the Email Body/Text for the triggered notification email .
*** This email body/text is currently only used by default with the "RuleFactoryLite" module. *** @param v The notify email body **/ public void setNotifyText(String v) { String s = (v != null)? StringTools.encodeNewline(v) : ""; this.setFieldValue(FLD_notifyText, s); } // --- /** *** (OBSOLETE) Gets the configuration state indicating whether the email wrapper from the "private.xml" *** file should be used.
*** The method is obsolete and should not be used. *** @return The email wrapper configuration state **/ public boolean getNotifyUseWrapper() { if (ALLOW_USE_EMAIL_WRAPPER) { Boolean v = (Boolean)this.getFieldValue(FLD_notifyUseWrapper); return (v != null)? v.booleanValue() : true; } else { return false; } } /** *** (OBSOLETE) Sets the configuration state indicating whether the email wrapper from the "private.xml" *** file should be used.
*** The method is obsolete and should not be used. *** @param v The email wrapper configuration state **/ public void setNotifyUseWrapper(boolean v) { this.setFieldValue(FLD_notifyUseWrapper, v); } // --- /** *** (OBSOLETE) Gets the notification priority.
*** The method is obsolete and should not be used. *** @return The notification priority **/ public int getNotifyPriority() { Integer v = (Integer)this.getOptionalFieldValue(FLD_notifyPriority); return (v != null)? v.intValue() : 0; } /** *** (OBSOLETE) Sets the notification priority.
*** The method is obsolete and should not be used. *** @param v The notification priority **/ public void setNotifyPriority(int v) { this.setOptionalFieldValue(FLD_notifyPriority, ((v < 0)? 0 : v)); } // ------------------------------------------------------------------------ /** *** Clears the parked location state **/ public void clearParkedLocation() { this.setParkedLocation(null, 0.0); } /** *** Sets the parked location state *** @param parkLoc The GeoPoint of the location where the device should be "parked" *** @param parkRadM The radius, in meters, of the parked location ***/ public void setParkedLocation(GeoPoint parkLoc, double parkRadM) { if (!GeoPoint.isValid(parkLoc) || (parkRadM <= 0.0)) { //Print.logInfo("Clearing parked location"); this.setParkedLatitude(0.0); this.setParkedLongitude(0.0); this.setParkedRadius(0.0); } else { //Print.logInfo("Setting parked location: " + parkLoc + " " + parkRadM + " m"); this.setParkedLatitude(parkLoc.getLatitude()); this.setParkedLongitude(parkLoc.getLongitude()); this.setParkedRadius(parkRadM); } this.addOtherChangedFieldNames( Device.FLD_parkedLatitude, Device.FLD_parkedLongitude, Device.FLD_parkedRadius ); } /** *** Saves the set parked location back to the Device table *** @throws DBException ***/ public void saveParkedLocation() throws DBException { this.update( Device.FLD_parkedLatitude, Device.FLD_parkedLongitude, Device.FLD_parkedRadius ); } /** *** Returns true if this Device is parked *** @return True if this Device is parked **/ public boolean isParked() { if (this.getParkedRadius() <= 0.0) { return false; } else if (!GeoPoint.isValid(this.getParkedLatitude(),this.getParkedLongitude())) { return false; } else { return true; } } /** *** Returns true if the specified GeoPoint location indicates a "Park" violation *** @param gp The current GeoPoint to test *** @return True if the specified GeoPoint location indicates a "Park" violation **/ public boolean isParkedViolation(GeoPoint gp) { /* no point specified */ if (!GeoPoint.isValid(gp)) { return false; // invalid point, no violation } /* get parked location */ double parkLat = this.getParkedLatitude(); double parkLon = this.getParkedLongitude(); double parkRad = this.getParkedRadius(); if (!GeoPoint.isValid(parkLat,parkLon) || (parkRad <= 0.0)) { return false; // not parked, no violation } GeoPoint parkLoc = new GeoPoint(parkLat,parkLon); /* outside of parked zone? */ double distM = parkLoc.metersToPoint(gp); //Print.logInfo("Comparing ParkRadius '"+parkRad+"' to distance '"+distM+"' m"); return (distM > parkRad)? true : false; } /** *** Gets the Parked Latitude *** @return The parked latitude **/ public double getParkedLatitude() { return this.getOptionalFieldValue(FLD_parkedLatitude, 0.0); } /** *** Sets the Parked Latitude *** @param v The parked latitude **/ public void setParkedLatitude(double v) { this.setOptionalFieldValue(FLD_parkedLatitude, v); } /** *** Gets the Parked Longitude *** @return The parked Longitude **/ public double getParkedLongitude() { return this.getOptionalFieldValue(FLD_parkedLongitude, 0.0); } /** *** Sets the Parked Longitude *** @param v The parked Longitude **/ public void setParkedLongitude(double v) { this.setOptionalFieldValue(FLD_parkedLongitude, v); } /** *** Gets the Parked GeoPoint *** @return The Parked GeoPoint, or an invalid GeoPoint (0/0) if not parked **/ public GeoPoint getParkedLocation() { double pLat = this.getParkedLatitude(); double pLon = this.getParkedLongitude(); double pRad = this.getParkedRadius(); if ((pRad > 0.0) && GeoPoint.isValid(pLat,pLon)) { return new GeoPoint(pLat,pLon); } else { return GeoPoint.INVALID_GEOPOINT; } } /** *** Gets the parked radius, in meters *** @return The parked radius, in meters **/ public double getParkedRadius() { return this.getOptionalFieldValue(FLD_parkedRadius, 0.0); } /** *** Sets the parked radius, in meters *** @param v The parked radius, in meters **/ public void setParkedRadius(double v) { this.setOptionalFieldValue(FLD_parkedRadius, v); } /** *** Gets the parked address, if parked *** @return The parked address, if parked **/ public String getParkedAddress() { return ""; // this.getOptionalFieldValue(FLD_parkedAddress, ""); } /** *** Sets the parked address, if parked *** @param v The parked address, if parked **/ public void setParkedAddress(String v) { //this.setOptionalFieldValue(FLD_parkedAddress, v); } // ------------------------------------------------------------------------ /** *** Returns true if this Device record supports Border-Crossing *** @return True if this Device record supports Border-Crossing **/ public static boolean supportsBorderCrossing() { return Device.getFactory().hasField(FLD_borderCrossing); } /** *** Gets the Border-Crossing enabled state *** @return The Border-Crossing enabled state **/ public int getBorderCrossing() { Integer v = (Integer)this.getOptionalFieldValue(FLD_borderCrossing); return (v != null)? v.intValue() : 0; // Note the returned value of this flag may be ignored by 'BorderCrossing' } /** *** Sets the Border-Crossing enabled state *** @param flags The Border-Crossing enabled state **/ public void setBorderCrossing(int flags) { this.setOptionalFieldValue(FLD_borderCrossing, flags); } /** *** Sets the Border-Crossing enabled state *** @param bcs The Border-Crossing enabled state **/ public void setBorderCrossing(Device.BorderCrossingState bcs) { int bcf = (bcs != null)? bcs.getIntValue() : Device.BorderCrossingState.OFF.getIntValue(); this.setBorderCrossing(bcf); } // --- /** *** Gets the last calculated Border-Crossing time (Unix Epoch format) *** @return The last calculated Border-Crossing time (Unix Epoch format) **/ public long getLastBorderCrossTime() { Long v = (Long)this.getOptionalFieldValue(FLD_lastBorderCrossTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last calculated Border-Crossing time (Unix Epoch format) *** @param v The last calculated Border-Crossing time (Unix Epoch format) **/ public void setLastBorderCrossTime(long v) { this.setOptionalFieldValue(FLD_lastBorderCrossTime, v); } // Device/Asset specific data above // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // DataTransport specific data below private static boolean CHECK_IMEI_FOR_MODEM_ID = false; private String modemID = ""; /** *** Extracts the Mobile-ID from the IMEI# or Unique-ID
*** This method relies on the unique-id prefix to end with "_" or "-". *** @return The extracted Mobile-ID **/ public String getModemID() { if (StringTools.isBlank(this.modemID)) { String imei = this.getImeiNumber(); if (CHECK_IMEI_FOR_MODEM_ID && !StringTools.isBlank(imei)) { this.modemID = imei; } else { String uniqID = this.getUniqueID(); if (!StringTools.isBlank(uniqID)) { int p = uniqID.indexOf("_"); if (p < 0) { p = uniqID.indexOf("-"); } if (p < 0) { this.modemID = uniqID; } else { this.modemID = uniqID.substring(p+1); } } } } return this.modemID; } /** *** Sets the preextracted Mobile-ID for this device *** @param mid The Mobile-ID for this device **/ public void setModemID(String mid) { // NOT stored in the Device table. Only used by the caller this.modemID = StringTools.trim(mid); } // -------- /** *** Gets the Unique-ID for this Device *** @return The Unique-ID **/ public String getUniqueID() { String v = (String)this.getFieldValue(FLD_uniqueID); return StringTools.trim(v); } /** *** Sets the Unique-ID for this Device *** @param v The Unique-ID **/ public void setUniqueID(String v) { this.setFieldValue(FLD_uniqueID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the Device-Code (also called Server-ID) for this Device *** @return The Device-Code / Server-ID **/ public String getDeviceCode() { String v = (String)this.getFieldValue(FLD_deviceCode); // serverID return StringTools.trim(v); } /** *** Sets the Device-Code (also called Server-ID) for this Device *** @param v The Device-Code / Server-ID **/ public void setDeviceCode(String v) { this.setFieldValue(FLD_deviceCode, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the Device-Type for this Device *** @return The Device-Type **/ public String getDeviceType() { String v = (String)this.getFieldValue(FLD_deviceType); return StringTools.trim(v); } /** *** Sets the Device-Type for this Device *** @param v The Device-Type **/ public void setDeviceType(String v) { this.setFieldValue(FLD_deviceType, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the DCS Properties ID assigned to this device (DCS Property ID)
*** Used by some DCS modules to select specific device configurations *** @return The DCS Property ID **/ public String getDcsPropertiesID() { String v = (String)this.getFieldValue(FLD_dcsPropertiesID); return StringTools.trim(v); } /** *** Sets the DCS Properties ID assigned to this device (DCS Property ID)
*** Used by some DCS modules to select specific device configurations *** @param v The DCS Property ID **/ public void setDcsPropertiesID(String v) { this.setFieldValue(FLD_dcsPropertiesID, StringTools.trim(v)); } /** *** Gets the DCS Property ID for the specified device *** @param device The Device *** @return The DCS Property ID **/ public static String GetDcsPropertiesID(Device device) { /* no device */ if (device == null) { return ""; } /* Device defined? */ String dcsPropsID = device.getDcsPropertiesID(); if (!StringTools.isBlank(dcsPropsID)) { return dcsPropsID; } /* Account defined? */ Account account = device.getAccount(); if (account != null) { dcsPropsID = account.getDcsPropertiesID(); if (!StringTools.isBlank(dcsPropsID)) { return dcsPropsID; } } /* not defined */ return ""; } // ------------------------------------------------------------------------ /** *** Gets the DCS Command Host assigned to this device (ie. the host name *** where the DCS for this device is running)
*** May return blank to indicate that the default DCS command host should *** be used. *** @return The DCS Command Hostname **/ public String getDcsCommandHost() { String v = (String)this.getFieldValue(FLD_dcsCommandHost); return StringTools.trim(v); } /** *** Returns true if this device defines a custom command host. *** @return True if a custom command host is defined. **/ public boolean hasDcsCommandHost() { return !StringTools.isBlank(this.getDcsCommandHost()); } /** *** Sets the DCS Command Host assigned to this device (ie. the host name *** where the DCS for this device is running)
*** May be blank to indicate that the default DCS command host should be *** used. *** @param v The DCS Command Hostname **/ public void setDcsCommandHost(String v) { this.setFieldValue(FLD_dcsCommandHost, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Returns true if this Device has a specific defined pushpin-id *** @return True if this Device has a specific defined pushpin-id **/ public boolean hasPushpinID() { return !StringTools.isBlank(this.getPushpinID()); } /** *** Gets the defined pushpin-id, or blank if no pushpin-id is defined *** @return The defined pushpin-id, or blank if no pushpin-id is defined **/ public String getPushpinID() { String v = (String)this.getFieldValue(FLD_pushpinID); return StringTools.trim(v); } /** *** Sets the defined pushpin-id, or blank if no pushpin-id is defined *** @param v The defined pushpin-id, or blank if no pushpin-id is defined **/ public void setPushpinID(String v) { this.setFieldValue(FLD_pushpinID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Returns true if this Device has a specific defined display color *** @return True if this Device has a specific defined display color **/ public boolean hasDisplayColor() { return !StringTools.isBlank(this.getDisplayColor()); } /** *** Gets the defined display-color *** @return The defined display-color **/ public String getDisplayColor() { String v = (String)this.getFieldValue(FLD_displayColor); return StringTools.trim(v); } /** *** Gets the defined display-color, or returns the specified default color *** if not display-color is defined. *** @return The defined display-color **/ public ColorTools.RGB getDisplayColor(ColorTools.RGB dft) { return ColorTools.parseColor(this.getDisplayColor(),dft); } /** *** Sets the display color *** @param v The display color **/ public void setDisplayColor(ColorTools.RGB v) { this.setDisplayColor((v != null)? v.toString(true) : null); } /** *** Sets the display color *** @param v The display color **/ public void setDisplayColor(String v) { this.setFieldValue(FLD_displayColor, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the map legend (currently not used) *** @return The map legend **/ public String getMapLegend() { return ""; } /** *** Sets the map legend (currently not used) *** @param legend The map legend **/ public void setMapLegend(String legend) { // } // ------------------------------------------------------------------------ /** *** Gets the assigned device serial number *** @return The serial number **/ public String getSerialNumber() { String v = (String)this.getFieldValue(FLD_serialNumber); return StringTools.trim(v); } /** *** Sets the assigned device serial number *** @param v The serial number **/ public void setSerialNumber(String v) { this.setFieldValue(FLD_serialNumber, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the SIM phone number *** @return The SIM phone number **/ public String getSimPhoneNumber() { String v = (String)this.getFieldValue(FLD_simPhoneNumber); return StringTools.trim(v); } /** *** Sets the SIM phone number *** @param v The SIM phone number **/ public void setSimPhoneNumber(String v) { this.setFieldValue(FLD_simPhoneNumber, StringTools.trim(v)); } /** *** Returns an array of Device-IDs for the specified SIM phone number *** @param simPhone The SIM phone number *** @return And array of Device-IDs for the specified SIM phone number **/ public static java.util.List getDeviceIDsForSimPhoneNumber(String simPhone) throws DBException { return Device.getDeviceIDsForSimPhoneNumber(simPhone, (char)0); } /** *** Returns an array of Device-IDs for the specified SIM phone number *** @param simPhone The SIM phone number *** @param sepCH The preferred character for separating the account/device ids *** @return And array of Device-IDs for the specified SIM phone number **/ public static java.util.List getDeviceIDsForSimPhoneNumber(String simPhone, char sepCH) throws DBException { String sep = (sepCH == (char)0)? "," : String.valueOf(sepCH); /* Phone number specified? */ if (StringTools.isBlank(simPhone)) { throw new DBException("SIM phone number not specified"); } /* read accounts for contact email */ java.util.List devList = new Vector(); DBConnection dbc = null; Statement stmt = null; ResultSet rs = null; try { /* select */ // DBSelect: SELECT * FROM Device WHERE (simPhoneNumber='12345') DBSelect dsel = new DBSelect(Device.getFactory()); dsel.setSelectedFields( Device.FLD_accountID, Device.FLD_deviceID, Device.FLD_simPhoneNumber); DBWhere dwh = dsel.createDBWhere(); dsel.setWhere(dwh.WHERE( dwh.EQ(Device.FLD_simPhoneNumber,simPhone) )); // Note: The index on the column FLD_simPhoneNumber is not unique // (since null/empty values are allowed and needed) /* get records */ dbc = DBConnection.getDefaultConnection(); stmt = dbc.execute(dsel.toString()); rs = stmt.getResultSet(); while (rs.next()) { String acctId = rs.getString(FLD_accountID); String devId = rs.getString(FLD_deviceID); devList.add(acctId + sep + devId); } } catch (SQLException sqe) { throw new DBException("Get Device SimPhoneNumber", sqe); } finally { if (rs != null) { try { rs.close(); } catch (Throwable t) {} } if (stmt != null) { try { stmt.close(); } catch (Throwable t) {} } DBConnection.release(dbc); } return devList; } // ------------------------------------------------------------------------ /** *** Gets the SIM-ID *** @return The SIM-ID **/ public String getSimID() { String v = (String)this.getFieldValue(FLD_simID); return StringTools.trim(v); } /** *** Gets the SIM-ID *** @param v The SIM-ID **/ public void setSimID(String v) { this.setFieldValue(FLD_simID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the SMS email address for this device.
*** Used for sending commands to the device using email-to-SMS. *** @return The SMS email address for this device **/ public String getSmsEmail() { String v = (String)this.getFieldValue(FLD_smsEmail); return StringTools.trim(v); } /** *** Sets the SMS email address for this device.
*** Used for sending commands to the device using email-to-SMS. *** @param v The SMS email address for this device **/ public void setSmsEmail(String v) { this.setFieldValue(FLD_smsEmail, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the IMEI# (or ESN) for this device. *** @return The IMEI# for this device **/ public String getImeiNumber() { String v = (String)this.getFieldValue(FLD_imeiNumber); return StringTools.trim(v); } /** *** Gets the IMEI# (or ESN) for this device. *** @param v The IMEI# for this device **/ public void setImeiNumber(String v) { this.setFieldValue(FLD_imeiNumber, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Returns true if the specified key matches the "dataKey" (also call PIN) for this device *** @param pin The data key (PIN) to check *** @return True if the keys match **/ public boolean validateDataKey(String pin) { // check for a valid key/pin here String dkey = this.getDataKey(); return !StringTools.isBlank(dkey)? dkey.equals(pin) : true; } /** *** Gets the data key (PIN) for this device *** @return The Data key (PIN) for this device **/ public String getDataKey() { String v = (String)this.getFieldValue(FLD_dataKey); return StringTools.trim(v); } /** *** Gets the data key (PIN) for this device, as a byte array *** @return The Data key (PIN) for this device, as a byte array **/ public byte[] getDataKeyAsByteArray() { String dk = this.getDataKey(); if (dk.startsWith("0x") || dk.startsWith("0X")) { return StringTools.parseHex(dk, null); } else { return dk.getBytes(); } } /** *** Gets the data key (PIN) for this device *** @param v The Data key (PIN) for this device **/ public void setDataKey(String v) { this.setFieldValue(FLD_dataKey, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the specified bit state of the last digital input received *** @return The specified bit state of the last digital input received **/ public boolean getLastInputState(int bit) // see also "getCommandStateMaskBit" { long mask = this.getLastInputState(); DCServerConfig dcs = this.getDCServerConfig(); if (dcs != null) { return dcs.getDigitalInputState(mask, bit); } else { return ((mask & (1L << bit)) != 0L); } } /** *** Gets the bit mask of the last digital input received
*** see also EventData.getInputMask() *** @return The bit mask of the last digital input received **/ public long getLastInputState() { Long v = (Long)this.getFieldValue(FLD_lastInputState); return (v != null)? v.longValue() : 0L; } /** *** Sets the bit mask of the last digital input received *** @param v The bit mask of the last digital input received **/ public void setLastInputState(long v) { this.setFieldValue(FLD_lastInputState, v & 0xFFFFFFFFL); // 32-bits only } // ------------------------------------------------------------------------ /** *** Gets the specified bit state of the last digital output received *** @return The specified bit state of the last digital output received **/ public boolean getLastOutputState(int bit) { long mask = this.getLastOutputState(); DCServerConfig dcs = this.getDCServerConfig(); if (dcs != null) { return dcs.getDigitalOutputState(mask, bit); } else { return ((mask & (1L << bit)) != 0L); } } /** *** Gets the bit mask of the last digital output received
*** see also EventData.getOutputMask() *** @return The bit mask of the last digital output received **/ public long getLastOutputState() { Long v = (Long)this.getFieldValue(FLD_lastOutputState); return (v != null)? v.longValue() : 0L; } /** *** Sets the bit mask of the last digital output received *** @param v The bit mask of the last digital output received **/ public void setLastOutputState(long v) { this.setFieldValue(FLD_lastOutputState, v & 0xFFFFFFFFL); // 32-bits only } // ------------------------------------------------------------------------ /** *** Gets the StatusCode state for the specified bit *** @param bit The bit index *** @return The StatusCode state for the specified bit **/ public boolean getStatusCodeStateBit(int bit) { long mask = this.getStatusCodeState(); return ((mask & (1L << bit)) != 0L); } /** *** Sets the StatusCode state for the specified bit *** @param bit The bit index *** @param state The bit state *** @return The StatusCode state for the specified bit **/ public void setStatusCodeStateBit(int bit, boolean state) { long mask = this.getStatusCodeState(); if (state) { mask |= (1L << bit); } else { mask &= ~(1L << bit); } this.setStatusCodeState(mask); } /** *** Gets the bit mask of the StatusCode on/off state *** @return The bit mask of the StatusCode on/off state **/ public long getStatusCodeState() { Long v = (Long)this.getFieldValue(FLD_statusCodeState); return (v != null)? v.longValue() : 0L; } /** *** Sets the bit mask of the StatusCode on/off state *** @param v The bit mask of the StatusCode on/off state **/ public void setStatusCodeState(long v) { this.setFieldValue(FLD_statusCodeState, v); } // ------------------------------------------------------------------------ /** *** Gets the last battery level recieved *** @return The last battery level recieved **/ public double getLastBatteryLevel() { Double v = (Double)this.getFieldValue(FLD_lastBatteryLevel); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the last battery level recieved *** @param v The last battery level recieved **/ public void setLastBatteryLevel(double v) { this.setFieldValue(FLD_lastBatteryLevel, ((v >= 0.0)? v : 0.0)); } // ------------------------------------------------------------------------ /** *** Gets the last fuel level recieved *** @return The last fuel level recieved **/ public double getLastFuelLevel() { Double v = (Double)this.getFieldValue(FLD_lastFuelLevel); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the last fuel level recieved *** @param v The last fuel level recieved **/ public void setLastFuelLevel(double v) { this.setFieldValue(FLD_lastFuelLevel, ((v >= 0.0)? v : 0.0)); } // ------------------------------------------------------------------------ /** *** Gets the last fuel total recieved *** @return The last fuel total recieved **/ public double getLastFuelTotal() { Double v = (Double)this.getFieldValue(FLD_lastFuelTotal); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the last fuel total recieved *** @param v The last fuel total recieved **/ public void setLastFuelTotal(double v) { this.setFieldValue(FLD_lastFuelTotal, ((v >= 0.0)? v : 0.0)); } /** *** Gets the fuel used within the specified time range **/ public double getFuelUsedInRange(long startTime, long endTime) { long limit = 5L; long timeOfs = 120L; // seconds /* start time must be specified */ if (startTime <= 0L) { return -1.0; } /* get starting events */ EventData evStrBest = null; try { EventData evStr[] = this.getRangeEvents( (startTime - timeOfs), -1/*timeEnd*/, null, // statusCodes[] false, // validGPS EventData.LimitType.FIRST, limit); if (ListTools.isEmpty(evStr)) { // no starting events return -1.0; } for (int i = 0; i < evStr.length; i++) { long ts = evStr[i].getTimestamp(); double fuelUsed = evStr[i].getFuelTotal(); if (fuelUsed > 0.0) { evStrBest = evStr[i]; } if ((ts >= startTime) && (evStrBest != null)) { // we've past the startTime event and we have a valid fuel-used event break; } } if (evStrBest == null) { // none of the events had fuel-used information return -1.0; } } catch (DBException dbe) { Print.logException("Getting starting fuel events", dbe); return -1.0; } /* get ending events */ EventData evEndBest = null; try { EventData evEnd[] = this.getRangeEvents( -1/*timeStart*/, ((endTime > 0L)? (endTime + timeOfs) : -1L), null, // statusCodes[] false, // validGPS EventData.LimitType.LAST, limit); if (ListTools.isEmpty(evEnd)) { // no ending events return -1.0; } for (int i = evEnd.length - 1; i >= 0; i--) { long ts = evEnd[i].getTimestamp(); double fuelUsed = evEnd[i].getFuelTotal(); if (fuelUsed > 0.0) { evEndBest = evEnd[i]; } if (((endTime <= 0L) || (ts <= endTime)) && (evEndBest != null)) { // we've past the endTime event and we have a valid fuel-used event break; } } if (evStrBest == null) { // none of the events had fuel-used information return -1.0; } } catch (DBException dbe) { Print.logException("Getting ending fuel events", dbe); return -1.0; } /* calculate fuel usage delta */ // evStrBest/evEndBest are non null, and have a positive fuelTotal value double fuelUsedStr = evStrBest.getFuelTotal(); double fuelUsedEnd = evEndBest.getFuelTotal(); if (fuelUsedEnd >= fuelUsedStr) { return (fuelUsedEnd - fuelUsedStr); } else { // invalid fuel total values return -1.0; } } // ------------------------------------------------------------------------ /** *** Gets the last oil level recieved *** @return The last oil level recieved **/ public double getLastOilLevel() { Double v = (Double)this.getFieldValue(FLD_lastOilLevel); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the last oil level recieved *** @param v The last oil level recieved **/ public void setLastOilLevel(double v) { this.setFieldValue(FLD_lastOilLevel, ((v >= 0.0)? v : 0.0)); } // ------------------------------------------------------------------------ /** *** Returns the bit index within the input mask which indicates the ignition state. *** If the ignition state is not indicated by a bit in the input state, but rather *** specific IGNITION_ON/IGNITION_OFF status code events, then this method returns "99". *** Returns "-1" if no ignition state bit index is defined. *** @return The ignition state but index. **/ public int getIgnitionIndex() { Integer v = (Integer)this.getFieldValue(FLD_ignitionIndex); return (v != null)? v.intValue() : -1; } /** *** Sets the bit index for the inputMask ignition state indicator. *** @param v The bit index, or 99 to indicate IGNITION_ON/IGNITION_OFF status codes **/ public void setIgnitionIndex(int v) { int ignNdx = this.getIgnitionIndex(); if (ignNdx != v) { // ignition state has changed this.setFieldValue(FLD_ignitionIndex, ((v >= 0)? v : -1)); // reset last ignition on/off times this.setLastIgnitionOnTime(0L); // FLD_lastIgnitionOnTime this.setLastIgnitionOffTime(0L); // FLD_lastIgnitionOffTime // assuming the ignition on/off times will get updated when the inginition index does } } /** *** Returns a 2 element array indicating the status codes which indicate the ignition state. *** The first element represents the ignition-off status code, and the second represents *** the ignition-on status code. Returns null if no ignition state status codes are defined. *** @return The status codes indicating the ignition state, or null if not defined **/ public int[] getIgnitionStatusCodes() { int ndx = this.getIgnitionIndex(); if (ndx >= 0) { int scOFF = StatusCodes.GetDigitalInputStatusCode(ndx, false); int scON = StatusCodes.GetDigitalInputStatusCode(ndx, true ); if (scOFF != StatusCodes.STATUS_NONE) { return new int[] { scOFF, scON }; } else { return null; } } else { return null; } } /* ignition state check */ private static boolean CHECK_LAST_EVENT_IGNITION = false; /** *** Returns the current ignition state
*** -1 = unknown
*** 0 = off
*** 1 = on *** @return The current ignition state for this device. **/ public int getCurrentIgnitionState() { boolean checkSC = RTConfig.getBoolean(DBConfig.PROP_Device_checkLastEventIgnitionState,CHECK_LAST_EVENT_IGNITION); return this.getCurrentIgnitionState(checkSC, true); } /* ignition state cache */ private int cacheIgnitionState = -2; /** *** Returns the current ignition state
*** -1 = unknown
*** 0 = off
*** 1 = on *** @param checkSC True to check ignition state based on the most recent event status codes *** @param update True to update Device last ignition on/off times *** @return The current ignition state for this device. **/ public int getCurrentIgnitionState(boolean checkSC, boolean update) { /* already determined? */ if (this.cacheIgnitionState >= -1) { // already initialized return this.cacheIgnitionState; } /* check last ignition on/off times */ long lastIgnOn = this.getLastIgnitionOnTime(); long lastIgnOff = this.getLastIgnitionOffTime(); if ((lastIgnOn > 0L) && (lastIgnOff > 0L)) { if (lastIgnOn > lastIgnOff) { this.cacheIgnitionState = 1; return this.cacheIgnitionState; } else if (lastIgnOff > lastIgnOn) { this.cacheIgnitionState = 0; return this.cacheIgnitionState; } else { // (lastIgnOff == lastIgnOn) unlikely } } /* get ignition state index */ int ignNdx = this.getIgnitionIndex(); if (ignNdx < 0) { // no ignition bit specified this.cacheIgnitionState = -1; // unknwon return this.cacheIgnitionState; } /* check inputMask if we are not checking a specific status code */ if (ignNdx < StatusCodes.IGNITION_INPUT_INDEX) { this.cacheIgnitionState = this.getLastInputState(ignNdx)? 1 : 0; return this.cacheIgnitionState; } /* check for status code based ignition definition? */ int ignSC[] = this.getIgnitionStatusCodes(); if (ignSC == null) { // no status code definition this.cacheIgnitionState = -1; return this.cacheIgnitionState; } /* look for the last ignition state based on a status code */ if (checkSC) { // non-optimized try { EventData ev = this.getLastEvent(ignSC); if (ev == null) { //no such event this.cacheIgnitionState = -1; } else if (ev.getStatusCode() == ignSC[0]) { // Ignition-OFF this.cacheIgnitionState = 0; long ignTS = ev.getTimestamp(); this.setLastIgnitionOffTime(ignTS); // FLD_lastIgnitionOffTime if (ignTS < this.getLastIgnitionOnTime()) { // make sure last ignition On time reflects "Ignition-OFF" this.setLastIgnitionOnTime(0L); // FLD_lastIgnitionOnTime } // set update fields boolean didUpdate = false; if (update) { try { this.update( Device.FLD_lastIgnitionOnTime, Device.FLD_lastIgnitionOffTime); didUpdate = true; } catch (DBException dbe) { didUpdate = false; } } if (!didUpdate) { this.addOtherChangedFieldNames( Device.FLD_lastIgnitionOnTime, Device.FLD_lastIgnitionOffTime); } } else if (ev.getStatusCode() == ignSC[1]) { // Ignition-ON this.cacheIgnitionState = 1; long ignTS = ev.getTimestamp(); this.setLastIgnitionOnTime(ignTS); // FLD_lastIgnitionOnTime if (ignTS < this.getLastIgnitionOffTime()) { // make sure last ignition Off time reflects "Ignition-ON" this.setLastIgnitionOffTime(0L); // FLD_lastIgnitionOffTime } // set update fields boolean didUpdate = false; if (update) { try { this.update( Device.FLD_lastIgnitionOnTime, Device.FLD_lastIgnitionOffTime); didUpdate = true; } catch (DBException dbe) { didUpdate = false; } } if (!didUpdate) { this.addOtherChangedFieldNames( Device.FLD_lastIgnitionOnTime, Device.FLD_lastIgnitionOffTime); } } } catch (DBException dbe) { this.cacheIgnitionState = -1; } return this.cacheIgnitionState; } /* unknown */ this.cacheIgnitionState = -1; return this.cacheIgnitionState; } /** *** Returns the ignition state as-of the specified Event
*** -1 = unknown
*** 0 = off
*** 1 = on **/ public int getIgnitionStateAsOfEvent(EventData ev) { boolean checkSC = RTConfig.getBoolean(DBConfig.PROP_Device_checkLastEventIgnitionState,CHECK_LAST_EVENT_IGNITION); return this.getIgnitionStateAsOfEvent(ev, checkSC); } /** *** Returns the ignition state as-of the specified Event
*** -1 = unknown
*** 0 = off
*** 1 = on **/ public int getIgnitionStateAsOfEvent(EventData ev, boolean checkSC) { /* not event? */ if (ev == null) { // event is null return this.getCurrentIgnitionState(); } /* get ignition state index */ int ignNdx = this.getIgnitionIndex(); if (ignNdx < 0) { // no ignition bit specified return -1; } /* check inputMask if we are not checking a specific status code */ if (ignNdx < StatusCodes.IGNITION_INPUT_INDEX) { long mask = ev.getInputMask(); DCServerConfig dcs = this.getDCServerConfig(); if (dcs != null) { return dcs.getDigitalInputState(mask, ignNdx)? 1 : 0; } else { return ((mask & (1L << ignNdx)) != 0L)? 1 : 0; } } /* check for status code based ignition definition? */ int ignSC[] = this.getIgnitionStatusCodes(); if (ignSC == null) { // no status code definition return -1; } /* check event for matching status code */ if (ev.getStatusCode() == ignSC[0]) { return 0; // ignition explicitly off } else if (ev.getStatusCode() == ignSC[1]) { return 1; // ignition explicitly on } /* look for StatusCodes.IGNITION_[ON|OFF]? */ if (checkSC) { try { EventData priorEV = this.getLastEvent(ignSC, ev.getTimestamp(), false); if (priorEV != null) { return (priorEV.getStatusCode() == ignSC[1])? 1 : 0; } } catch (DBException dbe) { // ignore } } /* unknown */ return -1; } /** *** Returns the ignition state change of the specified Event
*** -1 = no change
*** 0 = changed to off
*** 1 = changed to on **/ public int getEventIgnitionState(EventData ev) { /* no event? */ if (ev == null) { // event is null return -1; } /* ignition state vars */ int ignNdx = this.getIgnitionIndex(); if (ignNdx < 0) { // no defined ignition indicator return -1; } /* ignition status code */ if (ignNdx >= StatusCodes.IGNITION_INPUT_INDEX) { int evSC = ev.getStatusCode(); int ignSC[] = this.getIgnitionStatusCodes(); if (ignSC == null) { return -1; // unknown } else if (evSC == ignSC[0]) { return 0; // ignition off } else if (evSC == ignSC[1]) { return 1; // ignition on } else { return -1; // unknown (or no change) } } /* check input mask state change */ boolean lastIgnState = this.getLastInputState(ignNdx); boolean evntIgnState = ev.getInputMaskBitState(ignNdx); if (lastIgnState == evntIgnState) { // no change return -1; } else if (evntIgnState) { // (lastIgnState == false) && (evntIgnState == true) return 1; // ignition on } else { // (lastIgnState == true) && (evntIgnState == false) return 0; // ignition off } } /** *** Returns the ignition state based on the specified digital input mask. *** Returns false if this device ignition state is based on Ignition On/Off status codes *** @param gpioInput The digital input mask *** @return True if the ignition bit index is on, false otherwise. **/ public boolean getDigitalInputIgnitionState(long gpioInput) { /* no input mask? */ if (gpioInput < 0L) { // no digital input value return false; } /* get digital input bit index */ int bitNdx = this.getIgnitionIndex(); if ((bitNdx < 0) || (bitNdx > 63)) { // invalid bit index return false; } /* return ignition state */ return ((gpioInput & (1L << bitNdx)) != 0)? true : false; } // ------------------------------------------------------------------------ /** *** Gets the code/firmware version of this Device *** @return the code/firmware version of this Device **/ public String getCodeVersion() { String v = (String)this.getFieldValue(FLD_codeVersion); return StringTools.trim(v); } /** *** Sets the code/firmware version of this Device *** @param v the code/firmware version of this Device **/ public void setCodeVersion(String v) { this.setFieldValue(FLD_codeVersion, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the feature set of this Device *** @return the feature set of this Device **/ public String getFeatureSet() { String v = (String)this.getFieldValue(FLD_featureSet); return StringTools.trim(v); } /** *** Sets the feature set of this Device *** @param v The feature set of this Device **/ public void setFeatureSet(String v) { this.setFieldValue(FLD_featureSet, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the valid assigned IP address/mask for this Device
*** (used for validating incoming IP addresses used by this Device) *** @return The valid assigned IP address/mask for this Device **/ public DTIPAddrList getIpAddressValid() { DTIPAddrList v = (DTIPAddrList)this.getFieldValue(FLD_ipAddressValid); return v; // May return null!! } /** *** Sets the valid assigned IP address/mask for this Device
*** (used for validating incoming IP addresses used by this Device) *** @param v The valid assigned IP address/mask for this Device **/ public void setIpAddressValid(DTIPAddrList v) { this.setFieldValue(FLD_ipAddressValid, v); } /** *** Sets the valid assigned IP address/mask for this Device
*** (used for validating incoming IP addresses used by this Device) *** @param v The valid assigned IP address/mask for this Device **/ public void setIpAddressValid(String v) { this.setIpAddressValid((v != null)? new DTIPAddrList(v) : null); } /** *** Returns true if the specified IP address matches the IP address/mask *** assigned to this Device. *** (used for validating incoming IP addresses used by this Device) *** @param ipAddr The IP address the Device is currently using to send data to the server *** @return True if IP address matches **/ public boolean isValidIPAddress(String ipAddr) { DTIPAddrList ipList = this.getIpAddressValid(); if ((ipList == null) || ipList.isEmpty()) { return true; } else if (!ipList.isMatch(ipAddr)) { return false; } else { return true; } } // ------------------------------------------------------------------------ /** *** Returns true if this device has an assigned TCP session-id *** @return True if this device has an assigned TCP session-id **/ public boolean hasLastTcpSessionID() { return !StringTools.isBlank(this.getLastTcpSessionID()); } /** *** Gets the last TCP session ID *** @return The last TCP session ID **/ public String getLastTcpSessionID() { String v = (String)this.getFieldValue(FLD_lastTcpSessionID); return StringTools.trim(v); } /** *** Sets the last TCP session ID *** @param v The last TCP session ID **/ public void setLastTcpSessionID(String v) { this.setFieldValue(FLD_lastTcpSessionID, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the last known IP address used by the Device *** @return The last known IP address used by the Device **/ public DTIPAddress getIpAddressCurrent() { DTIPAddress v = (DTIPAddress)this.getFieldValue(FLD_ipAddressCurrent); return v; // May return null!! } /** *** Sets the last known IP address used by the Device *** @param v The last known IP address used by the Device **/ public void setIpAddressCurrent(DTIPAddress v) { this.setFieldValue(FLD_ipAddressCurrent, v); } /** *** Sets the last known IP address used by the Device *** @param v The last known IP address used by the Device **/ public void setIpAddressCurrent(String v) { this.setIpAddressCurrent((v != null)? new DTIPAddress(v) : null); } // ------------------------------------------------------------------------ /** *** Gets the last known remote port used by the Device *** @return The last known remote port used by the Device **/ public int getRemotePortCurrent() { Integer v = (Integer)this.getFieldValue(FLD_remotePortCurrent); return (v != null)? v.intValue() : 0; } /** *** Sets the last known remote port used by the Device *** @param v The last known remote port used by the Device **/ public void setRemotePortCurrent(int v) { this.setFieldValue(FLD_remotePortCurrent, ((v > 0)? v : 0)); } // ------------------------------------------------------------------------ /** *** Gets the last known listen port used by the Device *** @return The last known listen port used by the Device **/ public int getListenPortCurrent() { Integer v = (Integer)this.getFieldValue(FLD_listenPortCurrent); return (v != null)? v.intValue() : 0; } /** *** Sets the last known listen port used by the Device *** @param v The last known listen port used by the Device **/ public void setListenPortCurrent(int v) { this.setFieldValue(FLD_listenPortCurrent, ((v > 0)? v : 0)); } // ------------------------------------------------------------------------ /** *** Gets the last known valid latitude for this Device *** @return The last known valid latitude for this Device **/ public double getLastValidLatitude() { return this.getOptionalFieldValue(FLD_lastValidLatitude, 0.0); } /** *** Gets the last known valid latitude for this Device *** @param v The last known valid latitude for this Device **/ public void setLastValidLatitude(double v) { this.setOptionalFieldValue(FLD_lastValidLatitude, v); } /** *** Gets the last known valid longitude for this Device *** @return The last known valid longitude for this Device **/ public double getLastValidLongitude() { return this.getOptionalFieldValue(FLD_lastValidLongitude, 0.0); } /** *** Sets the last known valid longitude for this Device *** @param v The last known valid longitude for this Device **/ public void setLastValidLongitude(double v) { this.setOptionalFieldValue(FLD_lastValidLongitude, v); } /** *** Gets the last known valid GeoPoint for this Device *** @return The last known valid GeoPoint for this Device **/ public GeoPoint getLastValidLocation() { // returns null if invalid double lat = this.getLastValidLatitude(); double lon = this.getLastValidLongitude(); return GeoPoint.isValid(lat,lon)? new GeoPoint(lat,lon) : null; } /** *** Gets the last known valid GeoPoint for this Device *** @param tryLastEvent If true, the last valid EventData record may be queried *** @return The last known valid GeoPoint for this Device **/ public GeoPoint getLastValidLocation(boolean tryLastEvent) { GeoPoint gp = this.getLastValidLocation(); if ((gp == null) && tryLastEvent) { try { EventData lastEv = this.getLastEvent(true); // valid GPS only if ((lastEv != null) && lastEv.isValidGeoPoint()) { gp = lastEv.getGeoPoint(); this.setLastValidLocation( lastEv.getTimestamp(), // FLD_lastGPSTimestamp lastEv.getGeoPoint(), // FLD_lastValidLatitude/FLD_lastValidLongitude lastEv.getHeading()); // FLD_lastValidHeading if (this.getLastOdometerKM() <= 0.0) { double odomKM = lastEv.getOdometerKM(); this.setLastOdometerKM(odomKM); // may still be '0.0' } } } catch (DBException dbe) { // ignore error } } return gp; } /** *** Sets the last known valid location for this Device *** @param timestamp The time of the location *** @param gp The GeoPoint location *** @param heading The direction of travel **/ private void setLastValidLocation(long timestamp, GeoPoint gp, double heading) { if ((gp != null) && gp.isValid()) { this.setLastGPSTimestamp(timestamp); // FLD_lastGPSTimestamp this.setLastValidLatitude(gp.getLatitude()); // FLD_lastValidLatitude this.setLastValidLongitude(gp.getLongitude()); // FLD_lastValidLongitude if (heading >= 0.0) { this.setLastValidHeading(heading); // FLD_lastValidHeading } } else { this.setLastGPSTimestamp(0L); // FLD_lastGPSTimestamp this.setLastValidLatitude(0.0); // FLD_lastValidLatitude this.setLastValidLongitude(0.0); // FLD_lastValidLongitude this.setLastValidHeading(0.0); // FLD_lastValidHeading } } /** *** Calculates and returns the number of meters from the last valid GPS location *** to the specified GeoPoint. *** @param gp The GeoPoint to test *** @return The number of meters to the specified GeoPoint **/ public double getMetersToLastValidLocation(GeoPoint gp) { if (GeoPoint.isValid(gp)) { GeoPoint lastValidLoc = this.getLastValidLocation(true); if (lastValidLoc != null) { return gp.metersToPoint(lastValidLoc); } } return -1.0; } /** *** Returns true if the last know location of this device is is within the specified *** number of meters to the specified GeoPoint. *** @param gp The GeoPoint to test *** @param meters The radius to test, in meters **/ public boolean isNearLastValidLocation(GeoPoint gp, double meters) { if (meters > 0.0) { double deltaM = this.getMetersToLastValidLocation(gp); // '-1' if 'gp' is invalid return ((deltaM >= 0.0) && (deltaM < meters)); // false if gp is invalid } else { return false; } } // ------------------------------------------------------------------------ /** *** Returns the last valid street address, based on the last know location *** (not currently supported) *** @return The last valid street address **/ public String getLastValidAddress() { return ""; // not yet supported } // ------------------------------------------------------------------------ /** *** Gets the last valid heading *** @return The last valid heading **/ public double getLastValidHeading() { return this.getOptionalFieldValue(FLD_lastValidHeading, 0.0); } /** *** Sets the last valid heading *** @param v The last valid heading **/ public void setLastValidHeading(double v) { this.setOptionalFieldValue(FLD_lastValidHeading, v); } // ------------------------------------------------------------------------ /** *** Gets the last valid GPS timestamp *** @return The last valid GPS timestamp **/ public long getLastGPSTimestamp() { Long v = (Long)this.getFieldValue(FLD_lastGPSTimestamp); return (v != null)? v.longValue() : 0L; } /** *** Sets the last valid GPS timestamp *** @param v The last valid GPS timestamp **/ public void setLastGPSTimestamp(long v) { this.setFieldValue(FLD_lastGPSTimestamp, v); } // ------------------------------------------------------------------------ /** *** Gets the last event timestamp *** @return The last event timestamp **/ public long getLastEventTimestamp() { Long v = (Long)this.getFieldValue(FLD_lastEventTimestamp); return (v != null)? v.longValue() : 0L; } /** *** Sets the last event timestamp *** @param v The last event timestamp **/ public void setLastEventTimestamp(long v) { this.setFieldValue(FLD_lastEventTimestamp, v); } /** *** Returns true if the specified timestamp is prior to the last received event timestamp *** @param timestamp The timestamp to check *** @return True if the timestamp is prior to the last received event timestamp **/ public boolean isOldEventTimestamp(long timestamp) { if (timestamp <= 0L) { // invalid timestamp return true; } else if (timestamp < this.getLastGPSTimestamp()) { // prior to last valid GPS timestamp return true; } else if (timestamp < this.getLastEventTimestamp()) { // prior to last event timestamp return true; } else { return false; } } // ------------------------------------------------------------------------ /** *** Returns true if EventsPerSecond is supported/enabled **/ public static boolean supportsEventsPerSecond() { return Device.getFactory().hasField(FLD_lastEventsPerSecond); } /** *** Gets the last estimated events-per-second *** @return The last estimated events-per-second **/ public double getLastEventsPerSecond() { Double v = (Double)this.getOptionalFieldValue(FLD_lastEventsPerSecond); return (v != null)? v.doubleValue() : 0.0; } /** *** Sets the last estimated events-per-second *** @param v The last estimated events-per-second **/ public void setLastEventsPerSecond(double v) { this.setOptionalFieldValue(FLD_lastEventsPerSecond, v); } /** *** Gets the aged estimated events-per-second *** @param ageMS Aged timestamp *** @return The aged estimated events-per-second **/ public double getAgedEventsPerSecond(long ageMS) { Device.initEventsPerSecond(); long epst = this.getLastEventsPerSecondMS(); double epms = this.getLastEventsPerSecond() / 1000.0; double deltaVal = (double)(ageMS - epst); // deltaMS if (deltaVal > 0.0) { double AGE_A = Math.pow(1.0 - Device.EPS_ALPHA, deltaVal); // age old value epms = AGE_A * epms; } return epms * 1000.0; } /** *** Gets the last event-per-second timestamp (milliseconds) *** @return The last event-per-second timestamp (milliseconds) **/ public long getLastEventsPerSecondMS() { Long v = (Long)this.getOptionalFieldValue(FLD_lastEventsPerSecondMS); return (v != null)? v.longValue() : 0L; } /** *** Sets the last event-per-second timestamp (milliseconds) *** @param v The last event-per-second timestamp (milliseconds) **/ public void setLastEventsPerSecondMS(long v) { this.setOptionalFieldValue(FLD_lastEventsPerSecondMS, v); } /** *** Counts event "lastEventPerSecond" field. **/ private void _countEventsPerSecond() { /* not supported? */ if (!Device.supportsEventsPerSecond()) { // not supported, don't bother counting ... return; } /* init (synchronized) */ Device.initEventsPerSecond(); /* get last EPS */ long nowTimeMS = System.currentTimeMillis(); long lastEvTimeMS = this.getLastEventsPerSecondMS(); double epsLastEPS = this.getLastEventsPerSecond(); double deltaMS = (double)(nowTimeMS - lastEvTimeMS); double deltaSec = deltaMS / 1000.0; double deltaVal = deltaMS; /* calculate new EPS */ double newVal = 0.0; try { double thisVal = 1.0; double agedVal = epsLastEPS / 1000.0; // epsLastValue; if (deltaVal > 0.0) { // count last 'deltaMS' intervals as '0' values double AGE_A = Math.pow(1.0 - EPS_ALPHA, deltaVal); // age old value agedVal = AGE_A * agedVal; } newVal = (EPS_ALPHA * thisVal) + agedVal; } catch (Throwable th) { // unlikely newVal = 0.0; } /* set new EPS */ this.setLastEventsPerSecond(newVal * 1000.0); this.setLastEventsPerSecondMS(nowTimeMS); this.addOtherChangedFieldNames(FLD_lastEventsPerSecond, FLD_lastEventsPerSecondMS); } // ------------------------------------------------------------------------ /** *** Gets the last received serving cell-tower information *** @return The last received serving cell-tower information **/ public String getLastCellServingInfo() { String v = (String)this.getFieldValue(FLD_lastCellServingInfo); return StringTools.trim(v); } /** *** Sets the last received serving cell-tower information *** @param v The last received serving cell-tower information **/ public void setLastCellServingInfo(String v) { this.setFieldValue(FLD_lastCellServingInfo, StringTools.trim(v)); } /** *** Sets the last received serving cell-tower information *** @param sct The last received serving cell-tower information **/ public void setLastServingCellTower(CellTower sct) { if (sct != null) { this.setLastCellServingInfo(sct.toString()); } else { this.setLastCellServingInfo(null); } } /** *** Gets the last received serving cell-tower information *** @return The last received serving cell-tower information **/ public CellTower getLastServingCellTower() { String csi = this.getLastCellServingInfo(); if (!StringTools.isBlank(csi)) { return new CellTower(csi); } else { return null; } } // ------------------------------------------------------------------------ private static final Integer GEOZONE_ARRIVE = new Integer(StatusCodes.STATUS_GEOFENCE_ARRIVE); private static final Integer GEOZONE_DEPART = new Integer(StatusCodes.STATUS_GEOFENCE_DEPART); private static final Integer CORRIDOR_ENABLE = new Integer(StatusCodes.STATUS_CORRIDOR_ACTIVE); private static final Integer CORRIDOR_DISABLE = new Integer(StatusCodes.STATUS_CORRIDOR_INACTIVE); /** *** Geozone transition container for providing arrive/depart events **/ public static class GeozoneTransition { private long time = 0L; private Integer code = null; private Geozone zone = null; public GeozoneTransition(long timestamp, Integer code, Geozone zone) { this.time = timestamp; this.code = code; this.zone = zone; } public long getTimestamp() { return this.time; } public int getStatusCode() { return this.code.intValue(); } public Geozone getGeozone() { return this.zone; } public String getGeozoneID() { return this.zone.getGeozoneID(); } public String getGeozoneDescription() { return this.zone.getDescription(); } public String toString() { StringBuffer sb = new StringBuffer(); sb.append("[").append(StatusCodes.GetDescription(this.code,null)).append("] "); sb.append(this.getGeozoneID()).append(" - "); sb.append(this.getGeozoneDescription()); return sb.toString(); } } /** *** Checks the new event time and GeoPoint to calculate and returns a set of *** Geozone arrive/depart events, which should be inserted into the EventData table. *** If no Geozone transition occurred, then this method returns null. *** @param eventTime The tie of the event *** @param eventGP The new event location *** @return A list of Geozone transitions, or null if no transition occurred. **/ public java.util.List checkGeozoneTransitions(long eventTime, GeoPoint eventGP) { /* invalid point? */ if (!GeoPoint.isValid(eventGP)) { return null; } /* invalid timestamp? */ if (eventTime < 2L) { return null; } /* ignore event if older than last received event */ if (this.isOldEventTimestamp(eventTime)) { // [2.4.8-B25] //Print.logWarn("Geozone check: ignoring older event ..."); return null; } /* look for geozone transition */ String deviceID = this.getDeviceID(); String accountID = this.getAccountID(); GeoPoint prevGP = this.getLastValidLocation(true); boolean GET_GEOZONE_FOR_DEVICE = true; // [2.4.9-B15] /* get previous geozone */ Geozone prevZone = null; try { if (GET_GEOZONE_FOR_DEVICE) { // [2.4.9-B15] // returned Geozone is guaranteed to be applicable to the DeviceID prevZone = Geozone.getGeozoneForDevice(accountID, prevGP, deviceID); } else { // Note: This may fail for concentric Geozones with different group assignments. Geozone gz = Geozone.getGeozone(accountID, null/*zoneID*/, prevGP, false/*RGOnly*/); prevZone = ((gz != null) && gz.isDeviceInGroup(deviceID))? gz : null; } } catch (DBException dbe) { Print.logException("Geozone error (previous zone)", dbe); prevZone = null; } // "prevZone" is non-null iff it is applicable to the specified DeviceID, null otherwise /* get current geozone */ Geozone thisZone = null; try { if (GET_GEOZONE_FOR_DEVICE) { // [2.4.9-B15] // returned Geozone is guaranteed to be applicable to the DeviceID thisZone = Geozone.getGeozoneForDevice(accountID, eventGP, deviceID); } else { // Note: This may fail for concentric Geozones with different group assignments. Geozone gz = Geozone.getGeozone(accountID, null/*zoneID*/, eventGP, false/*RGOnly*/); thisZone = ((gz != null) && gz.isDeviceInGroup(deviceID))? gz : null; } } catch (DBException dbe) { Print.logException("Geozone error (current zone)", dbe); thisZone = null; } // "thisZone" is non-null iff it is applicable to the specified DeviceID, null otherwise /* GeozoneTransition list */ java.util.List geoTrans = null; /* depart only */ if ((prevZone != null) && (thisZone == null)) { String devID = null; // <-- We've already verified that this is DeviceID applicable above boolean isDepart = prevZone.isDepartureZone(devID); if (isDepart) { geoTrans = new Vector(); geoTrans.add(new GeozoneTransition(eventTime - 2L, GEOZONE_DEPART, prevZone)); } return geoTrans; } /* arrive only */ if ((prevZone == null) && (thisZone != null)) { String devID = null; // <-- We've already verified that this is DeviceID applicable above boolean isArrive = thisZone.isArrivalZone(devID); if (isArrive) { geoTrans = new Vector(); geoTrans.add(new GeozoneTransition(eventTime - 1L, GEOZONE_ARRIVE, thisZone)); } return geoTrans; } /* depart, then arrive */ if ((prevZone != null) && (thisZone != null) && !prevZone.getGeozoneID().equals(thisZone.getGeozoneID())) { String devID = null; // <-- We've already verified that this is DeviceID applicable above boolean isDepart = prevZone.isDepartureZone(devID); boolean isArrive = thisZone.isArrivalZone(devID); if (isDepart || isArrive) { geoTrans = new Vector(); if (isDepart) { geoTrans.add(new GeozoneTransition(eventTime - 2L, GEOZONE_DEPART, prevZone)); } if (isArrive) { geoTrans.add(new GeozoneTransition(eventTime - 1L, GEOZONE_ARRIVE, thisZone)); } } return geoTrans; } return null; } // ------------------------------------------------------------------------ /** *** Gets the last distance value *** @return The last distance value **/ public double getLastDistanceKM() { return this.getOptionalFieldValue(FLD_lastDistanceKM, 0.0); } /** *** Sets the last distance value *** @param distKM The last distance value **/ public void setLastDistanceKM(double distKM) { if (distKM < this.getMaxOdometerKM()) { this.setOptionalFieldValue(FLD_lastDistanceKM, distKM); } } // ------------------------------------------------------------------------ /** *** Gets the maximum allowed odometer value *** @return The maximum allowed odometer value **/ public double getMaxOdometerKM() { // TODO: should be device dependent return Device.GetMaximumOdometerKM(); } /** *** Returns true if the Device record supports the last odometer fields *** @return True if the Device record supports the last odometer fields **/ public static boolean supportsLastOdometer() { // now always true return Device.getFactory().hasField(FLD_lastOdometerKM); } /** *** Gets the last odometer value *** @return The last odometer value **/ public double getLastOdometerKM() { return this.getOptionalFieldValue(FLD_lastOdometerKM, 0.0); } /* public double getLastOdometerKM(boolean tryLastEvent) { double odomKM = this.getLastOdometerKM(); if (odomKM > 0.0) { return odomKM; } else if (tryLastEvent) { try { EventData lastEv = this.getLastEvent(true); if ((lastEv != null) && lastEv.isValidGeoPoint()) { odomKM = lastEv.getOdometerKM(); // may be 0 this.setLastOdometerKM(odomKM); // FLD_lastOdometerKM if (this.getLastValidLocation() == null) { this.setLastValidLocation( lastEv.getTimestamp(), // FLD_lastGPSTimestamp lastEv.getGeoPoint(), // FLD_lastValidLatitude/FLD_lastValidLongitude lastEv.getHeading()); // FLD_lastValidHeading this.setLastGPSTimestamp(); } return odomKM; } else { return 0.0; } } catch (DBException dbe) { // ignore error return 0.0; } } else { return 0.0; } } */ /** *** Sets the last odometer value *** @param odomKM The last odometer value **/ public void setLastOdometerKM(double odomKM) { if (odomKM < this.getMaxOdometerKM()) { this.setOptionalFieldValue(FLD_lastOdometerKM, odomKM); } } /** *** Calculates the next odometer value based on the specified GeoPoint *** @param geoPoint The next GPS location *** @return The last odometer, plus the distance to the specified GeoPoint **/ public double getNextOdometerKM(GeoPoint geoPoint) { GeoPoint lastValidLoc = this.getLastValidLocation(true); // try last event double odomKM = this.getLastOdometerKM(); // only try cached value if (GeoPoint.isValid(geoPoint) && (lastValidLoc != null)) { odomKM += geoPoint.kilometersToPoint(lastValidLoc); } return odomKM; } /** *** Adjusts the specified odometer value to the maximum allow value *** @param odomKM The odometer value to adjust *** @return The adjusted odometer value **/ public double adjustOdometerKM(double odomKM) { return this.adjustOdometerKM(odomKM, Device.GetCheckLastOdometer()); } /** *** Adjusts the specified odometer value to the maximum allow value *** @param odomKM The odometer value to adjust *** @return The adjusted odometer value **/ public double adjustOdometerKM(double odomKM, boolean checkLast) { double lastOdomKM = this.getLastOdometerKM(); if (checkLast && (odomKM < lastOdomKM)) { return lastOdomKM; } else if (odomKM >= this.getMaxOdometerKM()) { return lastOdomKM; } else { return odomKM; } } /** *** Calculates an odometer value based on the specified attributes *** @param odomKM The odometer value from the device (or 0.0 if the device does not provide an odometer) *** @param fixtime The timestamp of the event *** @param validGPS The GPS fix state *** @param geoPoint The GPS location *** @param estimate True if the odometer is to be calculated based on the GPS location *** @param logInfo True to display the results via "Print.logInfo" *** @return The calculated odometer value **/ public double calculateOdometerKM(double odomKM, long fixtime, boolean validGPS, GeoPoint geoPoint, boolean estimate, boolean logInfo) { if (this.isOldEventTimestamp(fixtime)) { // old event, only allow odometer values from the device itself odomKM = estimate? 0.0 : // we cannot accurately calculate an odometer value this.adjustOdometerKM(odomKM); if (logInfo) { Print.logInfo("OdometerKM: " + odomKM + " (old event)"); } } else if ((odomKM <= 0.0) || estimate) { // current event and we need to calculate the odomenter odomKM = (estimate && validGPS)? this.getNextOdometerKM(geoPoint) : this.getLastOdometerKM(); if (logInfo) { Print.logInfo("OdometerKM: " + odomKM + " (estimated)"); } } else { // we already have an odometer value from the device odomKM = this.adjustOdometerKM(odomKM); if (logInfo) { Print.logInfo("OdometerKM: " + odomKM + " (actual)"); } } return odomKM; } // ------------------------------------------------------------------------ /** *** Gets the displayed odometer offset in kilometers. *** @return The displayed odometer offset in kilometers. **/ public double getOdometerOffsetKM() { return this.getOptionalFieldValue(FLD_odometerOffsetKM, 0.0); } /** *** Sets the displayed odometer offset in kilometers. *** @param v The displayed odometer offset in kilometers. **/ public void setOdometerOffsetKM(double v) { if (v < this.getMaxOdometerKM()) { this.setOptionalFieldValue(FLD_odometerOffsetKM, v); } } // ------------------------------------------------------------------------ /** *** Gets the last engine on time received *** @return The last engine on time received **/ public long getLastEngineOnTime() { Long v = (Long)this.getFieldValue(FLD_lastEngineOnTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last engine on time received *** @param v The last engine on time received **/ public void setLastEngineOnTime(long v) { this.setFieldValue(FLD_lastEngineOnTime, v); } /** *** Gets the last engine off time received *** @return The last engine off time received **/ public long getLastEngineOffTime() { Long v = (Long)this.getFieldValue(FLD_lastEngineOffTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last engine off time received *** @param v The last engine off time received **/ public void setLastEngineOffTime(long v) { this.setFieldValue(FLD_lastEngineOffTime, v); } /** *** Gets the maximum allowed engine-hours value *** @return The maximum allowed engine-hours value **/ public double getMaxRuntimeHours() { // TODO: should be device dependent return Device.GetMaximumRuntimeHours(); } /** *** Returns true if LastEngineHours is supported *** @return True if LastEngineHours is supported **/ public static boolean supportsLastEngineHours() { // alway true return Device.getFactory().hasField(FLD_lastEngineHours); } /** *** Gets the last engine-hours received *** @return The last engine-hours received **/ public double getLastEngineHours() { return this.getOptionalFieldValue(FLD_lastEngineHours, 0.0); } /** *** Sets the last engine-hours received *** @param v The last engine-hours received **/ public void setLastEngineHours(double v) { if (v < this.getMaxRuntimeHours()) { this.setOptionalFieldValue(FLD_lastEngineHours, v); } } // ------------------------------------------------------------------------ /** *** Gets the displayed engine-hours offset *** @return The displayed engine-hours offset **/ public double getEngineHoursOffset() { return this.getOptionalFieldValue(FLD_engineHoursOffset, 0.0); } /** *** Sets the displayed engine-hours offset *** @param v The displayed engine-hours offset **/ public void setEngineHoursOffset(double v) { this.setOptionalFieldValue(FLD_engineHoursOffset, v); } // ------------------------------------------------------------------------ /** *** Gets the last ignition on time received *** @return The last ignition on time received **/ public long getLastIgnitionOnTime() { Long v = (Long)this.getFieldValue(FLD_lastIgnitionOnTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last ignition on time received *** @param v The last ignition on time received **/ public void setLastIgnitionOnTime(long v) { this.setFieldValue(FLD_lastIgnitionOnTime, v); } /** *** Gets the last ignition off time received *** @return The last ignition off time received **/ public long getLastIgnitionOffTime() { Long v = (Long)this.getFieldValue(FLD_lastIgnitionOffTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last ignition off time received *** @param v The last ignition off time received **/ public void setLastIgnitionOffTime(long v) { this.setFieldValue(FLD_lastIgnitionOffTime, v); } /** *** Gets the last ignition hours received. *** @return The last ignition hours received **/ public double getLastIgnitionHours() { return this.getOptionalFieldValue(FLD_lastIgnitionHours, 0.0); } /** *** Sets the last ignition hours received. *** @param v The last ignition hours received **/ public void setLastIgnitionHours(double v) { this.setOptionalFieldValue(FLD_lastIgnitionHours, v); } // ------------------------------------------------------------------------ /** *** Gets the last stopped time received. *** @return The last stopped time received **/ public long getLastStopTime() { Long v = (Long)this.getFieldValue(FLD_lastStopTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last stopped time received. *** @param v The last stopped time received **/ public void setLastStopTime(long v) { this.setFieldValue(FLD_lastStopTime, v); } /** *** Returns true if the device is currently stopped, based on the start/stop *** configuration calculated as each event arrives. *** @return True if the device is currently stopped. **/ public boolean isStopped() { long stopTime = this.getLastStopTime(); // may be '0' if uninitialized if (stopTime <= 0L) { return false; } else { return (stopTime > this.getLastStartTime())? true : false; } } /** *** Gets the last Stop event *** @return The last Stop event **/ public EventData getLastStopEvent() { // last stopped timestamp long st = this.getLastStopTime(); if ((st <= 0L) || (st <= this.getLastStartTime())) { // not stopped return null; } // get event try { EventData ev[] = this.getRangeEvents( st, st, // timeStart, timeEnd null, // statusCodes[] false, // validGPS EventData.LimitType.FIRST, -1L); // limit if (ListTools.isEmpty(ev)) { Print.logWarn("Last stopped time event not found: " + st); return null; } else { for (EventData evt : ev) { if (evt.isStopEvent(true)) { return evt; } } Print.logWarn("LastStopEvent is not a stop-event! " + st); return null; } } catch (DBException dbe) { Print.logException("Getting last stop event", dbe); return null; } } // ------------------------------------------------------------------------ /** *** Gets the last Start time *** @return The last Start time **/ public long getLastStartTime() { Long v = (Long)this.getFieldValue(FLD_lastStartTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last Start time *** @param v The last Start time **/ public void setLastStartTime(long v) { this.setFieldValue(FLD_lastStartTime, v); } // ------------------------------------------------------------------------ /** *** Gets the last Malfuntion Indicator Lamp (MIL) state *** @return The last Malfuntion Indicator Lamp (MIL) state **/ public boolean getLastMalfunctionLamp() { Boolean v = (Boolean)this.getFieldValue(FLD_lastMalfunctionLamp); return (v != null)? v.booleanValue() : true; } /** *** Sets the last Malfuntion Indicator Lamp (MIL) state *** @param v The last Malfuntion Indicator Lamp (MIL) state **/ public void setLastMalfunctionLamp(boolean v) { this.setFieldValue(FLD_lastMalfunctionLamp, v); } // ------------------------------------------------------------------------ /** *** Returns true if Fault Codes are supported *** @return True if Fault Codes are supported **/ public static boolean supportsFaultCodes() { return Device.getFactory().hasField(Device.FLD_lastFaultCode) && EventData.getFactory().hasField(EventData.FLD_faultCode) ; } /** *** Gets the last fault codes *** @return The last fault codes **/ public String getLastFaultCode() { String v = (String)this.getFieldValue(FLD_lastFaultCode); return StringTools.trim(v); } /** *** Sets the last fault codes *** @param v The last fault codes **/ public void setLastFaultCode(String v) { String fc = StringTools.trim(v); if ((Device.LastFaultCodeColumnLength > 0) && (fc.length() >= Device.LastFaultCodeColumnLength) ) { // -1 so we are not so close to the edge of the cliff int newLen = Device.LastFaultCodeColumnLength - 1; fc = fc.substring(0, newLen).trim(); // Note: MySQL will refuse to insert the record if the data length // is greater than the table column length. } this.setFieldValue(FLD_lastFaultCode, fc); } /** *** Appends the specified fault code to the current list of fault codes *** @param v The fault code to add **/ public void appendLastFaultCode(String v) { String lastFCStr = this.getLastFaultCode(); if (StringTools.isBlank(lastFCStr)) { // this Device does not already have a fault code this.setLastFaultCode(v); } else { // append new fault codes to old RTProperties newFC = new RTProperties(v); RTProperties oldFC = new RTProperties(lastFCStr); if (DTOBDFault.IsOBDII(oldFC)) { String newDTC[] = StringTools.split(newFC.getString(DTOBDFault.PROP_DTC,""),','); String oldDTC[] = StringTools.split(oldFC.getString(DTOBDFault.PROP_DTC,""),','); boolean changed = false; for (String dtc : newDTC) { if (StringTools.isBlank(dtc)) { continue; } if (!ListTools.contains(oldDTC,dtc)) { oldDTC = ListTools.add(oldDTC,dtc); changed = true; } } if (changed) { oldFC.setString(DTOBDFault.PROP_DTC[0],StringTools.join(oldDTC,",")); this.setLastFaultCode(oldFC.toString()); } } else if (DTOBDFault.IsJ1708(oldFC)) { // TODO: append this.setLastFaultCode(v); } else if (DTOBDFault.IsJ1939(oldFC)) { // TODO: append this.setLastFaultCode(v); } else { // ??? } } } // ------------------------------------------------------------------------ /** *** (NOT FULLY IMPLEMENTED) Gets the Ping command URI/URL *** @return The Ping command URI/URL **/ public String getPingCommandURI() { String v = (String)this.getFieldValue(FLD_pingCommandURI); return StringTools.trim(v); } /** *** (NOT FULLY IMPLEMENTED) Sets the Ping command URI/URL *** @param v The Ping command URI/URL **/ public void setPingCommandURI(String v) { // valid options: // tcp://192.168.11.11:21500 // udp://192.168.11.11:31400 // sms://9165551212 // smtp://9165551212@example.com this.setFieldValue(FLD_pingCommandURI, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the currently pending commands which should be sent to the device *** @return Any pending device commands **/ public String getPendingPingCommand() { String v = (String)this.getFieldValue(FLD_pendingPingCommand); return StringTools.trim(v); } public String getPendingCommand() { return this.getPendingPingCommand(); } /** *** Sets the currently pending commands which should be sent to the device *** @param v Any pending device commands **/ public void setPendingPingCommand(String v) { this.setFieldValue(FLD_pendingPingCommand, StringTools.trim(v)); } public void setPendingCommand(String v) { this.setPendingPingCommand(v); } /** *** Returns true if this device contains any pending commands *** @return True if this device contains any pending commands **/ public boolean hasPendingPingCommand() { return !StringTools.isBlank(this.getPendingPingCommand()); } public boolean hasPendingCommand() { return this.hasPendingPingCommand(); } /** *** Clears the device pending commands *** @param update True to update the device record now *** @return True if the device record was successfully cleared and updated, false otherwise **/ public boolean clearPendingPingCommand(boolean update) { this.setPendingPingCommand(null); if (update) { try { this.update(Device.FLD_pendingPingCommand); return true; // successfully updated } catch (DBException dbe) { Print.logException("Unable to update Device.pendingPingCommand", dbe); return false; // failed to update } } else { return false; // update not requested } } public boolean clearPendingCommand(boolean update) { return this.clearPendingPingCommand(update); } // ------------------------------------------------------------------------ /** *** Gets the time of the last command sent to the device *** @return The time of the last command sent to the device **/ public long getLastPingTime() { Long v = (Long)this.getFieldValue(FLD_lastPingTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the time of the last command sent to the device *** @param v The time of the last command sent to the device **/ public void _setLastPingTime(long v) { this.setFieldValue(FLD_lastPingTime, v); } /** *** Sets the time of the last command sent to the device *** @param v The time of the last command sent to the device **/ public void setLastPingTime(long v) { this._setLastPingTime(v); if (this.transport != null) { this.transport._setLastPingTime(v); } } // ------------------------------------------------------------------------ /** *** Gets the total number of commands sent to the device, since last reset *** @return The total number of commands sent to the device, since last reset **/ public int getTotalPingCount() { Integer v = (Integer)this.getFieldValue(FLD_totalPingCount); return (v != null)? v.intValue() : 0; } /** *** Sets the total number of commands sent to the device, since last reset *** @param v The total number of commands sent to the device, since last reset **/ public void _setTotalPingCount(int v) { this.setFieldValue(FLD_totalPingCount, v); } /** *** Sets the total number of commands sent to the device, since last reset *** @param v The total number of commands sent to the device, since last reset **/ public void setTotalPingCount(int v) { this._setTotalPingCount(v); if (this.transport != null) { this.transport._setTotalPingCount(v); } } /** *** Increments the command count for this device *** @param pingTime The time of the command *** @param reload True to force a reload of the Device record prior to counting the command *** @param update True to update the Device after incrementing the count *** @return True if successfully incremented **/ public boolean incrementPingCount(long pingTime, boolean reload, boolean update) { /* refresh current value */ if (reload) { // in case another Device 'ping' has changed this value already this.reload(Device.FLD_totalPingCount); } /* increment ping count */ this.setTotalPingCount(this.getTotalPingCount() + 1); if (pingTime > 0L) { this.setLastPingTime(pingTime); } /* update Device record */ if (update) { try { this.update( // may throw DBException Device.FLD_lastPingTime, Device.FLD_totalPingCount); } catch (DBException dbe) { Print.logException("Unable to update 'ping' count", dbe); return false; } } /* update Account */ Account account = this.getAccount(); if (account != null) { account.incrementPingCount(pingTime, reload, update); } return true; } // ------------------------------------------------------------------------ /** *** Gets the maximum number of commands that can be sent to the device *** @return The maximum number of commands that can be sent to the device **/ public int getMaxPingCount() { Integer v = (Integer)this.getFieldValue(FLD_maxPingCount); return (v != null)? v.intValue() : 0; } /** *** Sets the maximum number of commands that can be sent to the device *** @param v The maximum number of commands that can be sent to the device **/ public void _setMaxPingCount(int v) { this.setFieldValue(FLD_maxPingCount, v); } /** *** Sets the maximum number of commands that can be sent to the device *** @param v The maximum number of commands that can be sent to the device **/ public void setMaxPingCount(int v) { this._setMaxPingCount(v); if (this.transport != null) { this.transport._setMaxPingCount(v); } } /** *** Returns true if the maximum number of commands sent to the server has *** been exceeded. *** @return True if the maximum number has been exceeded ***/ public boolean exceedsMaxPingCount() { /* check device */ { int totPings = this.getTotalPingCount(); int maxPings = this.getMaxPingCount(); if ((maxPings > 0) && (totPings >= maxPings)) { Print.logInfo("Device exceeded maximum allowed pings: %d >= %d", totPings, maxPings); return true; } } /* check account */ Account account = this.getAccount(); if (account != null) { int totPings = account.getTotalPingCount(); int maxPings = account.getMaxPingCount(); if ((maxPings > 0) && (totPings >= maxPings)) { Print.logInfo("Account exceeded maximum allowed pings: %d >= %d", totPings, maxPings); return true; } } /* not over limit */ return false; } // ------------------------------------------------------------------------ /** *** Gets the command state mask as set by commands sent to the device *** @return The command state mask **/ public long getCommandStateMask() { Long v = (Long)this.getFieldValue(FLD_commandStateMask); return (v != null)? v.longValue() : 0L; } /** *** Gets the state for the specified bit from the command state mask *** @param bit The command state bit index *** @return The state for the specified bit from the command state mask **/ public boolean getCommandStateMaskBit(int bit) { long v = this.getCommandStateMask(); return ((v & (1L << bit)) != 0L)? true : false; } /** *** Sets the command state mask as set by commands sent to the device *** @param v The command state mask **/ public void setCommandStateMask(long v) { this.setFieldValue(FLD_commandStateMask, v); this.addOtherChangedFieldNames(FLD_commandStateMask); } /** *** Sets the state for the specified bit from the command state mask *** @param mask The command state bit mask *** @param state The state for the specified bits in the command state mask **/ public void setCommandStateBit(int bit, boolean state) { if (bit >= 0) { this._setCommandStateMask((bit << 1L), state); } } /** *** Sets the state for the specified bit from the command state mask *** @param mask The command state bit mask *** @param state The state for the specified bits in the command state mask **/ private void _setCommandStateMask(long mask, boolean state) { long v = this.getCommandStateMask(); if (state) { v |= mask; // bits on } else { v &= ~mask; // bits off } this.setCommandStateMask(v); } // ------------------------------------------------------------------------ /** *** Returns true if an ACK is expected from the device *** @return True if an ACK is expected from the device **/ public boolean getExpectAck() { Boolean v = (Boolean)this.getFieldValue(FLD_expectAck); return (v != null)? v.booleanValue() : true; } /** *** Sets the expected ACK state *** @param v The expected ACK state **/ public void _setExpectAck(boolean v) { this.setFieldValue(FLD_expectAck, v); this.addOtherChangedFieldNames(FLD_expectAck); } /** *** Sets the expected ACK state *** @param v The expected ACK state **/ public void setExpectAck(boolean v) { this._setExpectAck(v); if (this.transport != null) { this.transport._setExpectAck(v); } } // ------------------------------------------------------------------------ /** *** Gets the expected ACK status code, or '0' if any code should match *** @return The expected ACK status code **/ public int getExpectAckCode() { Integer v = (Integer)this.getFieldValue(FLD_expectAckCode); return (v != null)? v.intValue() : StatusCodes.STATUS_NONE; } /** *** Sets the expected ACK status code, or '0' if any code should match *** @param v The expected ACK status code **/ public void setExpectAckCode(int v) { this.setFieldValue(FLD_expectAckCode, ((v >= 0)? v : StatusCodes.STATUS_NONE)); this.addOtherChangedFieldNames(FLD_expectAckCode); } /** *** Returns true if the device is expecting an ACK and the specified status *** code matched the expected ACK status code. *** @param statusCode The current event status code *** @return True if statusCode matched expected ACK status code **/ public boolean isAckStatusCode(int statusCode) { /* invalid status code */ if (statusCode <= 0) { // invalid status code specification return false; } /* device is not expecting an ACK */ if (!this.isExpectingCommandAck()) { // device is not expecting an ACK return false; } /* check device ackCode */ int ackCode = this.getExpectAckCode(); if (ackCode <= 0) { // any status code specified an ACK return true; } /* check specific code */ // true if codes match return (statusCode == ackCode)? true : false; } // ------------------------------------------------------------------------ /** *** Gets the last ACK command sent to the device (if supported) *** @return The last ACK command sent to the device **/ public String getLastAckCommand() { String v = (String)this.getFieldValue(FLD_lastAckCommand); return StringTools.trim(v); } /** *** Sets the last ACK command sent to the device *** @param v The last ACK command sent to the device **/ public void setLastAckCommand(String v) { this.setFieldValue(FLD_lastAckCommand, StringTools.trim(v)); } /** *** Returns true if an ACK is expected from the device *** @return True if an ACK is expected from the device **/ public boolean isExpectingCommandAck() { return this.getExpectAck() && (this.getLastAckTime() <= 0L); } /** *** Clears the expect ACK state for the specified command *** @param didAck True if the ACK was received *** @param update True to update the Device record *** @return True if cleared **/ public boolean clearExpectCommandAck(boolean didAck, boolean update) { /* not expecting an ACK? */ if (!this.isExpectingCommandAck()) { Print.logInfo("Device is not expecting an ACK"); return false; } /* clear ACK fields */ String lastAckCmd = this.getLastAckCommand(); this.setExpectAck(false); this.setExpectAckCode(StatusCodes.STATUS_NONE); //this.setLastAckCommand(""); //this.setLastAckResponse(""); if (didAck) { this.setLastAckTime(DateTime.getCurrentTimeSec()); Print.logInfo("ACK received for command: " + lastAckCmd); } else { this.setLastAckTime(0L); } /* clear ACK command */ if (update) { try { this.update( Device.FLD_expectAck, Device.FLD_expectAckCode, Device.FLD_lastAckTime ); return true; } catch (DBException dbe) { Print.logException("Unable to set Device.lastAck...", dbe); return false; } } else { this.addOtherChangedFieldNames( Device.FLD_expectAck, Device.FLD_expectAckCode, Device.FLD_lastAckTime ); return true; } } // ------------------------------------------------------------------------ /** *** Gets the last ACK response (if supported) *** @return The last ACK response **/ public String getLastAckResponse() { String v = (String)this.getFieldValue(FLD_lastAckResponse); return StringTools.trim(v); } /** *** Sets the last ACK response *** @param v The last ACK response **/ public void setLastAckResponse(String v) { this.setFieldValue(FLD_lastAckResponse, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the last ACK time (if supported) *** @return The last ACK time **/ public long getLastAckTime() { Long v = (Long)this.getFieldValue(FLD_lastAckTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last ACK time (if supported) *** @param v The last ACK time **/ public void _setLastAckTime(long v) { this.setFieldValue(FLD_lastAckTime, v); this.addOtherChangedFieldNames(FLD_lastAckTime); } /** *** Sets the last ACK time (if supported) *** @param v The last ACK time **/ public void setLastAckTime(long v) { this._setLastAckTime(v); if (this.transport != null) { this.transport._setLastAckTime(v); } } // ------------------------------------------------------------------------ /** *** Gets the DCS configuration mask (usage defined by specific DCS) *** @return The DCS configuration mask **/ public long getDcsConfigMask() { Long v = (Long)this.getOptionalFieldValue(FLD_dcsConfigMask); return (v != null)? v.longValue() : 0L; } /** *** Sets the DCS configuration mask (usage defined by specific DCS) *** @param v The DCS configuration mask **/ public void setDcsConfigMask(long v) { this.setOptionalFieldValue(FLD_dcsConfigMask, v); } /** *** Gets the DCS configuration String (usage defined by specific DCS) *** @return The DCS configuration String **/ public String getDcsConfigString() { String v = (String)this.getOptionalFieldValue(FLD_dcsConfigString); return StringTools.trim(v); } /** *** Sets the DCS configuration String (usage defined by specific DCS) *** @param v The DCS configuration String **/ public void setDcsConfigString(String v) { this.setOptionalFieldValue(FLD_dcsConfigString, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Returns true if this device supports the OpenDMTP protocol *** @return True if this device supports the OpenDMTP protocol **/ public boolean getSupportsDMTP() { Boolean v = (Boolean)this.getFieldValue(FLD_supportsDMTP); return (v != null)? v.booleanValue() : true; } /** *** OpenDMTP: Returns true if this device supports the OpenDMTP protocol *** @return True if this device supports the OpenDMTP protocol **/ public boolean supportsDMTP() { return this.getSupportsDMTP(); } /** *** OpenDMTP: Sets the OpenDMTP protocol support state *** @param v The OpenDMTP protocol support state **/ public void setSupportsDMTP(boolean v) { this.setFieldValue(FLD_supportsDMTP, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the supported OpenDMTP encodings *** @return The supported OpenDMTP encodings **/ public int getSupportedEncodings() { Integer v = (Integer)this.getFieldValue(FLD_supportedEncodings); return (v != null)? v.intValue() : (int)Encodings.BINARY.getLongValue(); } /** *** OpenDMTP: Sets the supported OpenDMTP encodings *** @param v The supported OpenDMTP encodings **/ public void setSupportedEncodings(int v) { v &= (int)EnumTools.getValueMask(Encodings.class); if (v == 0) { v = (int)Encodings.BINARY.getLongValue(); } this.setFieldValue(FLD_supportedEncodings, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the OpenDMTP unit limit interval *** @return The OpenDMTP unit limit interval **/ public int getUnitLimitInterval() // Minutes { Integer v = (Integer)this.getFieldValue(FLD_unitLimitInterval); return (v != null)? v.intValue() : 0; } /** *** OpenDMTP: Sets the OpenDMTP unit limit interval *** @param v The OpenDMTP unit limit interval **/ public void setUnitLimitInterval(int v) // Minutes { this.setFieldValue(FLD_unitLimitInterval, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the maximum allowed OpenDMTP events *** @return The maximum allowed OpenDMTP events **/ public int getMaxAllowedEvents() { Integer v = (Integer)this.getFieldValue(FLD_maxAllowedEvents); return (v != null)? v.intValue() : 1; } /** *** OpenDMTP: Sets the maximum allowed OpenDMTP events *** @param v The maximum allowed OpenDMTP events **/ public void setMaxAllowedEvents(int v) { this.setFieldValue(FLD_maxAllowedEvents, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the total (UDP/TCP) connection profile mask *** @return The total (UDP/TCP) connection profile mask **/ public DTProfileMask getTotalProfileMask() { DTProfileMask v = (DTProfileMask)this.getFieldValue(FLD_totalProfileMask); return v; } /** *** OpenDMTP: Sets the total (UDP/TCP) connection profile mask *** @param v The total (UDP/TCP) connection profile mask **/ public void setTotalProfileMask(DTProfileMask v) { this.setFieldValue(FLD_totalProfileMask, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the maximum total connections allowed per interval
*** Note: The effective maximum value for this field is defined by the following:
*** (org.opendmtp.server.base.ValidateConnections.BITS_PER_MINUTE_MASK * this.getUnitLimitIntervalMinutes()) *** @return The maximum total connections allowed per interval **/ public int getTotalMaxConn() { Integer v = (Integer)this.getFieldValue(FLD_totalMaxConn); return (v != null)? v.intValue() : 0; } /** *** OpenDMTP: Sets the maximum total connections allowed per interval *** @param v The maximum total connections allowed per interval **/ public void setTotalMaxConn(int v) { this.setFieldValue(FLD_totalMaxConn, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the maximum total connections allowed per minute
*** Note: The effective maximum value for this field is defined by the constant:
*** "org.opendmtp.server.base.ValidateConnections.BITS_PER_MINUTE_MASK" *** @return The maximum total connections allowed per minute **/ public int getTotalMaxConnPerMin() { Integer v = (Integer)this.getFieldValue(FLD_totalMaxConnPerMin); return (v != null)? v.intValue() : 0; } /** *** OpenDMTP: Sets the maximum total connections allowed per minute
*** @param v The maximum total connections allowed per minute **/ public void setTotalMaxConnPerMin(int v) { this.setFieldValue(FLD_totalMaxConnPerMin, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the Duplex/TCP connection profile mask *** @return The Duplex/TCP connection profile mask **/ public DTProfileMask getDuplexProfileMask() { DTProfileMask v = (DTProfileMask)this.getFieldValue(FLD_duplexProfileMask); return v; } /** *** OpenDMTP: Sets the Duplex/TCP connection profile mask *** @param v The Duplex/TCP connection profile mask **/ public void setDuplexProfileMask(DTProfileMask v) { this.setFieldValue(FLD_duplexProfileMask, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the maximum Duplex/TCP connections per Interval *** Note: The effective maximum value for this field is defined by the following: *** (org.opendmtp.server.base.ValidateConnections.BITS_PER_MINUTE_MASK * this.getUnitLimitIntervalMinutes()) *** @return The maximum Duplex/TCP connections per Interval **/ public int getDuplexMaxConn() { Integer v = (Integer)this.getFieldValue(FLD_duplexMaxConn); return (v != null)? v.intValue() : 0; } /** *** OpenDMTP: Sets the maximum Duplex/TCP connections per Interval *** @param v The maximum Duplex/TCP connections per Interval **/ public void setDuplexMaxConn(int v) { this.setFieldValue(FLD_duplexMaxConn, v); } // ------------------------------------------------------------------------ /** *** OpenDMTP: Gets the maximum Duplex/TCP connections per Minute *** Note: The effective maximum value for this field is defined by the constant: *** "org.opendmtp.server.base.ValidateConnections.BITS_PER_MINUTE_MASK" *** @return The maximum Duplex/TCP connections per Minute **/ public int getDuplexMaxConnPerMin() { Integer v = (Integer)this.getFieldValue(FLD_duplexMaxConnPerMin); return (v != null)? v.intValue() : 0; } /** *** OpenDMTP: Sets the maximum Duplex/TCP connections per Minute *** @param v The maximum Duplex/TCP connections per Minute **/ public void setDuplexMaxConnPerMin(int v) { this.setFieldValue(FLD_duplexMaxConnPerMin, v); } // ------------------------------------------------------------------------ /** *** Gets the last Duplex/TCP connection time *** @return The last Duplex/TCP connection time **/ public long getLastDuplexConnectTime() { Long v = (Long)this.getFieldValue(FLD_lastDuplexConnectTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last Duplex/TCP connection time *** @param v The last Duplex/TCP connection time **/ public void _setLastDuplexConnectTime(long v) { this.setFieldValue(FLD_lastDuplexConnectTime, v); } /** *** Sets the last Duplex/TCP connection time *** @param v The last Duplex/TCP connection time **/ public void setLastDuplexConnectTime(long v) { this._setLastDuplexConnectTime(v); if (this.transport != null) { this.transport._setLastDuplexConnectTime(v); } } // ------------------------------------------------------------------------ /** *** Gets the last UDP/TCP connection time *** @return The last UDP/TCP connection time **/ public long getLastTotalConnectTime() { Long v = (Long)this.getFieldValue(FLD_lastTotalConnectTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last UDP/TCP connection time *** @param v The last UDP/TCP connection time **/ public void _setLastTotalConnectTime(long v) { this.setFieldValue(FLD_lastTotalConnectTime, v); } /** *** Sets the last UDP/TCP connection time *** @param v The last UDP/TCP connection time **/ public void setLastTotalConnectTime(long v) { this._setLastTotalConnectTime(v); if (this.transport != null) { this.transport._setLastTotalConnectTime(v); } } /** *** Gets the last UDP/TCP connection time *** @return The last UDP/TCP connection time **/ public long getLastConnectTime() { return this.getLastTotalConnectTime(); } /** *** Sets the last UDP/TCP connection time *** @param v The last UDP/TCP connection time **/ public void setLastConnectTime(long v, boolean isDuplex) { this.setLastTotalConnectTime(v); if (isDuplex) { this.setLastDuplexConnectTime(v); } else { // Simplex? } } // ------------------------------------------------------------------------ /** *** Returns true if Fixed Locations are supported *** @return True if Fixed Locations are supported **/ public static boolean supportsFixedLocation() { return Device.getFactory().hasField(FLD_fixedLatitude); } /** *** Gets the fixed latitude for this device *** @return The fixed latitude for this device **/ public double getFixedLatitude() { return this.getOptionalFieldValue(FLD_fixedLatitude, 0.0); } /** *** Sets the fixed latitude for this device *** @param v The fixed latitude for this device **/ public void setFixedLatitude(double v) { this.setOptionalFieldValue(FLD_fixedLatitude, v); } /** *** Gets the fixed longitude for this device *** @return The fixed longitude for this device **/ public double getFixedLongitude() { return this.getOptionalFieldValue(FLD_fixedLongitude, 0.0); } /** *** Sets the fixed longitude for this device *** @param v The fixed longitude for this device **/ public void setFixedLongitude(double v) { this.setOptionalFieldValue(FLD_fixedLongitude, v); } /** *** Returns true if this device supports fixed locations *** @return True if this device supports fixed locations **/ public boolean hasFixedLocation() { // we assume FLD_fixedLongitude exists if FLD_fixedLatitude exists return this.hasField(FLD_fixedLatitude); // && this.isValidFixedLocation(); } /** *** Returns true if this device defines a valid fixed location *** @return True if this device defines a valid fixed location **/ public boolean isValidFixedLocation() { return GeoPoint.isValid(this.getFixedLatitude(), this.getFixedLongitude()); } /** *** Gets the fixed location for this device *** @return The fixed location for this device **/ public GeoPoint getFixedLocation() { return new GeoPoint(this.getFixedLatitude(), this.getFixedLongitude()); } // ------------------------------------------------------------------------ /** *** Gets the address for the fixed location for this device *** @return The address for the fixed location for this device **/ public String getFixedAddress() { String v = StringTools.trim((String)this.getFieldValue(FLD_fixedAddress)); return v; } /** *** Sets the address for the fixed location for this device *** @param v The address for the fixed location for this device **/ public void setFixedAddress(String v) { this.setFieldValue(FLD_fixedAddress, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the phone number for the fixed location for this device *** @return The phone number for the fixed location for this device **/ public String getFixedContactPhone() { String v = StringTools.trim((String)this.getFieldValue(FLD_fixedContactPhone)); return v; } /** *** Sets the phone number for the fixed location for this device *** @param v The phone number for the fixed location for this device **/ public void setFixedContactPhone(String v) { this.setFieldValue(FLD_fixedContactPhone, StringTools.trim(v)); } // ------------------------------------------------------------------------ /** *** Gets the last time this fixed location was serviced *** @return The last time this fixed location was serviced **/ public long getFixedServiceTime() { Long v = (Long)this.getOptionalFieldValue(FLD_fixedServiceTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last time this fixed location was serviced *** @param v The last time this fixed location was serviced **/ public void setFixedServiceTime(long v) { this.setOptionalFieldValue(FLD_fixedServiceTime, v); } // ------------------------------------------------------------------------ /** *** Returns true if active corridors are supported *** @return True if active corridors are supported **/ public static boolean supportsActiveCorridor() { return Device.getFactory().hasField(FLD_activeCorridor); } /** *** Gets the active corridor for this device *** @return The active corridor for this device **/ public String getActiveCorridor() { String v = (String)this.getOptionalFieldValue(FLD_activeCorridor); return StringTools.trim(v); } /** *** Returns true if this device has an active corridor *** @return True if this device has an active corridor **/ public boolean hasActiveCorridor() { return !StringTools.isBlank(this.getActiveCorridor()); } /** *** Sets the active corridor for this device *** @param v The active corridor for this device **/ public void setActiveCorridor(String v) { this.setOptionalFieldValue(FLD_activeCorridor, StringTools.trim(v)); } /** *** Gets a String array of all GeoCorridor ID for the specified account
*** (TODO: move to Account.java) *** @param acctId The Account ID *** @return String array of GeoCorridor IDs **/ public static String[] getCorridorIDsForAccount(String acctId) { /* GeoCorridor Class */ Class gcClass = null; try { gcClass = Class.forName(DBConfig.PACKAGE_RULE_TABLES_ + "GeoCorridor"); } catch (Throwable th) { // ClassNotFoundException return null; } /* Method action */ MethodAction gcListMeth = null; try { gcListMeth = new MethodAction(gcClass, "getCorridorIDsForAccount", String.class); } catch (Throwable th) { // NoSuchMethodException, ClassNotFoundException return null; } /* get list */ try { return (String[])gcListMeth.invoke(acctId); } catch (DBException dbe) { Print.logError("DBException: " + dbe); return null; } catch (Throwable th) { return null; } } // ------------------------------------------------------------------------ /** *** Returns true if Periodic Maintenance fields are supported *** @return True if Periodic Maintenance fields are supported **/ public static boolean supportsPeriodicMaintenance() { if (Device.getPeriodicMaintOdometerCount() <= 0) { return false; } else { return Device.getFactory().hasField(FLD_maintOdometerKM0); } } // --------------- private static int MAX_MAINT_ODOM_COUNT = 2; /** *** Gets the number of maintenance fields to support *** @return The number of maintenance fields to support **/ public static int getPeriodicMaintOdometerCount() { int mc = RTConfig.getInt(DBConfig.PROP_Device_maintenanceOdometerCount, MAX_MAINT_ODOM_COUNT); if (mc <= 0) { return 0; } else if (mc >= MAX_MAINT_ODOM_COUNT) { return MAX_MAINT_ODOM_COUNT; } else { return mc; } } /** *** Gets the last maintenance odometer for the specified index *** @param ndx The index of the maintenance odometer to return *** @return The maintenance odometer (in kilometers) **/ public double getMaintOdometerKM(int ndx) { switch (ndx) { case 0 : return this.getMaintOdometerKM0(); case 1 : return this.getMaintOdometerKM1(); default: return 0.0; } } /** *** Resets the last maintenance odometer for the specified index *** @param ndx The index of the maintenance odometer to reset **/ public void resetMaintOdometerKM(int ndx) { switch (ndx) { case 0 : this.resetMaintOdometerKM0(); break; case 1 : this.resetMaintOdometerKM1(); break; } } /** *** Gets the last maintenance interval for the specified index *** @param ndx The index of the maintenance interval to return *** @return The maintenance interval (in kilometers) **/ public double getMaintIntervalKM(int ndx) { switch (ndx) { case 0 : return this.getMaintIntervalKM0(); case 1 : return this.getMaintIntervalKM1(); default: return 0.0; } } /** *** Returns true if the maintenance interval is due for the specified index and *** specified number of delta kilometers. *** @param ndx The index of the maintenance interval *** @param deltaKM The delta-kilometers to check *** @return True if maintenance is due **/ public boolean isMaintenanceDueKM(int ndx, double deltaKM) { if (Device.supportsPeriodicMaintenance()) { double odomKM = this.getLastOdometerKM(); if (odomKM > 0.0) { double lastKM = this.getMaintOdometerKM(ndx); double intvKM = this.getMaintIntervalKM(ndx); if ((odomKM + deltaKM) >= (lastKM + intvKM)) { return true; } } } return false; } // --------------- /** *** Gets the maintenance interval for index #0 *** @return The maintenance interval #0, in kilometers **/ public double getMaintIntervalKM0() { return this.getOptionalFieldValue(FLD_maintIntervalKM0, 0.0); } /** *** Sets the maintenance interval for index #0 *** @param v The maintenance interval #0, in kilometers **/ public void setMaintIntervalKM0(double v) { this.setOptionalFieldValue(FLD_maintIntervalKM0, v); } /** *** Gets the maintenance odometer for index #0 *** @return The maintenance odometer #0, in kilometers **/ public double getMaintOdometerKM0() { return this.getOptionalFieldValue(FLD_maintOdometerKM0, 0.0); } /** *** Sets the maintenance odometer for index #0 *** @param v The maintenance odometer #0, in kilometers **/ public void setMaintOdometerKM0(double v) { if (v < this.getMaxOdometerKM()) { this.setOptionalFieldValue(FLD_maintOdometerKM0, ((v >= 0.0)? v : 0.0)); } } /** *** Resets the maintenance odometer for index #0 **/ public void resetMaintOdometerKM0() { this.setMaintOdometerKM0(this.getLastOdometerKM()); this.addOtherChangedFieldNames(Device.FLD_maintOdometerKM0); } // --------------- /** *** Gets the maintenance interval for index #1 *** @return The maintenance interval #1, in kilometers **/ public double getMaintIntervalKM1() { return this.getOptionalFieldValue(FLD_maintIntervalKM1, 0.0); } /** *** Sets the maintenance interval for index #1 *** @param v The maintenance interval #1, in kilometers **/ public void setMaintIntervalKM1(double v) { this.setOptionalFieldValue(FLD_maintIntervalKM1, v); } /** *** Gets the maintenance odometer for index #1 *** @return The maintenance odometer #1, in kilometers **/ public double getMaintOdometerKM1() { return this.getOptionalFieldValue(FLD_maintOdometerKM1, 0.0); } /** *** Sets the maintenance odometer for index #1 *** @param v The maintenance odometer #1, in kilometers **/ public void setMaintOdometerKM1(double v) { if (v < this.getMaxOdometerKM()) { this.setOptionalFieldValue(FLD_maintOdometerKM1, ((v >= 0.0)? v : 0.0)); } } /** *** Resets the maintenance odometer for index #1 **/ public void resetMaintOdometerKM1() { this.setMaintOdometerKM1(this.getLastOdometerKM()); this.addOtherChangedFieldNames(Device.FLD_maintOdometerKM0); } // --------------- /** *** Gets the number of supported maintenance engine-hour fields *** @return The number of supported maintenance engine-hour fields **/ public static int getPeriodicMaintEngHoursCount() { return 1; } /** *** Gets the Maintenance Engine Hours for the specified index *** @param ndx The maintenance engine-hours index *** @return The maintenance engine hours **/ public double getMaintEngHoursHR(int ndx) { switch (ndx) { case 0 : return this.getMaintEngHoursHR0(); default: return 0.0; } } /** *** Resets the maintenance engine hours for the specified index *** @param ndx The maintenance engine-hours index **/ public void resetMaintEngHoursHR(int ndx) { switch (ndx) { case 0 : this.resetMaintEngHoursHR0(); break; } } /** *** Gets the maintenance engine-hours interval for the specified index *** @param ndx The maintenance engine-hours index *** @return The maintenance engine-hours interval **/ public double getMaintIntervalHR(int ndx) { switch (ndx) { case 0 : return this.getMaintIntervalHR0(); default: return 0.0; } } /** *** Returns true if the maintenance engine hours for the specified index is due *** @param ndx The maintenance engine-hours index *** @param deltaHR The delta engine-hours to check **/ public boolean isMaintenanceDueHR(int ndx, double deltaHR) { if (Device.supportsPeriodicMaintenance()) { double engHrs = this.getLastEngineHours(); if (engHrs > 0.0) { double lastHR = this.getMaintEngHoursHR(ndx); double intvHR = this.getMaintIntervalHR(ndx); if ((engHrs + deltaHR) >= (lastHR + intvHR)) { return true; } } } return false; } // --------------- /** *** Gets the maintenance engine-hours interval for index #0 *** @return The maintenance engine-hours interval for index #0 **/ public double getMaintIntervalHR0() { return this.getOptionalFieldValue(FLD_maintIntervalHR0, 0.0); } /** *** Sets the maintenance engine-hours interval for index #0 *** @param v The maintenance engine-hours interval for index #0 **/ public void setMaintIntervalHR0(double v) { this.setOptionalFieldValue(FLD_maintIntervalHR0, v); } /** *** Gets the maintenance engine-hours elapsed for index #0 *** @return The maintenance engine-hours elapsed for index #0 **/ public double getMaintEngHoursHR0() { return this.getOptionalFieldValue(FLD_maintEngHoursHR0, 0.0); } /** *** Sets the maintenance engine-hours elapsed for index #0 *** @param v The maintenance engine-hours elapsed for index #0 **/ public void setMaintEngHoursHR0(double v) { if (v < this.getMaxRuntimeHours()) { this.setOptionalFieldValue(FLD_maintEngHoursHR0, ((v >= 0.0)? v : 0.0)); } } /** *** Resets the maintenance engine-hours for index #0 **/ public void resetMaintEngHoursHR0() { this.setMaintEngHoursHR0(this.getLastEngineHours()); this.addOtherChangedFieldNames(Device.FLD_maintEngHoursHR0); } // --------------- /** *** Gets the maintenance notes *** @return the maintenance notes **/ public String getMaintNotes() { String v = (String)this.getOptionalFieldValue(FLD_maintNotes); return StringTools.trim(v); } /** *** Sets the maintenance notes *** @param v the maintenance notes **/ public void setMaintNotes(String v) { this.setOptionalFieldValue(FLD_maintNotes, StringTools.trim(v)); } // ------------------------------------------------------------------------ // "Reminder" support (may require Event Notification Rules Engine) // With Cron and ENRE installed, configure as follows: // 1) Enable (in "config.conf") optional Device MaintOdometerFieldInfo fields // startupInit.Device.MaintOdometerFieldInfo=true // 2) Enable (in "config.conf") the "Reminder" fields on Device and Rule Admin: // Domain.Properties.deviceInfo.showReminderMessage=true // Domain.Properties.ruleInfo.showPredefinedActions=true // 3) Rebuild/Redeploy after making above config changes. Then update the table // columns to make sure that the Device table maintenance fields are created. // 4) Make sure "Cron" service is running // 5) Create a rule with following attributes: // Selector : $REMINDER // Is Cron Rule : Hourly // Trigger Action : EMail // Prefedined Actions: resetReminder // Email subj/body : ${reminderMessage} // The above rule will check the "$REMINDER" every hour. When "$REMINDER" // returns 'true', the email subj/body message will be sent. The "resetReminder" // predefined action will then reset the reminder for the next interval. // (Note: without the "resetReminder" predefined-action, the reminder notification // will continue to be sent every hour) // 6) Set "Reminder Interval" and "Reminder Message" values on the Device Admin // Acceptable values: // Date specification - "date:2012/12/25" // Month Abbreviation - "jan" // Day Abbreviation - "tue" // Periodic Interval - "12345" (in seconds) /** *** Gets the maintenance reminder type (currently always returns '0') *** @return the maintenance reminder type **/ public int getReminderType() { // FLD_reminderType column is not currently part of the Device record Integer v = (Integer)this.getOptionalFieldValue(FLD_reminderType); return (v != null)? v.intValue() : ReminderType.PERIODIC_INTERVAL.getIntValue(); } /** *** Sets the maintenance reminder type *** @param v the maintenance reminder type **/ public void setReminderType(int v) { this.setOptionalFieldValue(FLD_reminderType, v); } /** *** Sets the maintenance reminder type *** @param r the maintenance reminder type **/ public void setReminderType(ReminderType r) { int v = (r != null)? r.getIntValue() : ReminderType.PERIODIC_INTERVAL.getIntValue(); this.setReminderType(v); } // --------------- /** *** Gets the maintenance reminder message *** @return the maintenance reminder message **/ public String getReminderMessage() { String v = (String)this.getOptionalFieldValue(FLD_reminderMessage); return StringTools.trim(v); } /** *** Sets the maintenance reminder message *** @param v the maintenance reminder message **/ public void setReminderMessage(String v) { this.setOptionalFieldValue(FLD_reminderMessage, StringTools.trim(v)); } // --------------- /** *** Gets the maintenance reminder time *** @return the maintenance reminder time **/ public long getReminderTime() { Long v = (Long)this.getFieldValue(FLD_reminderTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the maintenance reminder time *** @param v the maintenance reminder time **/ public void setReminderTime(long v) { this.setFieldValue(FLD_reminderTime, v); } // --------------- /** *** Gets the maintenance reminder interval *** @return the maintenance reminder interval **/ public String getReminderInterval() { // Valid values: // <#ElapsedInterval>,date:,, String v = (String)this.getFieldValue(FLD_reminderInterval); return StringTools.trim(v); } /** *** Sets the maintenance reminder interval *** @param v the maintenance reminder interval **/ public void setReminderInterval(String v) { this.setFieldValue(FLD_reminderInterval, StringTools.trim(v).toLowerCase()); } // --------------- /** *** Returns true if the maintenance reminder has expired *** @param tz The TimeZone *** @param nowTime The current time *** @return True if expired **/ public boolean isReminderExpired(TimeZone tz, long nowTime) { int remType = this.getReminderType(); // 0=periodic, 1=single long remTime = this.getReminderTime(); // last reminder time String remIntStr = this.getReminderInterval(); // <#ElapsIntrv>,date:,, return Device._isReminderExpired( remType, remTime, remIntStr, tz, nowTime); } private static boolean REMINDER_LOG = RTConfig.getBoolean("device.debugReminder",false); /** *** Returns true if the maintenance reminder has expired *** @param remType The reminder type (currently unused) *** @param remTime The reminder time *** @param remIntStr The reminder interval string *** @param tz The TimeZone *** @param nowTime The current time *** @return True if expired **/ private static boolean _isReminderExpired( int remType, long remTime, String remIntStr, TimeZone tz, long nowTime) { /* invalid time specified? */ if (nowTime <= 0L) { if (REMINDER_LOG) { Print.logInfo("Invalid Reminder Now Time"); } return false; } /* reminder time/interval */ if (StringTools.isBlank(remIntStr)) { // no interval specified if (REMINDER_LOG) { Print.logInfo("No Reminder Interval Specified"); } return false; } /* extract reminder date components */ DateTime remDT = new DateTime(remTime, tz); int remDOW = remDT.getDayOfWeek(); int remMon0 = remDT.getMonth0(); int remYear = remDT.getYear(); /* extract now date components */ DateTime nowDT = new DateTime(nowTime, tz); int nowDOW = nowDT.getDayOfWeek(); int nowMon0 = nowDT.getMonth0(); int nowYear = nowDT.getYear(); /* loop through intervals */ // "12345,mon,tue,jan,feb,date:2012/05/24" String remInt[] = StringTools.split(remIntStr,','); for (int i = 0; i < remInt.length; i++) { String rem = remInt[i].toLowerCase(); /* skip blank entries */ if (StringTools.isBlank(rem)) { // skip this entry if (REMINDER_LOG) { Print.logInfo("Skipping blank Reminder Entry: " + i); } continue; } /* seconds elapsed */ if (StringTools.isLong(rem,true/*strict*/)) { // "12345" - (absolute) standard interval long interval = StringTools.parseLong(rem,0L); if (interval > 0L) { long nexTime = remTime + interval; if (nexTime <= nowTime) { if (REMINDER_LOG) { Print.logInfo("Interval Reminder Expired: " + rem); } return true; } else { //if (REMINDER_LOG) { Print.logInfo("Interval Reminder not expired: " + rem); } } } else { // invalid interval specification if (REMINDER_LOG) { Print.logWarn("Invalid Reminder Interval: " + rem); } } continue; } /* specific date */ // "date:2012/12/25", "2012/12/25|12:12:34" if (rem.startsWith("date:") || (rem.indexOf("/") > 0)) { String dateStr = rem.startsWith("date:")? rem.substring("date:".length()) : rem; try { DateTime dateDT = DateTime.parseArgumentDate(dateStr, tz); long dateTime = dateDT.getTimeSec(); if (dateTime <= remTime) { if (REMINDER_LOG) { Print.logInfo("Date Reminder Already Expired: " + rem); } } else if (dateTime <= nowTime) { if (REMINDER_LOG) { Print.logInfo("Date Reminder Expired: " + rem); } return true; } else { //if (REMINDER_LOG) { Print.logInfo("Date Reminder not expired: " + rem); } } } catch (DateTime.DateParseException dpe) { // invalid date format if (REMINDER_LOG) { Print.logWarn("Invalid Reminder Date: " + rem); } } continue; } /* day of week */ // "mon", "tue" - day of week abbreviation int dowNdx = DateTime.getDayIndex(rem, -1); if (dowNdx >= 0) { // 0..6 - (absolute) day of week if (dowNdx == nowDOW) { // current date matches specified DOW int deltaDays = dowNdx - remDOW; if (deltaDays <= 0) { deltaDays += 7; } // "0" becomes "7" (for the following week) long nextTime = remTime + DateTime.DaySeconds(deltaDays); DateTime nextDT = new DateTime(nextTime, tz); if (nextDT.getDayStart() <= nowTime) { if (REMINDER_LOG) { Print.logInfo("DOW Reminder Expired: " + rem); } return true; } } continue; } /* month */ // "jan", "feb" - month abbreviation int monNdx0 = DateTime.getMonthIndex0(rem, -1); if (monNdx0 >= 0) { // 0..11 - (absolute) start of month if (monNdx0 == nowMon0) { // current date matches specified month if ((remYear == nowYear) && (remMon0 == nowMon0)) { // skip (already expired for this month) if (REMINDER_LOG) { Print.logInfo("Reminder Already Expired: " + rem); } } else { if (REMINDER_LOG) { Print.logInfo("Month Reminder Expired: " + rem); } return true; } } continue; } /* unrecognized reminder type */ if (REMINDER_LOG) { Print.logInfo("Ignoring unrecognized reminder format: " + remIntStr); } } /* not expired */ if (REMINDER_LOG) { Print.logInfo("Reminder not expired"); } return false; } /** *** Returns true if the reminder time has expired *** @param tz The TimeZone *** @return True if expired **/ public boolean isReminderExpired(TimeZone tz) { return this.isReminderExpired(tz, DateTime.getCurrentTimeSec()); } // --------------- /** *** Reset the reminder time *** @param currentTime The time to which the reminder is reset **/ public void resetReminder(long currentTime) { this.setReminderTime(currentTime); this.addOtherChangedFieldNames(Device.FLD_reminderTime); } /** *** Reset the reminder time (to current time) **/ public void resetReminder() { this.resetReminder(DateTime.getCurrentTimeSec()); } // ------------------------------------------------------------------------ /** *** Gets the last service time *** @return The last service time **/ public long getLastServiceTime() { Long v = (Long)this.getFieldValue(FLD_lastServiceTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the last service time *** @param v The last service time **/ public void setLastServiceTime(long v) { this.setFieldValue(FLD_lastServiceTime, ((v >= 0L)? v : 0L)); } // --------------- /** *** Gets the day of the last service *** @return The day of the last service **/ public long getLastServiceDayNumber() { long ts = this.getLastServiceTime(); if (ts <= 0L) { return 0L; } else { //TimeZone tmz = this.getTimeZone(null); TimeZone tmz = Account.getTimeZone(this.getAccount(),DateTime.getGMTTimeZone()); return (new DateTime(ts,tmz)).getDayNumber(); } } // ------------------------------------------------------------------------ /** *** Gets the next service time *** @return The next service time **/ public long getNextServiceTime() { Long v = (Long)this.getFieldValue(FLD_nextServiceTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the next service time *** @param v The next service time **/ public void setNextServiceTime(long v) { this.setFieldValue(FLD_nextServiceTime, ((v >= 0L)? v : 0L)); } // --------------- /** *** Gets the day of the next service *** @return The day of the next service **/ public long getNextServiceDayNumber() { long ts = this.getNextServiceTime(); if (ts <= 0L) { return 0L; } else { //TimeZone tmz = this.getTimeZone(null); TimeZone tmz = Account.getTimeZone(this.getAccount(),DateTime.getGMTTimeZone()); return (new DateTime(ts,tmz)).getDayNumber(); } } // ------------------------------------------------------------------------ private User assignedUser = null; /** *** Returns true if assigned-userID is supported *** @return True if assigned-userID is supported **/ public static boolean supportsAssignedUserID() { return Device.getFactory().hasField(FLD_assignedUserID); } /** *** Gets the assigned User-ID *** @return The assigned User-ID **/ public String getAssignedUserID() { String v = (String)this.getOptionalFieldValue(FLD_assignedUserID); return StringTools.trim(v); } /** *** Sets the assigned User-ID *** @param v The assigned User-ID **/ public void setAssignedUserID(String v) { this.setOptionalFieldValue(FLD_assignedUserID, StringTools.trim(v).toLowerCase()); this.assignedUser = null; } /** *** Gets the assigned User *** @return The assigned User, or null if no assigned User **/ public User getAssignedUser() { if (this.assignedUser == null) { String userID = this.getAssignedUserID(); if (!StringTools.isBlank(userID)) { try { this.assignedUser = User.getUser(this.getAccount(), userID); // may stil be null } catch (DBException dbe) { // ignore } } } return this.assignedUser; } /** *** Gets the TimeZone for the assigned user-id. If there is no assigned user-id, *** or the assigned user-id does not have a TimeZone preference, then it returns *** the Account preferred timezone. *** Does not return null *** @return The assigned user timezone, or the Account timezone. **/ public TimeZone getAssignedUserTimeZone() { Account acct = this.getAccount(); if (acct != null) { User user = this.getAssignedUser(); if (user != null) { TimeZone tmz = DateTime.getTimeZone(user.getTimeZone(), null); if (tmz != null) { return tmz; } } return acct.getTimeZone(null); // non-null } return DateTime.getGMTTimeZone(); } // ------------------------------------------------------------------------ /** *** Returns true if ThermalProfile is supported *** @return True if ThermalProfile is supported **/ public static boolean supportsThermalProfile() { return Device.getFactory().hasField(FLD_thermalProfile); } /** *** Gets the temperature profile for this device *** @return The temperature profile **/ public String getThermalProfile() { // temp0=130.0/130.0 temp1=130.0/130.0 temp2=130.0/130.0 temp3=130.0/130.0 temp4=130.0/130.0 temp5=130.0/130.0 temp6=130.0/130.0 temp7=130.0/130.0 String v = (String)this.getOptionalFieldValue(FLD_thermalProfile); return StringTools.trim(v); } /** *** Sets the temperature profile for this device *** @param v The temperature profile **/ public void setThermalProfile(String v) { this.setOptionalFieldValue(FLD_thermalProfile, StringTools.trim(v).toLowerCase()); } // ------------------------------------------------------------------------ /* default WorkHours/HoursOfOperation */ public static WorkHours DefaultWorkHours = new WorkHours(RTConfig.getPropertyGetter(),RuleFactory.PROP_rule_workHours_); private WorkHours cacheWorkHours = null; /** *** Returns true if HoursOfOperation/WorkHours is supported *** @return True if HoursOfOperation/WorkHours is supported **/ public static boolean supportsHoursOfOperation() { return Device.getFactory().hasField(FLD_hoursOfOperation); } /** *** Returns true if this device has a defined HoursOfOperation (ie. non-blank) *** @return True if this device has a defined HoursOfOperation (ie. non-blank) **/ public boolean hasHoursOfOperation() { return !StringTools.isBlank(this.getHoursOfOperation()); } /** *** Gets the HoursOfOperation for this device (as a String) *** @return The HoursOfOperation **/ public String getHoursOfOperation() { // sun= mon=06:00-18:00 tue=06:00-18:00 wed=06:00-18:00 thu=06:00-18:00 fri=06:00-18:00 sat= String v = (String)this.getOptionalFieldValue(FLD_hoursOfOperation); return StringTools.trim(v); } /** *** Sets the HoursOfOperation for this device *** @param v The HoursOfOperation **/ public void setHoursOfOperation(String v) { if (!StringTools.isBlank(v)) { RTProperties vRTP = new RTProperties(v.toLowerCase().replace(',',' ')); WorkHours wh = new WorkHours(vRTP,""); RTProperties whRTP = wh.getProperties(); this.setOptionalFieldValue(FLD_hoursOfOperation, whRTP.toString()); } else { this.setOptionalFieldValue(FLD_hoursOfOperation, ""); } this.cacheWorkHours = null; } /** *** Sets the HoursOfOperation for this device *** @param v The HoursOfOperation **/ public void setHoursOfOperation(RTProperties rtp) { this.setHoursOfOperation((rtp != null)? rtp.toString() : (String)null); } /** *** Sets the HoursOfOperation for this device *** @param v The HoursOfOperation **/ public void setHoursOfOperation(WorkHours wh) { if (wh != null) { this.setHoursOfOperation(wh.getProperties()); } else { this.setHoursOfOperation(""); } } /** *** Gets a WorkHours instance, based on the HoursOfOperation of this Device *** @return The WorkHours instance. **/ public WorkHours getWorkHours(WorkHours dft) { /* already cached? */ if (this.cacheWorkHours != null) { return this.cacheWorkHours; } /* get/cache WorkHours */ String whStr = this.getHoursOfOperation(); if (!StringTools.isBlank(whStr)) { // assume it is an RTProperties list this.cacheWorkHours = new WorkHours(new RTProperties(whStr),""/*no-prefix*/); return this.cacheWorkHours; } /* not found, return specified default */ return dft; } /** *** Returns true if the specified time is within the HoursOfOperation relative to the *** Account timezone. *** @param ts The timestamp representing the time to check *** @return True if time is within HoursOfOperation, false otherwise **/ public boolean isHoursOfOperation(long ts) { /* invalid time? */ if (ts < 0L) { return false; } /* DateTime */ //TimeZone tz = this.getTimeZone(null); TimeZone tz = Account.getTimeZone(this.getAccount(),null); DateTime dt = new DateTime(ts,tz); /* forward to "isHoursOfOperation(DateTime...)" */ return this.isHoursOfOperation(dt,tz); } /** *** Returns true if the specified time is within the HoursOfOperation. *** @param dt The DateTime instance representing the time to check *** @param tz The TimeZone (null to use the Account TimeZone) *** @return True if time is within HoursOfOperation, false otherwise **/ public boolean isHoursOfOperation(DateTime dt, TimeZone tz) { /* invalid time? */ if (dt == null) { return false; } /* default TimeZone */ if (tz == null) { //TimeZone tz = this.getTimeZone(dt.getTimeZone()); tz = Account.getTimeZone(this.getAccount(), dt.getTimeZone()); } /* check for time match */ WorkHours wh = this.getWorkHours(Device.DefaultWorkHours); // not null return wh.isMatch(dt,tz); } // ------------------------------------------------------------------------ private RTProperties customAttrRTP = null; private Collection customAttrKeys = null; /** *** Gets the custom attributes for this device *** @return The custom attributes for this device **/ public String getCustomAttributes() { String v = (String)this.getOptionalFieldValue(FLD_customAttributes); return StringTools.trim(v); } /** *** Sets the custom attributes for this device *** @param v The custom attributes for this device **/ public void setCustomAttributes(String v) { this.setOptionalFieldValue(FLD_customAttributes, StringTools.trim(v)); this.customAttrRTP = null; this.customAttrKeys = null; } /** *** Gets the custom attributes for this device as an RTProperties instance *** @return The custom RTProperties attributes for this device **/ public RTProperties getCustomAttributesRTP() { if (this.customAttrRTP == null) { this.customAttrRTP = new RTProperties(this.getCustomAttributes()); } return this.customAttrRTP; } /** *** Gets a Collection of custom attribute keys for this device *** @return A Collection of custom attribute keys for this device **/ public Collection getCustomAttributeKeys() { if (this.customAttrKeys == null) { this.customAttrKeys = this.getCustomAttributesRTP().getPropertyKeys(null); } return this.customAttrKeys; } /** *** Gets the value for a specific custom attribute key *** @return The value for a specific custom attribute key **/ public String getCustomAttribute(String key) { return this.getCustomAttributesRTP().getString(key,null); } /** *** Sets a specific custom attribute value *** @param key The custom attribute key *** @param value The custom value **/ public String setCustomAttribute(String key, String value) { return this.getCustomAttributesRTP().getString(key,value); } // ------------------------------------------------------------------------ /** *** Gets the Work Order ID *** @return The Work Order ID (may be a comma separated list) **/ public String getWorkOrderID() { String v = (String)this.getOptionalFieldValue(FLD_workOrderID); return StringTools.trim(v); } /** *** Sets the Work Order ID *** @param v The Work Order ID (may be a comma separated list) **/ public void setWorkOrderID(String v) { this.setOptionalFieldValue(FLD_workOrderID, StringTools.trim(v)); } // ---------------------- /** *** Gets the Work Order IDs as an array *** @return The array of Work Order IDs **/ public String[] getWorkOrderIDs() { String woid = this.getWorkOrderID(); if (StringTools.isBlank(woid)) { return new String[0]; } else { return StringTools.split(woid,','); } } /** *** Adds the specified Work Order ID to the current list *** @param woid The Work Order ID to add *** @return True if added **/ public boolean addWorkOrderID(String woid) { /* blank id specified */ woid = StringTools.trim(woid); if (StringTools.isBlank(woid)) { return false; // nothing to add } /* already exists? */ if (ListTools.containsIgnoreCase(this.getWorkOrderIDs(),woid)) { return false; // already in list } /* add */ String woidStr = this.getWorkOrderID(); if (StringTools.isBlank(woidStr)) { this.setWorkOrderID(woid); } else { String nWL = woidStr + "," + woid; this.setWorkOrderID(nWL); } return true; // not yet saved } /** *** Removes the specified Work Order ID from the current list *** @param woid The Work Order ID to remove *** @return True if removed **/ public boolean removeWorkOrderID(String woid) { /* blank id specified */ if (StringTools.isBlank(woid)) { return false; // nothing to remove } /* get current list */ String W[] = this.getWorkOrderIDs(); if (W.length == 0) { return false; // already removed } /* create new list with workOrderID removed */ java.util.List WL = ListTools.toList(W); for (String WID : W) { if (!woid.equalsIgnoreCase(WID)) { WL.add(WID); } } /* removed? */ if (WL.size() == W.length) { return false; // nothing removed } else { String woidStr = StringTools.join(WL,","); this.setWorkOrderID(woidStr); return true; } } /** *** Sets the Work Order IDs as an array *** @param W The Work Order ID array **/ public void setWorkOrderIDs(String W[]) { if (ListTools.isEmpty(W)) { this.setWorkOrderID(""); } else { String woidStr = StringTools.join(W,","); this.setWorkOrderID(woidStr); } } // ------------------------------------------------------------------------ /** *** Gets the Job number *** @return The Job number **/ public String getJobNumber() { return this.getFieldValue(FLD_jobNumber, ""); } /** *** Sets the Job number *** @param v The Job number **/ public void setJobNumber(String v) { this.setFieldValue(FLD_jobNumber, StringTools.trim(v)); this.addOtherChangedFieldNames(FLD_jobNumber); } /** *** Returns true if Job number is defined *** @return True if Job number is defined **/ public boolean hasJobNumber() { return !StringTools.isBlank(this.getJobNumber()); } // ------------------------------------------------------------------------ /** *** Sets the Job location *** @param jobLoc The Job Location GeoPoint *** @param jobRadM The Job radius in meters **/ public void setJobLocation(GeoPoint jobLoc, double jobRadM) { if (!GeoPoint.isValid(jobLoc) || (jobRadM <= 0.0)) { //Print.logInfo("Clearing job location"); this.setJobLatitude(0.0); this.setJobLongitude(0.0); this.setJobRadius(0.0); } else { //Print.logInfo("Setting job location: " + jobLoc + " " + jobRadM + " m"); this.setJobLatitude(jobLoc.getLatitude()); this.setJobLongitude(jobLoc.getLongitude()); this.setJobRadius(jobRadM); } } /** *** Returns true if there is a current job defined *** @return True if there is a current job defined **/ public boolean hasCurrentJob() { if (this.getJobRadius() <= 0.0) { return false; } else if (!GeoPoint.isValid(this.getJobLatitude(),this.getJobLongitude())) { return false; } else { return true; } } /** *** Returns true if the specified location would represent a job depart *** @param gp The GeoPoint to test *** @return True if the specified location represents a job depart **/ public boolean isImplicitJobDepart(GeoPoint gp) { /* no point specified */ if (!GeoPoint.isValid(gp)) { return false; // invalid point, no implicit job depart } /* get job location */ double jobLat = this.getJobLatitude(); double jobLon = this.getJobLongitude(); double jobRad = this.getJobRadius(); if (!GeoPoint.isValid(jobLat,jobLon) || (jobRad <= 0.0)) { return false; // no job, no job-deprt } GeoPoint jobLoc = new GeoPoint(jobLat,jobLon); /* outside of job zone? */ double distM = jobLoc.metersToPoint(gp); //Print.logInfo("Comparing JobRadius '"+jobRad+"' to distance '"+distM+"' m"); return (distM > jobRad)? true : false; } /** *** Gets the Job latitude *** @return The Job latitude **/ public double getJobLatitude() { return this.getOptionalFieldValue(FLD_jobLatitude, 0.0); } /** *** Sets the Job latitude *** @param v The Job latitude **/ public void setJobLatitude(double v) { this.setOptionalFieldValue(FLD_jobLatitude, v); } /** *** Gets the Job longitude *** @return The Job longitude **/ public double getJobLongitude() { return this.getOptionalFieldValue(FLD_jobLongitude, 0.0); } /** *** Sets the Job longitude *** @param v The Job longitude **/ public void setJobLongitude(double v) { this.setOptionalFieldValue(FLD_jobLongitude, v); } /** *** Gets the Job radius, in meters *** @return The Job radius, in meters **/ public double getJobRadius() { return this.getOptionalFieldValue(FLD_jobRadius, 0.0); } /** *** Sets the Job radius, in meters *** @param v The Job radius, in meters **/ public void setJobRadius(double v) { this.setOptionalFieldValue(FLD_jobRadius, v); } // ------------------------------------------------------------------------ /** *** Returns true if DataPushTime is supported *** @return True if DataPushTime is supported **/ public boolean supportsDataPushTime() { return Device.getFactory().hasField(FLD_lastDataPushTime); } /** *** Gets the Data Push time *** @return The Data Push time **/ public long getLastDataPushTime() { Long v = (Long)this.getFieldValue(FLD_lastDataPushTime); return (v != null)? v.longValue() : 0L; } /** *** Sets the Data Push time *** @param v The Data Push time **/ public void setLastDataPushTime(long v) { this.setFieldValue(FLD_lastTotalConnectTime, v); } // ------------------------------------------------------------------------ /** *** Gets the Last Event Creation time, in milliseconds *** @return The Last Event Creation time, in milliseconds **/ public long getLastEventCreateMillis() { Long v = (Long)this.getFieldValue(FLD_lastEventCreateMillis); return (v != null)? v.longValue() : 0L; } /** *** Sets the Last Event Creation time, in milliseconds *** @param v The Last Event Creation time, in milliseconds **/ public void setLastEventCreateMillis(long v) { this.setFieldValue(FLD_lastEventCreateMillis, v); } // Bean access fields above // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Sets the record creation default values **/ public void setCreationDefaultValues() { this.setIsActive(true); this.setDescription(NEW_DEVICE_NAME_ + " [" + this.getDeviceID() + "]"); this.setIgnitionIndex(-1); // Rules-Engine Allow Notification if (Device.hasRuleFactory()) { this.setAllowNotify(true); } this.setNotifyAction(RuleFactory.ACTION_DEFAULT); // BorderCrossing if (Device.supportsBorderCrossing()) { this.setBorderCrossing(Device.BorderCrossingState.ON); } // DataTransport attributes below this.setSupportedEncodings(Transport.DEFAULT_ENCODING); this.setTotalMaxConn(Transport.DEFAULT_TOTAL_MAX_CONNECTIONS); this.setDuplexMaxConn(Transport.DEFAULT_DUPLEX_MAX_CONNECTIONS); this.setUnitLimitInterval(Transport.DEFAULT_UNIT_LIMIT_INTERVAL_MIN); // Minutes this.setTotalMaxConnPerMin(Transport.DEFAULT_TOTAL_MAX_CONNECTIONS_PER_MIN); this.setDuplexMaxConnPerMin(Transport.DEFAULT_DUPLEX_MAX_CONNECTIONS_PER_MIN); this.setMaxAllowedEvents(Transport.DEFAULT_MAX_ALLOWED_EVENTS); // other defaults super.setRuntimeDefaultValues(); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** DataTransport Interface: Gets the Associated AccountID *** @return The Associated AccountID **/ public String getAssocAccountID() { return this.getAccountID(); } /** *** DataTransport Interface: Gets the Associated DeviceID *** @return The Associated DeviceID **/ public String getAssocDeviceID() { return this.getDeviceID(); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Gets the DCServerConfig instance for this Device *** @return The DCServerConfig instance for this Device **/ public DCServerConfig getDCServerConfig() { return DCServerFactory.getServerConfig(this.getDeviceCode()); } /** *** Return a list of supported commands *** @param privLabel The current PrivateLabel instance *** @param user The current user instance *** @param type The command location type (ie. "map", "admin", ...) *** @return A map of the specified commands **/ public Map getSupportedCommands(BasicPrivateLabel privLabel, User user, String type) { DCServerConfig dcs = this.getDCServerConfig(); return (dcs != null)? dcs.getCommandDescriptionMap(privLabel,user,type) : null; } // ------------------------------------------------------------------------ private int startStopStatusCodes[] = null; private boolean startStopStatusCodes_init = false; /** *** Gets the "Start/Stop StatusCode supported" config *** @return The "Start/Stop StatusCode supported" state **/ public boolean getStartStopSupported() { return (this.getStartStopStatusCodes() != null); } /** *** Returns the start/stop status codes defined in the Device record *** @return The start/stop status codes **/ public int[] getStartStopStatusCodes() { if (!this.startStopStatusCodes_init) { DCServerConfig dcs = this.getDCServerConfig(); this.startStopStatusCodes = (dcs != null)? dcs.getStartStopStatusCodes() : null; this.startStopStatusCodes_init = true; } return this.startStopStatusCodes; } // ------------------------------------------------------------------------ /** *** Returns true if sending commands is supported for the specified private-label and user *** @param privLabel The BasicPrivateLabel instance *** @param user The User **/ public boolean isPingSupported(BasicPrivateLabel privLabel, User user) { /* check ACL */ DCServerConfig dcs = this.getDCServerConfig(); if ((privLabel != null) && (dcs != null) && !privLabel.hasWriteAccess(user, dcs.getCommandsAclName())) { Print.logDebug("User does not have access to device command handler"); return false; } /* PingDispatcher */ if (Device.hasPingDispatcher()) { boolean supported = Device.getPingDispatcher().isPingSupported(this); Print.logDebug("Device "+this.getDeviceID()+" isPingSupported = " + supported); return supported; } else { Print.logDebug("Device "+this.getDeviceID()+" does not have a command-handler"); return false; } } /** *** Sends the specified command to this device *** @param cmdType The Command type *** @param cmdName The Command name *** @param cmdArgs The Command args/parameters *** @return True if the command was sent successfully **/ public boolean sendDeviceCommand(String cmdType, String cmdName, String cmdArgs[]) { String ct = !StringTools.isBlank(cmdType)? cmdType : DCServerConfig.COMMAND_CONFIG; /* DCServerConfig */ DCServerConfig dcs = this.getDCServerConfig(); if (dcs != null) { // a DCServerConfig is defined RTProperties resp = DCServerFactory.sendServerCommand(this, ct, cmdName, cmdArgs); Print.logInfo("Ping Response: " + resp); boolean sentOK = DCServerFactory.isCommandResultOK(resp); return sentOK; } /* PingDispatcher */ if (Device.hasPingDispatcher()) { boolean sentOK = Device.getPingDispatcher().sendDeviceCommand(this, ct, cmdName, cmdArgs); return sentOK; } else { Print.logWarn("Device has no PingDispatcher"); return false; } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ private static boolean allowSlowReverseGeocode = true; /** *** Enabled/Disabled slow reverse-geocoding (default is to allow) *** @param allow True to allow, false to dis-allow **/ public static void SetAllowSlowReverseGeocoding(boolean allow) { Device.allowSlowReverseGeocode = allow; } /** *** Returns true is slow reverse-geocoding is allowed *** @return True if allowed, false otherwise **/ public static boolean GetAllowSlowReverseGeocoding() { return Device.allowSlowReverseGeocode; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ private static boolean ENABLE_LOAD_TESTING = true; private static Object loadTestingLock = new Object(); private static DateTime loadTestingTime = null; private static long loadTestingCount = 0L; /** *** Gets the number of events between the specified timestamps (inclusive) *** @param timeStart The starting timestamp *** @param timeEnd The ending timestamp *** @return The number of events between the specified timestamps (inclusive) **/ public long getEventCount(long timeStart, long timeEnd) throws DBException { long count = EventData.getRecordCount( this.getAccountID(), this.getDeviceID(), timeStart, timeEnd); return count; } /** *** Gets the total number of events for this Device/Vehicle *** @return The total number of EventData records for this Device **/ public long getEventCount() throws DBException { return this.getEventCount(-1L, -1L); } // ------------------------------------------------------------------------ /** *** Prints the event information to the log file *** @param ev The event to log **/ public void log_EventData(int logLevel, EventData ev) { /* assemble log info */ StringBuffer sb = new StringBuffer(); sb.append("Event: "); if (ev != null) { // Event: 2011/07/11|12:34:56|PST, account|device, 0xF020|Location|geozone, latitude|longitude, speed|heading int sc = ev.getStatusCode(); DateTime dt = new DateTime(ev.getTimestamp()); String zone = ev.getGeozoneID(); /* date|time */ sb.append(dt.format("yyyy/MM/dd|HH:mm:ss|zzz")).append(", "); /* account|device */ sb.append(ev.getAccountID()).append("|").append(ev.getDeviceID()).append(", "); /* status code */ sb.append(StatusCodes.GetHex(sc)).append("|").append(StatusCodes.GetDescription(sc,null)); if (!StringTools.isBlank(zone)) { sb.append("|").append(zone); } else if ((sc == StatusCodes.STATUS_GEOFENCE_ARRIVE) || (sc == StatusCodes.STATUS_GEOFENCE_ARRIVE) ) { sb.append("|?"); } sb.append(", "); /* lat|lon */ sb.append(ev.getGeoPoint().toString('|')); sb.append(", "); /* speed|heading */ sb.append(StringTools.format(ev.getSpeedKPH(),"0.0")); sb.append("|"); sb.append(StringTools.format(ev.getHeading(),"0")); } else { // Event: null // create log message sb.append("null"); } /* log */ Print.log(logLevel, sb.toString()); } /** *** Insert event into EventData table *** @param evdb The EventData record to insert *** @return True if successful, false otherwise **/ public boolean insertEventData(EventData evdb) { /* log event insertion */ if (Device.LogEventDataInsertion >= Print.LOG_WARN) { // LOG_WARN, LOG_INFO, LOG_DEBUG this.log_EventData(Device.LogEventDataInsertion, evdb); } /* insert event */ if (!this._insertEventData(evdb)) { // event was ignored Print.logWarn("Event not inserted ..."); return false; } /* status code */ int sc = evdb.getStatusCode(); /* check for synthesized GeoCorridor events */ if (sc == StatusCodes.STATUS_GEOFENCE_ARRIVE) { // check for GeoCorridor deactivation Geozone zone = evdb.getGeozone(); if (this.hasActiveCorridor() && (zone != null) && zone.isCorridorEnd(evdb)) { this.setActiveCorridor(""); // FLD_activeCorridor // TODO: insert STATUS_CORRIDOR_INACTIVE // evdb.setStatusCode(StatusCodes.CORRIDOR_INACTIVE); // this._insertEventData(evdb); // Print.logInfo("Synthesized Corridor deactivation event"); } } else if (sc == StatusCodes.STATUS_GEOFENCE_DEPART) { // check for GeoCorridor activation Geozone zone = evdb.getGeozone(); if ((zone != null) && zone.isCorridorStart(evdb)) { String corridorID = zone.getCorridorID(); this.setActiveCorridor(corridorID); // FLD_activeCorridor // TODO: insert STATUS_CORRIDOR_ACTIVE // evdb.setStatusCode(StatusCodes.STATUS_CORRIDOR_ACTIVE); // this._insertEventData(evdb); // Print.logInfo("Synthesized Corridor activation event"); } } return true; } /** *** Insert event into EventData table *** @param evdb The EventData record to insert *** @return True if successful, false otherwise **/ protected boolean _insertEventData(final EventData evdb) { // Notes: // 1) This incoming EventData record is populated, but hasn't been saved // 2) This Device record at this point _should_ still contain old/last field values Account account = this.getAccount(); String acctID = this.getAccountID(); String devID = this.getDeviceID(); /* invalid EventData? */ if (evdb == null) { //Print.logError("EventData is null"); return false; } int statusCode = evdb.getStatusCode(); /* set device */ evdb.setDevice(this); /* Transport ID */ evdb.setTransportID(this.getTransportID()); /* Event time check */ long eventTime = evdb.getTimestamp(); long lastEventTime = this.getLastEventTimestamp(); // may be zero if (eventTime >= 5000000000L) { // Event time might be specified in milliseconds Print.logWarn("EventData time is invalid (too large): "+eventTime+" [ignoring record]"); return false; } else if (eventTime <= 0L) { // Event time is invalid Print.logWarn("EventData time is invalid (<=1980/01/01): "+eventTime+" [ignoring record]"); return false; } /* check for past timestamp */ int pastDateAction = Device.pastEventDateAction(); if (pastDateAction != PAST_DATE_DISABLED) { long maxPastSec = Device.pastEventDateMaximumSec(); if (maxPastSec > 0L) { // must be greater-than 0 long nowTime = DateTime.getCurrentTimeSec(); long minTime = nowTime - maxPastSec; long evTime = eventTime; if (evTime < minTime) { if (pastDateAction == PAST_DATE_IGNORE) { // ignore this record Print.logWarn("Invalid EventData past time: "+new DateTime(evTime)+" [ignoring record per configuration]"); return false; } else if (pastDateAction == PAST_DATE_TRUNCATE) { // truncate date/time long truncTime = nowTime; // minTime; Print.logWarn("Invalid EventData past time: "+new DateTime(evTime)+" [set/truncate to "+new DateTime(truncTime)+"]"); evdb.setTimestamp(truncTime); eventTime = truncTime; } else { // should not occur (just continue) Print.logWarn("Invalid EventData past time: "+new DateTime(evTime)+" [unexpected action "+pastDateAction+"]"); } } } } /* check for future timestamp */ int futureDateAction = Device.futureEventDateAction(); if (futureDateAction != FUTURE_DATE_DISABLED) { long maxFutureSec = Device.futureEventDateMaximumSec(); if (maxFutureSec > 0L) { // must be greater-than 0 long nowTime = DateTime.getCurrentTimeSec(); long maxTime = nowTime + maxFutureSec; long evTime = eventTime; if (evTime > maxTime) { if (futureDateAction == FUTURE_DATE_IGNORE) { // ignore this record Print.logWarn("Invalid EventData future time: "+new DateTime(evTime)+" [ignoring record per configuration]"); return false; } else if (futureDateAction == FUTURE_DATE_TRUNCATE) { // truncate date/time long truncTime = nowTime; // maxTime; Print.logWarn("Invalid EventData future time: "+new DateTime(evTime)+" [set/truncate to "+new DateTime(truncTime)+"]"); evdb.setTimestamp(truncTime); eventTime = truncTime; } else { // should not occur (just continue) Print.logWarn("Invalid EventData future time: "+new DateTime(evTime)+" [unexpected action "+futureDateAction+"]"); } } } } /* old event? (test after time checks) */ boolean isOldEvent = (eventTime < lastEventTime)? true : false; /* check for invalid speed (beyond reasonable maximum) */ int invalidSpeedAction = Device.invalidSpeedAction(); if (invalidSpeedAction != INVALID_SPEED_DISABLED) { double maxSpeedKPH = Device.invalidSpeedMaximumKPH(); if (maxSpeedKPH > 0.0) { // must be greater-than 0.0 double evSpeedKPH = evdb.getSpeedKPH(); if (evSpeedKPH > maxSpeedKPH) { if (invalidSpeedAction == INVALID_SPEED_IGNORE) { // ignore/skip this record Print.logWarn("Invalid EventData speed: "+evSpeedKPH+" km/h [ignoring/skipping record per config]"); return false; } else if (invalidSpeedAction == INVALID_SPEED_TRUNCATE) { // truncate speed to maximum Print.logWarn("Invalid EventData speed: "+evSpeedKPH+" km/h [set/truncate to "+maxSpeedKPH+"]"); evdb.setSpeedKPH(maxSpeedKPH); } else if (invalidSpeedAction == INVALID_SPEED_ZERO) { // set speed to zero Print.logWarn("Invalid EventData speed: "+evSpeedKPH+" km/h [set to 0.0]"); evdb.setSpeedKPH(0.0); } else { // should not occur (just continue) Print.logWarn("Invalid EventData speed: "+evSpeedKPH+" km/h [unexpected action "+invalidSpeedAction+"]"); } } } } /* no status code? */ if (statusCode == StatusCodes.STATUS_NONE) { // '0' status codes are quietly consumed/ignored. if (ENABLE_LOAD_TESTING) { // This section is for load testing. if (loadTestingTime == null) { synchronized (loadTestingLock) { if (loadTestingTime == null) { loadTestingTime = new DateTime(/*tz*/); } } } long deltaSec = DateTime.getCurrentTimeSec() - loadTestingTime.getTimeSec(); if (deltaSec > 60) { // reset every minute synchronized (loadTestingLock) { loadTestingTime = new DateTime(/*tz*/); loadTestingCount = 0L; deltaSec = 0L; } } loadTestingCount++; double eps = (deltaSec > 0L)? ((double)loadTestingCount / (double)deltaSec) : loadTestingCount; if ((loadTestingCount % 50) == 0) { System.err.println("EventData LoadTest (" + eps + " ev/sec)"); } } return true; } /* extended EventData record update */ int extUpdate = EXT_UPDATE_NONE; /* update GPS location based on Geozone */ if (UpdateEventWithGeozoneLocation() && !evdb.isValidGeoPoint() && evdb.hasGeozoneID()) { if ((statusCode != StatusCodes.STATUS_GEOFENCE_DEPART ) && (statusCode != StatusCodes.STATUS_GEOFENCE_INACTIVE) ) { Geozone gz = evdb.getGeozone(); if (gz != null) { GeoPoint gp = gz.getCenterGeoPoint(); evdb.setGeoPoint(gp); } } } /* PCell Tower GPS location */ if (!evdb.isValidGeoPoint() && evdb.canUpdateCellTowerLocation()) { boolean ALWAYS_UPDATE_CELLGPS = true; CellTower dct = !ALWAYS_UPDATE_CELLGPS? this.getLastServingCellTower() : null; if (dct == null) { // No last CellID extUpdate |= EXT_UPDATE_CELLGPS; } else if (!dct.equals(evdb.getServingCellTower())) { // Last CellID does not match current CellID extUpdate |= EXT_UPDATE_CELLGPS; } else { // We have a last cellID MobileLocation ml = dct.getMobileLocation(); if ((ml != null) && ml.isValid()) { GeoPoint mgp = ml.getGeoPoint(); double acc = ml.getAccuracy(); evdb.setCellGeoPoint(mgp); evdb.setCellAccuracy(acc); Print.logInfo("Using cached CellTower location: " + mgp + " [+/- " + acc + " meters]"); } else { // No MobileLocation means that the CellID did not have a known location Print.logInfo("Using cached CellTower location: no location"); } } } /* set geozone/reverse-geocode address */ try { Set updFields = evdb.updateAddress(true/*fastOnly*/); if (updFields != null) { BasicPrivateLabel privLabel = account.getPrivateLabel(); ReverseGeocodeProvider rgp = privLabel.getReverseGeocodeProvider(); String rgName = (rgp != null)? rgp.getName() : "???"; Print.logInfo("EventData address: [%s/%s:%s] %s: %s", this.getAccountID(), this.getDeviceID(), rgName, evdb.getGeoPoint().toString(), evdb.getAddress()); // we don't care about the names of the fields updated, since all fields will be saved below } } catch (SlowOperationException soe) { // The address update has not been performed because the operation would have // taken too long [per 'isFastOperation()' method in ReverseGeocodeProvider instance]. // This address update will need to be queued for background processing. if (Device.allowSlowReverseGeocode) { extUpdate |= EXT_UPDATE_ADDRESS; } } catch (Throwable th) { Print.logException("Address update error", th); } /* stateline border-crossing check */ //if (this.getBorderCrossing() == Device.BorderCrossingState.ON.getIntValue()) { // // border-crossing is always considered a slow operation // //extUpdate |= EXT_UPDATE_BORDER; //} /* check for motion change */ long lastStopTime = this.getLastStopTime(); // may be '0' if uninitialized long lastStartTime = this.getLastStartTime(); // may be '0' if uninitialized long nextStopTime = 0L; long nextStartTime = 0L; if ((lastStartTime > lastStopTime)/* && (eventTime > lastStartTime)*/) { // last state was "moving" if (evdb.isStopEvent(true)) { // was "moving", now "stopped" evdb.setStopped(true); nextStopTime = eventTime; } else { // continue "moving" evdb.setStopped(false); } } else if ((lastStopTime > lastStartTime)/* && (eventTime > lastStopTime)*/) { // last state was "stopped" if (evdb.isStartEvent(true)) { // was "stopped", now "moving" /* if (!isOldEvent && AUTO_GENERATE_NON_MOVING_EVENT && ((eventTime - lastEventTime) < MAX_STOPPED_DELTA_SEC)) { EventData newEv = this.getLastStopEvent(); if (newEv != null) { newEv.setTimestamp(eventTime - 2L); newEv.setStatusCode(StatusCodes.STATUS_MOTION_DORMANT); newEv.setSpeedKPH(0.0); // make sure speed is 0 //newEv.setMotionChangeTime(lastStopTime); try { newEv.save(); // insert(); } catch (DBException dbe) { // save failed } } } */ evdb.setStopped(false); nextStartTime = eventTime; } else { // continue "stopped" evdb.setStopped(true); } } else { // undefined lastStopTime/lastStartTime if (evdb.isStopEvent(true)) { // is "stopped" evdb.setStopped(true); nextStopTime = eventTime; } else if (evdb.isStartEvent(true)) { // is "moving" evdb.setStopped(false); nextStartTime = eventTime; } else { // check speed only if (evdb.getSpeedKPH() <= 0.0) { // assume "stopped" evdb.setStopped(true); nextStopTime = eventTime; } else { // assume "moving" evdb.setStopped(false); nextStartTime = eventTime; } } } /* last digital input? */ if (!evdb.isInputMaskExplicitlySet()) { // "inputMask" not explicitly set by DCS, set to last saved Device input state evdb.setInputMask(this.getLastInputState()); } /* last digital output? */ if (!evdb.isOutputMaskExplicitlySet()) { // "outputMask" not explicitly set by DCS, set to last saved Device output state evdb.setOutputMask(this.getLastOutputState()); } /* status code on/off state */ /* StatusCodeState statusCodeState = this.getStatusCodeBinaryState(statusCode); if (statusCodeState != null) { int scBitNdx = statusCodeState.getIndex(); boolean scBitVal = statusCodeState.getState(); this.setStatusCodeStateBit(scBitNdx, scBitVal); } */ /* ignition state */ double ignHours = this.getLastIgnitionHours(); // incremental ignition-hours long lastIgnOn = this.getLastIgnitionOnTime(); long lastIgnOff = this.getLastIgnitionOffTime(); // TODO: what if 'eventTime' is less than 'lastIgnOn' or 'lastIgnOff' if (lastIgnOn < lastIgnOff) { // last ignition-on is BEFORE ignition-off, clear ignition-on lastIgnOn = 0L; // last state confirmed ignition-off // (lastIgnOff > 0) 'ignStateCh' should not be '0' } else if (lastIgnOff < lastIgnOn) { // last ignition-off is BEFORE ignition-on, clear ignition-off lastIgnOff = 0L; // last state confirmed ignition-off // (lastIgnOn > 0) 'ignStateCh' should not be '1' } boolean hasIgnSt = ((lastIgnOn > 0L) || (lastIgnOff > 0L))? true : false; int ignStateCh = this.getEventIgnitionState(evdb); // -1=NoChange, 0=Off, 1=On // simulated ignition-hours based on ignition-on elapsed time (EXPERIMENTAL) if ((lastIgnOn > 0L) && (eventTime > lastIgnOn)) { // ignition has been on, and current event timestamp is after lastIgnitionOn time double runHrs = (double)(eventTime - lastIgnOn) / 3600.0; // elapsed hours since last ignition-on ignHours += runHrs; // total elapsed ignition-on } /* engine state (if available) */ double engHours = this.getLastEngineHours(); // incremental engine-hours long lastEngOn = this.getLastEngineOnTime(); long lastEngOff = this.getLastEngineOffTime(); // TODO: what if 'eventTime' is less than 'lastEngOn' or 'lastEngOff' if (lastEngOn < lastEngOff) { // last engine-on is BEFORE engine-off, clear engine-on lastEngOn = 0L; // last state confirmed engine-off } else if (lastEngOff < lastEngOn) { // last engine-off is BEFORE engine-on, clear engine-off lastEngOff = 0L; // last state confirmed engine-off } boolean hasEngSt = ((lastEngOn > 0L) || (lastEngOff > 0L))? true : false; // simulated engine-hours based on engine-on elapsed time (EXPERIMENTAL) if ((lastEngOn > 0L) && (eventTime > lastEngOn)) { // engine has been on, and current event timestamp is after lastEngineOn time double runHrs = (double)(eventTime - lastEngOn) / 3600.0; // elapsed hours since last engine-on engHours += runHrs; // total elapsed ignition-on } // TODO: what if the device used to emit Engine On/Off, but no longer does? /* simulate engine hours */ if (Device.GetSimulateEngineHours(this)) { if (evdb.getEngineHours() > 0.0) { // event already has engine hours, leave as-is Print.logInfo("["+acctID+"/"+devID+"] SimEngHours: Event engine-hours already set (leaving as-is)"); } else if (hasEngSt && (engHours > 0.0)) { // save current engine-hours as event engine-hours Print.logInfo("["+acctID+"/"+devID+"] SimEngHours: Event engine-hours set to " + engHours + " hours (based on Engine On/Off)"); evdb.setEngineHours(engHours); // saved in Device record below (setLastEngineHours) } else if (hasIgnSt && (ignHours > 0.0)) { // save current ignition-hours as event engine-hours Print.logInfo("["+acctID+"/"+devID+"] SimEngHours: Event engine-hours set to " + ignHours + " hours (based on Ignition On/Off)"); evdb.setEngineHours(ignHours); // saved in Device record below (setLastEngineHours) } else { // save old Device engine-hours as event engine-hours (may be 0.0) Print.logInfo("["+acctID+"/"+devID+"] SimEngHours: No available engine/ignition hours"); evdb.setEngineHours(engHours); // saved in Device record below (setLastEngineHours) } } /* driver ID */ String driverID = null; long driverStatus = -1L; boolean saveDriverID = false; boolean saveDriverStatus = false; if (Device.GetSaveEventDriverID()) { // DriverID if (evdb.hasDriverID()) { // update device driver-id driverID = evdb.getDriverID(); saveDriverID = true; if (evdb.hasDriverStatus()) { // also update device driver-status driverStatus = evdb.getDriverStatus(); saveDriverStatus = true; } else if (this.isDriverID(driverID)) { // same driver-id: update driver-status with last device driver status driverStatus = this.getDriverStatus(); evdb.setDriverStatus(driverStatus); } else { // different driver-id: clear driver device driver status driverStatus = -1L; saveDriverStatus = true; } } else if (this.hasDriverID()) { // update event with previous DriverID driverID = this.getDriverID(); evdb.setDriverID(driverID); if (this.hasDriverStatus()) { // update event with previous driver-status driverStatus = this.getDriverStatus(); evdb.setDriverStatus(driverStatus); } else { // clear event driver status driverStatus = -1L; evdb.setDriverStatus(driverStatus); } } } /* current odometer offset */ evdb.setOdometerOffsetKM(this.getOdometerOffsetKM()); // --------------------------------------------------------------------- /* event is STATUS_GFMI_STOP_STATUS_1 and event already exists */ // Some devices have been known to send multiple STATUS_GFMI_STOP_STATUS_1 events // within the same second, which could cause some events to overwrite others. // This section attemps to prevent overwrites by prechecking for existing stop-status // events and modifying the status code if existing such events are found. if (statusCode == StatusCodes.STATUS_GFMI_STOP_STATUS_1) { String aid = evdb.getAccountID(); String did = evdb.getDeviceID(); long ts = evdb.getTimestamp(); try { for (int sc : StatusCodes.GFMI_StopStatus) { EventData gfmiEV = EventData.getEventData(aid,did,ts,sc); // check if not found if (gfmiEV == null) { // not found, use this status code if (sc != statusCode) { statusCode = sc; evdb.setStatusCode(statusCode); } break; } // event already exists if ((gfmiEV.getStopID() == evdb.getStopID() ) || (gfmiEV.getStopStatus() == evdb.getStopStatus()) ) { // same event (this stop id/status apparently already exists) if (sc != statusCode) { statusCode = sc; evdb.setStatusCode(statusCode); } break; } // stop id/status is different, try again continue; } } catch (DBException dbe) { Print.logException("Unable to read GFMI StopStatus events", dbe); } } // --------------------------------------------------------------------- /* save EventData record */ try { evdb.save(); // insert(); // may be re-saved below after deferred reverse-geocode } catch (DBException dbe) { // save failed Print.logError("EventData save failed: " + dbe); return false; } /* background processes */ if (extUpdate != EXT_UPDATE_NONE) { // queue for background processing final int extUpd = extUpdate; Runnable job = new Runnable() { public void run() { Device.this._postEventInsertionProcessing(evdb, extUpd); } }; BackgroundThreadPool.run(job); Print.logDebug("Address update queued for background operation"); } else { // check event rules now and perform appropriate action if necessary //this.checkEventRules(evdb); } // --------------------------------------------------------------------- // Device record should not have been changed before this point /* check rules */ // "checkEventRules" may recursively call "_insertEventData" if (this.checkEventRules(evdb)) { // Fields may have changed: (NOTE: not yet saved) // FLD_lastNotifyTime // FLD_lastNotifyCode } // --------------------------------------------------------------------- // Device record can now be updated /* update fields to reflect this event */ // NOTE: Device not yet saved! /* count Events-Per-Second */ this._countEventsPerSecond(); // FLD_lastEventsPerSecond, FLD_lastEventsPerSecondMS /* last valid event timestamp */ this.setLastEventTimestamp(evdb.getTimestamp()); // FLD_lastEventTimestamp /* latitude/longitude */ if (evdb.isValidGeoPoint()) { // update last valid location this.setLastValidLatitude(evdb.getLatitude()); // FLD_lastValidLatitude this.setLastValidLongitude(evdb.getLongitude()); // FLD_lastValidLongitude this.setLastValidHeading(evdb.getHeading()); // FLD_lastValidHeading this.setLastGPSTimestamp(evdb.getTimestamp()); // FLD_lastGPSTimestamp } /* motion change */ if (nextStopTime > 0L) { this.setLastStopTime(nextStopTime); // FLD_lastStopTime } if (nextStartTime > 0L) { this.setLastStartTime(nextStartTime); // FLD_lastStartTime } /* malfunction-indicator-lamp (MIL) */ if (evdb.hasMalfunctionLamp()) { // sets Device last MIL if it was explicitly set in EventData this.setLastMalfunctionLamp(evdb.getMalfunctionLamp()); // FLD_lastMalfunctionLamp } /* fault code */ if (evdb.hasFaultCode()) { this.appendLastFaultCode(evdb.getFaultCode()); // FLD_lastFaultCode } /* distance */ { // set last distance double distKM = evdb.getDistanceKM(); if (distKM < 0.0) { // skip (not provided by DCS) } else { this.setLastDistanceKM(distKM); // FLD_lastDistanceKM } } /* odometer */ { // set last odometer double odomKM = evdb.getOdometerKM(); if (odomKM < 0.0) { // skip (not provided by DCS) } else if (odomKM == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastOdometerKM(odomKM); // FLD_lastOdometerKM } } /* fuel consumption */ { double fuelTotal = evdb.getFuelTotal(); if (fuelTotal < 0.0) { // skip (not provided by DCS) } else if (fuelTotal == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastFuelTotal(fuelTotal); // FLD_lastFuelTotal } } /* engine hours */ { double evEngHours = evdb.getEngineHours(); if (evEngHours < 0.0) { // skip (not provided by DCS) } else if (evEngHours == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastEngineHours(evEngHours); // FLD_lastEngineHours } if (statusCode == StatusCodes.STATUS_ENGINE_START) { this.setLastEngineOnTime(eventTime); // FLD_lastEngineOnTime this.setLastEngineOffTime(0L); // FLD_lastEngineOffTime } else if (statusCode == StatusCodes.STATUS_ENGINE_STOP) { this.setLastEngineOnTime(0L); // FLD_lastEngineOnTime this.setLastEngineOffTime(eventTime); // FLD_lastEngineOffTime } } /* ignition state change */ if (ignStateCh == 1) { // Current Ignition state changed from OFF to ON if (lastIgnOn > 0L) { // (lastIgnOn > lastIgnOff) // last ignition ON was already set (leave ignition-on time as-is) Print.logWarn("Ignition-ON event found, without interleaving Ignition-OFF: " + acctID + "/" + devID); //this.setLastIgnitionOnTime(eventTime); // FLD_lastIgnitionOnTime } else { // save new last ignition-on time this.setLastIgnitionOnTime(eventTime); // FLD_lastIgnitionOnTime // "ignHours" is old here, no need to set } // clear ignition off if (eventTime < this.getLastIgnitionOffTime()) { // unlikely // make sure lastIgnitionOffTime reflects Ignition-ON Print.logWarn("Event time is prior to last Ignition-OFF! " + acctID + "/" + devID); this.setLastIgnitionOffTime(0L); // FLD_lastIgnitionOffTime } } else if (ignStateCh == 0) { // Current Ignition state changed from ON to OFF if (lastIgnOff > 0L) { // (lastIgnOff > lastIgnOn) // last ignition OFF was already set (leave ignition-off time as-is) Print.logWarn("Ignition-OFF event found, without interleaving Ignition-ON: " + acctID + "/" + devID); //this.setLastIgnitionOffTime(eventTime); // FLD_lastIgnitionOffTime } else { // save last ignition off time and save accumulated ignition-hours this.setLastIgnitionOffTime(eventTime); // FLD_lastIgnitionOffTime this.setLastIgnitionHours(ignHours); // FLD_lastIgnitionHours } // clear ignition on if (eventTime < this.getLastIgnitionOnTime()) { // unlikely // make sure lastIgnitionOnTime reflects Ignition-OFF Print.logWarn("Event time is prior to last Ignition-ON! " + acctID + "/" + devID); this.setLastIgnitionOnTime(0L); // FLD_lastIgnitionOnTime } } else { // Ignition state has not changed } /* battery level */ { double battLevel = evdb.getBatteryLevel(); if (battLevel < 0.0) { // skip (not provided by DCS) } else if (battLevel == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastBatteryLevel(battLevel); // FLD_lastBatteryLevel } } /* fuel level */ { double fuelLevel = evdb.getFuelLevel(true/*estimate*/); if (fuelLevel < 0.0) { // skip (not provided by DCS) } else if (fuelLevel == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastFuelLevel(fuelLevel); // FLD_lastFuelLevel } } /* oil level */ { double oilLevel = evdb.getOilLevel(); if (oilLevel < 0.0) { // skip (not provided by DCS) } else if (oilLevel == 0.0) { // TODO: decide whether or not to skip? } else { this.setLastOilLevel(oilLevel); // FLD_lastOilLevel } } /* driver ID/Status */ if (saveDriverID) { this.setDriverID(driverID); // FLD_driverID if (saveDriverStatus) { this.setDriverStatus(driverStatus); // FLD_driverStatus } try { Driver.updateDriverStatus(account, driverID, driverStatus); } catch (DBException dbe) { Print.logError("Driver status save failed: " + dbe); } } /* expects an acknowledgement? */ if (this.isAckStatusCode(statusCode)) { String ad = this.getAccountID() + "/" + this.getDeviceID(); Print.logInfo("ACK status code match [" + ad + "]: " + StatusCodes.GetHex(statusCode)); this.clearExpectCommandAck(true/*didAck*/,false/*update*/); } // TODO: GPIO? "lastInputState" (must currently be set by DCS) // TODO: GPIO? "lastOutputState" (must currently be set by DCS) /* return success */ return true; } /** *** Post EventData record insertion processing *** @param evdb The EventData instance *** @param extUpdate The mask indicating post processing to perform **/ private void _postEventInsertionProcessing(EventData evdb, int extUpdate) { Set updatedEvFields = null; /* cell tower GPS location */ if ((extUpdate & EXT_UPDATE_CELLGPS) != 0) { Set updf = evdb.updateCellTowerLocation(); if (updf != null) { // MobileLocation was successful (but may not have returned a valid location) if (updatedEvFields == null) { updatedEvFields = new HashSet(); } updatedEvFields.addAll(updf); CellTower sct = evdb.getServingCellTower(); if (sct != null) { // update Device lastCellServingInfo this.setLastServingCellTower(sct); // FLD_lastCellServingInfo try { this.update(Device.FLD_lastCellServingInfo); } catch (DBException dbe) { Print.logError("Unable to update Device: " + dbe); } // we've updated the cell-tower location, also update address if (Device.allowSlowReverseGeocode) { extUpdate |= EXT_UPDATE_ADDRESS; } } } } /* address */ if ((extUpdate & EXT_UPDATE_ADDRESS) != 0) { try { Set updf = evdb.updateAddress(false/*!fastOnly*/); if (updf != null) { if (updatedEvFields == null) { updatedEvFields = new HashSet(); } updatedEvFields.addAll(updf); } } catch (SlowOperationException soe) { // this will not occur ('fastOnly' is false) } } /* stateline border-crossing check here */ // check border-crossing in nightly cron /* update */ if (!ListTools.isEmpty(updatedEvFields)) { try { evdb.update(updatedEvFields); Print.logInfo("EventData address: [%s/%s] %s: %s", this.getAccountID(), this.getDeviceID(), evdb.getGeoPoint().toString(), evdb.getAddress()); } catch (DBException dbe) { Print.logError("EventData update error: " + dbe); } } /* rule check */ //Cannot defer rule check to here!!! //Rule triggers may be based on values which may be changing in the Device record, //which will have already changed by the time we get here! //this.checkEventRules(evdb); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Post command handling *** (called by "DCServerConfig.Command.setDeviceCommandAttributes" after a successful command) *** @param command The executed DCServerConfig.Command *** @param cmdSTr The command string sent to the device *** @param update True to update the Device record now. *** @return True if there are changed fields. **/ public boolean postCommandHandling(DCServerConfig.Command command, String cmdStr, boolean update) { /* command valid? */ if (command == null) { return false; } /* expect return acknowledgement */ if (!command.getExpectAck()) { // continue } else if (this.isExpectingCommandAck()) { Print.logWarn("Already expecting an ACK for: " + this.getLastAckCommand()); } else { int ackCode = command.getExpectAckCode(); String cs = !StringTools.isBlank(cmdStr)? StringTools.trim(cmdStr) : command.getCommandString(this,null); this.setExpectAck(true); this.setExpectAckCode(ackCode); this.setLastAckCommand(cmdStr); //this.setLastAckResponse(null); this.setLastAckTime(0L); this.addOtherChangedFieldNames( FLD_expectAck, FLD_expectAckCode, FLD_lastAckCommand, //FLD_lastAckResponse, FLD_lastAckTime); } /* command state bit? */ if (command.hasStateBitMask()) { long bitMask = command.getStateBitMask(); boolean bitVal = command.getStateBitValue(); this._setCommandStateMask(bitMask, bitVal); // FLD_commandStateMask } /* audit event? */ if (command.hasAuditStatusCode()) { int sc = command.getAuditStatusCode(); String acctID = this.getAccountID(); String devID = this.getDeviceID(); long fixtime = DateTime.getCurrentTimeSec(); // now EventData.Key evk = new EventData.Key(acctID, devID, fixtime, sc); EventData evd = evk.getDBRecord(); this.insertEventData(evd); // FLD_?? } /* update changed? */ if (this.hasChangedFieldNames()) { if (update) { try { this.updateOtherChangedEventFields(); } catch (DBException dbe) { Print.logException("Unable to update Device", dbe); } } return true; } else { return false; } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Gets a list of authorised Users for this Device *** @param device The device for which the User list will be returned. *** @return The list of authorized users **/ public static OrderedSet getAuthorizedUsers(Device device) throws DBException { OrderedSet userList = new OrderedSet(); /* no Device? */ if (device == null) { return userList; // empty } String deviceID = device.getDeviceID(); /* get account */ Account account = device.getAccount(); if (account == null) { return userList; // empty } String accountID = device.getAccountID(); /* Get list of all users */ String userIDs[] = User.getUsersForAccount(accountID); if (ListTools.isEmpty(userIDs)) { return userList; // empty } /* save all authorized users */ for (String userID : userIDs) { try { User user = User.getUser(account, userID); if (user.isAuthorizedDevice(deviceID)) { userList.add(user); } } catch (DBException dbe) { // ignore } } /* return list */ return userList; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Deletes old events from EventData table. *** @param priorToTime EventData records up to (but excluding) this timestamp will be deleted. *** @return The number of records deleted **/ public long deleteEventsPriorTo(long priorToTime) throws DBException { /* valid timestamp? */ if (priorToTime <= 0L) { throw new DBException("Invalid 'priorTo' timestamp specified: " + priorToTime); } /* starting event count */ long delEventCount = this.getEventCount(-1L, priorToTime - 1L); /* delete all EventData entries prior to the specified date */ // [DELETE FROM EventData WHERE accountID='account' and deviceID='device' and timestamp DefaultUpdatedFieldsSet = ListTools.toSet(DefaultUpdatedFieldsList); /** *** Creates a list of fields that should be updated for this device *** @param flds The pre-initialized list of fields to update *** @return The final set of fields to update **/ public Set _createChangedFieldsSet(Set flds) throws DBException { Set otherSet = this.getOtherChangedFieldNames(); if ((flds == null) && (otherSet == null)) { return DefaultUpdatedFieldsSet; // minor optimization } else { // make a new copy and add the additional fields Set updFields = ListTools.toSet(DefaultUpdatedFieldsList); if (flds != null) { ListTools.toSet(flds/*from*/, updFields/*to*/); } if (otherSet != null) { ListTools.toSet(otherSet/*from*/, updFields/*to*/); } return updFields; } } /** *** Creates a list of fields that should be updated for this device *** @param flds The pre-initialized list of fields to update *** @return The final set of fields to update **/ public Set _createChangedFieldsSet(String... flds) throws DBException { Set otherSet = this.getOtherChangedFieldNames(); if ((flds == null) && (otherSet == null)) { return DefaultUpdatedFieldsSet; // minor optimization } else { Set updFields = ListTools.toSet(DefaultUpdatedFieldsList); if (flds != null) { ListTools.toSet(flds, updFields); } if (otherSet != null) { ListTools.toSet(otherSet, updFields); } return updFields; } } // -------------------------------- private Set otherChangedFieldsSet = null; /** *** Creates/returns the set that will contains fields to update *** @return The set of fields to update **/ private Set _createOtherChangedFieldsSet() { if (this.otherChangedFieldsSet == null) { this.otherChangedFieldsSet = new HashSet(); } return this.otherChangedFieldsSet; } /** *** Clears the set that will contains fields to update **/ private void _clearOtherChangedFieldsSet() { this.otherChangedFieldsSet = null; } /** *** Returns true if the changed field set has been initialized *** @return True if the changed field set has been initialized **/ public boolean hasChangedFieldNames() { return (this.otherChangedFieldsSet != null); } /** *** Returns the set of fields to update (may be null) *** @return The set of fields to update (may be null) **/ public Set getOtherChangedFieldNames() { return this.otherChangedFieldsSet; // may be null } /** *** Adds the specified list of update fields to the internal set *** @param flds The list of fields to add **/ public void addOtherChangedFieldNames(Set flds) { if (flds != null) { ListTools.toSet(flds, this._createOtherChangedFieldsSet()); } } /** *** Adds the specified list of update fields to the internal set *** @param flds The list of fields to add **/ public void addOtherChangedFieldNames(String... flds) { if (flds != null) { ListTools.toSet(flds, this._createOtherChangedFieldsSet()); } } /** *** Updates all fields specified in the internal update field set **/ public void updateOtherChangedEventFields() throws DBException { Set updSet = this.getOtherChangedFieldNames(); if (updSet != null) { this.update(updSet); this._clearOtherChangedFieldsSet(); } } // -------------------------------- /** *** Updates all fields specified in the internal changed field set **/ public void updateChangedEventFields() throws DBException { this.update(_createChangedFieldsSet((String[])null)); } /** *** Updates the specified changed fields *** @param flds The field set to update **/ public void updateChangedEventFields(Set flds) throws DBException { this.update(_createChangedFieldsSet(flds)); } /** *** Updates the specified changed fields *** @param flds The field set to update **/ public void updateChangedEventFields(String... flds) throws DBException { this.update(_createChangedFieldsSet(flds)); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Insert connection session statistics into the SessionStats table *** @param startTime The time of the session stat *** @param ipAddr The IP address *** @param isDuplex True if TCP/Duplex *** @param bytesRead The number of bytes read *** @param bytesWritten The number of bytes written *** @param evtsRecv The number of events received **/ public void insertSessionStatistic(long startTime, String ipAddr, boolean isDuplex, long bytesRead, long bytesWritten, long evtsRecv) { // save session statistics SessionStatsFactory csf = Device.getSessionStatsFactory(); if (csf != null) { try { csf.addSessionStatistic(this,startTime,ipAddr,isDuplex,bytesRead,bytesWritten,evtsRecv); } catch (DBException dbe) { Print.logError("Session statistic: " + dbe); } } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Validates the syntax of the specified Rule selector *** @param selector The rule selector to check *** @return True if the rule selector is valid **/ public static boolean CheckSelectorSyntax(String selector) { if (StringTools.isBlank(selector)) { // a blank selector should always be valid return true; } else { RuleFactory ruleFact = Device.getRuleFactory(); if (ruleFact != null) { return ruleFact.checkSelectorSyntax(selector); } else { Print.logWarn("No RuleFactory defined"); return false; } } } /** *** Checks the rules which are applicable for the specified event *** @param event The EventData instance to check **/ protected boolean checkEventRules(EventData event) { Account account = this.getAccount(); /* no event? */ if (event == null) { // we have no event, don't bother with the rest //Print.logDebug("No EventData record specified: " + this.getAccountID() + "/" + this.getDeviceID()); return false; } int statusCode = event.getStatusCode(); /* skip rule checks for rule-trigger events */ // to prevent any potential for recursive rule triggers and event insertion if (StatusCodes.IsRuleTrigger(statusCode)) { return false; } /* synthesized events */ boolean isSynthesizedEvent = event.getIsSynthesizedEvent(); //if (isSynthesizedEvent) { // return false; //} /* set device */ // This provides an optimization so that any Account/Device requests on the EventData // record won't have to explicitly query the database to retrieve the Account/Device. event.setDevice(this); /* Entity attach/detach (if installed) */ if (!isSynthesizedEvent && Device.hasEntityManager()) { Device.getEntityManager().insertEntityChange(event); } /* Fuel Manager (if installed) */ if (!isSynthesizedEvent && Device.hasFuelManager()) { FuelManager fm = Device.getFuelManager(); FuelManager.LevelChangeType lvlType = fm.insertFuelLevelChange(event); switch (lvlType) { case INCREASE: // refill if (statusCode != StatusCodes.STATUS_FUEL_REFILL) { // insert synthesized fuel-level change event int fuelCode = StatusCodes.STATUS_FUEL_REFILL; EventData fuelEv = EventData.copySynthesizedEvent(event, fuelCode); if (this.insertEventData(fuelEv)) { // recursive call Print.logWarn("FuelManager: Added new Fuel 'REFILL' Event - " + fuelEv); } else { Print.logError("FuelManager: New Fuel 'REFILL' Event failed!"); } } break; case DECREASE: // theft if (statusCode != StatusCodes.STATUS_FUEL_THEFT) { // insert synthesized fuel-level change event int fuelCode = StatusCodes.STATUS_FUEL_THEFT; EventData fuelEv = EventData.copySynthesizedEvent(event, fuelCode); if (this.insertEventData(fuelEv)) { // recursive call Print.logWarn("FuelManager: Added new Fuel 'THEFT' Event - " + fuelEv); } else { Print.logError("FuelManager: New Fuel 'THEFT' Event failed!"); } } break; case NONE: // no change // no change break; case UNKNOWN: // fuel-level not availabl // unknown (fuel-level not available?) break; } } /* notification not allowed for this device? */ boolean allowNotify = this.getAllowNotify(true); if (!allowNotify) { /* display message if a rule-selector has been specified */ Print.logDebug("Notification disallowed for this device: " + this); //if (!StringTools.isBlank(ruleSelector)) { // Print.logWarn("Notification disallowed [selector = " + ruleSelector + "] " + this); //} else { // //Print.logDebug("Notification disallowed: " + this); //} return false; } /* device rule selector (null if ENRE is present) */ String ruleSelector = Device.CheckNotifySelector()? this.getNotifySelector() : null; /* check for rule factory */ RuleFactory ruleFact = Device.getRuleFactory(); if (ruleFact == null) { /* display message if a rule-selector has been specified */ //if (!StringTools.isBlank(ruleSelector)) { // Print.logWarn("No RuleFactory to process rule: " + ruleSelector); //} else { // //Print.logDebug("RuleFactory not installed: " + this); //} return false; } /* accumulated action mask */ int accumActionMask = RuleFactory.ACTION_NONE; /* check local email notification selector */ // This executes a single selector-based rule. boolean didTrigger = false; if (!StringTools.isBlank(ruleSelector)) { Print.logDebug("Processing Device rule [selector = " + ruleSelector + "] " + this); int actionMask = ruleFact.executeSelector(ruleSelector, event); if (this._setDeviceAction(actionMask, event, null/*Rule*/)) { didTrigger = true; accumActionMask |= actionMask; } } /* test statusCode rule/action list */ // This method allows for a complete check of multiple rules { //Print.logDebug("Executing rules for event: " + this); int actionMask = ruleFact.executeRules(event); if (this._setDeviceAction(actionMask, event, null/*Rule*/)) { didTrigger = true; accumActionMask |= actionMask; } } /* Geozone AutoNotify: convenience geozone arrive/depart notification */ if (StatusCodes.IsGeozoneTransition(statusCode)) { BasicPrivateLabel bpl = Account.getPrivateLabel(account); Geozone zone = event.getGeozone(); if (account == null) { // very unlikely Print.logError("Unable to determine account for Geozone email: " + this.getAccountID() + "/" + this.getDeviceID() + " (zone: " + event.getGeozoneID() + ")"); } else if (bpl == null) { // unlikely Print.logWarn("Unable to determine Account PrivateLabel for Geozone email: " + this.getAccountID() + "/" + this.getDeviceID() + " (zone: " + event.getGeozoneID() + ")"); } else if (zone == null) { // unlikely (DCS is supposed to populate a valid value) Print.logWarn("Geozone status code, but Geozone not found: " + this.getAccountID() + "/" + this.getDeviceID() + " (zone: " + event.getGeozoneID() + ")"); } else if (zone.getAutoNotify()) { // IE: "VehicleName" arrived "DeviceDescription" I18N i18n = I18N.getI18N(Device.class, account.getLocale()); /* time format */ String timeFmt = bpl.getDateFormat() + " " + bpl.getTimeFormat(); //TimeZone tmz = this.getTimeZone(null); TimeZone tmz = Account.getTimeZone(account,DateTime.getGMTTimeZone()); String timeStr = new DateTime(event.getTimestamp()).format(timeFmt,tmz); /* device/geozone description */ String devDesc = this.getDescription(); String zoneDesc = zone.getDescription(); /* message subject/body */ String subj = null; String body = null; if (statusCode == StatusCodes.STATUS_GEOFENCE_ARRIVE) { subj = i18n.getString("Device.autoArriveMessage", "{0}: \"{1}\" arrived \"{2}\"", new String[] { timeStr, devDesc, zoneDesc }); body = subj; } else if (statusCode == StatusCodes.STATUS_GEOFENCE_DEPART) { subj = i18n.getString("Device.autoDepartMessage", "{0}: \"{1}\" departed \"{2}\"", new String[] { timeStr, devDesc, zoneDesc }); body = subj; } else { // unlikely subj = i18n.getString("Device.autoGeozoneMessage", "{0}: \"{1}\" arrived/departed \"{2}\"", new String[] { timeStr, devDesc, zoneDesc }); body = subj; } /* assemble recipient list */ HashSet recipients = new HashSet(); String acctEmail = account.getNotifyEmail(); if (!StringTools.isBlank(acctEmail)) { ListTools.toSet(StringTools.split(acctEmail,','),recipients); } String devEmail = this.getNotifyEmail(false/*inclAcct*/,true/*inclUser*/); if (!StringTools.isBlank(devEmail)) { ListTools.toSet(StringTools.split(devEmail,','),recipients); } StringBuffer toSMS = new StringBuffer(); StringBuffer toEmail = new StringBuffer(); for (String R : recipients) { if (SMSOutboundGateway.StartsWithSMS(R)) { if (toSMS.length() > 0) { toSMS.append(","); } toSMS.append(R.substring(SMSOutboundGateway.SMS_Prefix.length())); } else { if (toEmail.length() > 0) { toEmail.append(","); } toEmail.append(R); } } /* Send email */ String frEmail = bpl.getEventNotificationFrom(); if (StringTools.isBlank(frEmail)) { frEmail = bpl.getEMailAddress(BasicPrivateLabel.EMAIL_TYPE_NOTIFY); if (StringTools.isBlank(frEmail)) { frEmail = bpl.getSmtpProperties().getUserEmail(); } } if (StringTools.isBlank(toEmail)) { Print.logInfo("No email recipients, skipping email ..."); } else if (StringTools.isBlank(frEmail)) { Print.logWarn("No 'From:' email address, skipping email ..."); } else { Print.logInfo("From : " + frEmail); Print.logInfo("To(email): " + toEmail); Print.logInfo("Subject : " + subj); Print.logInfo("Body :\n" + body); try { Print.logInfo("Sending Geozone auto notify email ..."); SendMail.SmtpProperties smtpProps = bpl.getSmtpProperties(); SendMail.send(frEmail,toEmail.toString(),null,null,subj,body,null,smtpProps); } catch (Throwable t) { // NoClassDefFoundException, ClassNotFoundException // this will fail if JavaMail support for SendMail is not available. Print.logWarn("SendMail error: " + t); } } /* send SMS */ if (StringTools.isBlank(toSMS)) { // no SMS destinations } else if (account.getSmsEnabled()) { String smsMsg = subj; Print.logInfo("To(SMS): " + toSMS); Print.logInfo("Message: " + smsMsg); // SMS gateway */ String smsGatewayName = SMSOutboundGateway.GetDefaultGatewayName(); SMSOutboundGateway smsGW = SMSOutboundGateway.GetSMSGateway(smsGatewayName); if (smsGW != null) { Print.logInfo("Sending SMS via gateway: " + smsGatewayName); // list of SMS recipients String smsPhoneList[] = StringTools.split(toSMS,','); for (String smsPhone : smsPhoneList) { if (SMSOutboundGateway.StartsWithSMS(smsPhone)) { smsPhone = smsPhone.substring(SMSOutboundGateway.SMS_Prefix.length()); } if (!StringTools.isBlank(smsPhone)) { Print.logInfo("SMS: " + smsPhone + " --> " + smsMsg); DCServerFactory.ResultCode result = smsGW.sendSMSMessage(account, smsMsg, smsPhone); if (!result.isSuccess()) { Print.logWarn("SMS error: " + result); } } } } else { Print.logWarn("SMS Gateway not found: " + smsGatewayName); } } else { Print.logWarn("SMS notification disabled for account: " + account.getAccountID()); } } } /* return trigger state */ return didTrigger; } /** *** Saves the specified Device action for this Device *** @param actionMask The Action mask *** @param event The EventData instance *** @param ruleID The triggered rule-id *** @return True if saved **/ private boolean _setDeviceAction(int actionMask, EventData event, String ruleID) { /* no action? */ if ((actionMask < 0) || (actionMask == RuleFactory.ACTION_NONE)) { return false; } /* save last triggered notification */ if ((actionMask & RuleFactory.ACTION_SAVE_LAST) != 0) { try { this.setLastNotifyEvent(event, ruleID, false/*update*/); } catch (DBException dbe) { // we are not updating, so this will not occur } } else { // "lastNotifyTime" and "lastNotifyCode" should be left as-is // NOTE: An external DB trigger may have changed these values, and updating // them may end up resetting these back to '0' } /* disable active corridor */ /* if ((actionMask & RuleFactory.ACTION_DISABLE_CORRIDOR) != 0) { if (this.hasActiveCorridor()) { this.setActiveCorridor(""); // FLD_activeCorridor } else { // no active corridor } } */ /* enable new corridor */ /* if ((actionMask & RuleFactory.ACTION_ENABLE_CORRIDOR) != 0) { Geozone zone = event.getGeozone(); if ((zone != null) && zone.hasCorridorID()) { this.setActiveCorridor(zone.getCorridorID()); // FLD_activeCorridor } else { // leave as-is } } */ // changes not yet saved return true; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // Optimization for StatusCode description lookup (typically for map display) // This is a temporary cache of StatusCodes that are used for Events which // are either displayed on a map, or in a report. Access to this cache does not need // to be synchronized since all status code lookups will occur within the same thread. // This cache is temporary and is garbage collected along with this Device record. private Map cacheStatusCodeMap = null; /** *** Gets the StatusCode instance for the specified code *** @param code The numeric status code value *** @return The StatusCode instance **/ public StatusCode getStatusCode(int code) { /* create map */ if (this.cacheStatusCodeMap == null) { this.cacheStatusCodeMap = new HashMap(); } /* already in cache */ Integer codeKey = new Integer(code); if (this.cacheStatusCodeMap.containsKey(codeKey)) { return this.cacheStatusCodeMap.get(codeKey); // may return null; } /* add to cache */ String accountID = this.getAccountID(); String deviceID = this.getDeviceID(); StatusCode sc = StatusCode.findStatusCode(accountID, deviceID, code); this.cacheStatusCodeMap.put(new Integer(code), sc); return sc; // may be null; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Gets and array of the attached Entity IDs which are attached to this Device *** @param etype The EntityType *** @return The array of Entity IDs **/ public String[] getAttachedEntityIDs(EntityManager.EntityType etype) { EntityManager.EntityType et = EntityManager.getEntityType(etype); return this.getAttachedEntityIDs(et.getIntValue()); } /** *** Gets and array of the attached Entity IDs which are attached to this Device *** @param entityType The EntityType *** @return The array of Entity IDs **/ public String[] getAttachedEntityIDs(int entityType) { if (Device.hasEntityManager()) { String attEnt[] = null; try { String acctID = this.getAccountID(); String devID = this.getDeviceID(); attEnt = Device.getEntityManager().getAttachedEntityIDs(acctID, devID, entityType); } catch (DBException dbe) { Print.logException("Error reading Device Entities", dbe); } return attEnt; } else { return null; } } // ------------------------------------------------------------------------ /** *** Gets and array of the attached Entity Descriptions which are attached to this Device *** @param etype The EntityType *** @return The array of Entity IDs **/ public String[] getAttachedEntityDescriptions(EntityManager.EntityType etype) { EntityManager.EntityType et = EntityManager.getEntityType(etype); return this.getAttachedEntityDescriptions(et.getIntValue()); } /** *** Gets and array of the attached Entity Descriptions which are attached to this Device *** @param entityType The EntityType *** @return The array of Entity IDs **/ public String[] getAttachedEntityDescriptions(int entityType) { if (Device.hasEntityManager()) { String attEnt[] = null; try { String acctID = this.getAccountID(); String devID = this.getDeviceID(); attEnt = Device.getEntityManager().getAttachedEntityDescriptions(acctID, devID, entityType); } catch (DBException dbe) { Print.logException("Error reading Device Entities", dbe); } return attEnt; } else { return null; } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ private EventData cachedRangeEvents[] = null; /** *** Gets the saved list of cached events *** @return The list of events to cache **/ public EventData[] getSavedRangeEvents() { return this.cachedRangeEvents; } /** *** Sets the saved list of cached events *** @param events The list of events to cache **/ public void setSavedRangeEvents(EventData events[]) { this.cachedRangeEvents = events; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Gets an array of events for the specified range and attributes *** @param timeStart The event start time *** @param timeEnd The event end time *** @param statusCodes The list of status-codes *** @param validGPS True to read only events with valid GPS locations *** @param limitType The limit type (FIRST, LAST) *** @param limit The maximum number of events to return *** @return The array of EventData records *** @throws DBException **/ public EventData[] getRangeEvents( long timeStart, long timeEnd, int statusCodes[], boolean validGPS, EventData.LimitType limitType, long limit) throws DBException { /* get data */ EventData ev[] = EventData.getRangeEvents( this.getAccountID(), this.getDeviceID(), timeStart, timeEnd, statusCodes, validGPS, limitType, limit, true/*ascending*/, null/*additionalSelect*/); /* apply current Device to all EventData records */ if (ev != null) { for (int i = 0; i < ev.length; i++) { ev[i].setDevice(this); } } return ev; } /** *** Gets an array of events for the specified range and attributes *** @param timeStart The event start time *** @param timeEnd The event end time *** @param validGPS True to read only events with valid GPS locations *** @param limitType The limit type (FIRST, LAST) *** @param limit The maximum number of events to return *** @return The array of EventData records *** @throws DBException **/ public EventData[] getRangeEvents( long timeStart, long timeEnd, boolean validGPS, EventData.LimitType limitType, long limit) throws DBException { return this.getRangeEvents( timeStart, timeEnd, null/*statusCodes*/, validGPS, limitType, limit); } /** *** Gets an array of EventData records *** @param limit The maximum number of events to return *** @param validGPS True to read only events with valid GPS locations *** @return The array of EventData records **/ public EventData[] getLatestEvents(long limit, boolean validGPS) throws DBException { long timeStart = -1L; long timeEnd = -1L; return this.getRangeEvents( timeStart, timeEnd, null/*statusCodes*/, validGPS, EventData.LimitType.LAST, limit); } // ------------------------------------------------------------------------ /** *** Gets the first EventData record greater-than or equal-to the specified start time *** @param startTime The event start time *** @param validGPS True to only return the first event with a valid GPS *** @return The EventData record **/ public EventData getFirstEvent(long startTime, boolean validGPS) throws DBException { long endTime = -1L; EventData ev[] = EventData.getRangeEvents( this.getAccountID(), this.getDeviceID(), startTime, endTime, null/*statusCodes[]*/, validGPS, EventData.LimitType.FIRST, 1, true, null/*additionalSelect*/); if ((ev == null) || (ev.length <= 0)) { return null; } else { ev[0].setDevice(this); return ev[0]; } } // ------------------------------------------------------------------------ /** *** Gets the last EventData record in the EventData table for this Device *** @param validGPS True to only return the last event with a valid GPS *** @return The EventData record **/ public EventData getLastEvent(boolean validGPS) throws DBException { // TODO: cache this event? return this.getLastEvent(null, -1L, validGPS); } /** *** Gets the last EventData record in the EventData table for this Device *** @param endTime Return the EventData record less-than or equal-to this time *** @param validGPS True to only return the last event with a valid GPS *** @return The EventData record **/ public EventData getLastEvent(long endTime, boolean validGPS) throws DBException { return this.getLastEvent(null, endTime, validGPS); } /** *** Gets the last EventData record in the EventData table for this Device *** @param statusCodes Return the last event that matches one of these status codes *** @return The EventData record **/ public EventData getLastEvent(int statusCodes[]) throws DBException { return this.getLastEvent(statusCodes, -1L, false); } /** *** Gets the last EventData record in the EventData table for this Device *** @param statusCodes Return the last event that matches one of these status codes *** @param endTime Return the EventData record less-than or equal-to this time *** @param validGPS True to only return the last event with a valid GPS *** @return The EventData record **/ public EventData getLastEvent(int statusCodes[], long endTime, boolean validGPS) throws DBException { long startTime = -1L; EventData ev[] = EventData.getRangeEvents( this.getAccountID(), this.getDeviceID(), startTime, endTime, statusCodes, validGPS, EventData.LimitType.LAST, 1, true, null/*additionalSelect*/); if ((ev == null) || (ev.length <= 0)) { return null; } else { ev[0].setDevice(this); return ev[0]; } } // ------------------------------------------------------------------------ /** *** EventDataHandler interface **/ public interface EventDataHandler { public void handleEventDataRecord(EventData ev); } /** *** Reprocesses a range of EventData reocrds *** @param timeStart The start time *** @param timeEnd The end time *** @param edh The callback EventDataHandler instance **/ public void reprocessEventDataRecords(long timeStart, long timeEnd, final EventDataHandler edh) throws DBException { EventData.getRangeEvents( this.getAccountID(), this.getDeviceID(), timeStart, timeEnd, null/*statusCodes*/, false/*validGPS*/, EventData.LimitType.LAST, -1L/*limit*/, true/*ascending*/, null/*additionalSelect*/, new DBRecordHandler() { public int handleDBRecord(EventData rcd) throws DBException { edh.handleEventDataRecord(rcd); return DBRecordHandler.DBRH_SKIP; } }); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Save this Device to db storage **/ public void save() throws DBException { /* save */ super.save(); if (this.transport != null) { this.transport.save(); } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Return a String representation of this Device *** @return The String representation **/ public String toString() { return this.getAccountID() + "/" + this.getDeviceID(); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ private Transport transport = null; /** *** Sets the Transport for this Device *** @param xport The Transport instance **/ public void setTransport(Transport xport) { this.transport = xport; } /** *** Gets the Transport-ID for this Device (if any) *** @return The Transport-ID for this Device, or an empty string is not defined **/ public String getTransportID() { return (this.transport != null)? this.transport.getTransportID() : ""; } /** *** Gets the DataTransport for this Device *** @return The DataTransport for this Device **/ public DataTransport getDataTransport() { return (this.transport != null)? (DataTransport)this.transport : (DataTransport)this; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Count the number of events prior to the specified time *** @param oldTimeSec The timestamp before which events will be counted *** @return The number of events counted **/ public long countOldEvents(long oldTimeSec) throws DBException { String acctID = this.getAccountID(); String devID = this.getDeviceID(); long count = EventData.getRecordCount(acctID, devID, -1L/*startTime*/, oldTimeSec); return count; } // ------------------------------------------------------------------------ /** *** Delete events prior to the specified time *** @param oldTimeSec The timestamp before which events will be deleted *** @param logMsg A StringBuffer instance into which deletion log messages are placed. *** @return The number of events deleted **/ public long deleteOldEvents( long oldTimeSec, StringBuffer logMsg) throws DBException { return EventData.deleteOldEvents(this, oldTimeSec, logMsg); } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /* reload override (from DBRecord.java) */ protected Device _reload(String... fldNames) throws DBException { super._reload(fldNames); /* clear cached items */ this.cacheIgnitionState = -2; this.cacheWorkHours = null; this.cacheStatusCodeMap = null; //this.cachedRangeEvents = null; <== explicitly set, no need to clear return this; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ /** *** Returns true if the specified record exists *** @param acctID The Account ID *** @param devID The Device ID *** @return True if the record exists **/ public static boolean exists(String acctID, String devID) throws DBException // if error occurs while testing existence { if ((acctID != null) && (devID != null)) { Device.Key devKey = new Device.Key(acctID, devID); return devKey.exists(); } return false; } // ------------------------------------------------------------------------ /** *** This method is used to load a Device record based on the SIM phone number. *** Intended for use by an incoming SMS message handler. *** It is up to the caller to check whether this Device or Account are inactive. *** @param simPhone The SIM phone number of the device *** @return The loaded Device instance, or null if the Device was not found *** @throws DBException if a database error occurs **/ public static Device loadDeviceBySimPhoneNumber(String simPhone) throws DBException { /* invalid id? */ if ((simPhone == null) || simPhone.equals("")) { return null; // just say it doesn't exist } /* read device for simPhone */ Device dev = null; DBConnection dbc = null; Statement stmt = null; ResultSet rs = null; try { /* select */ // DBSelect: SELECT * FROM Device WHERE (simPhoneNumber='') DBSelect dsel = new DBSelect(Device.getFactory()); DBWhere dwh = dsel.createDBWhere(); dsel.setWhere(dwh.WHERE_(dwh.EQ(Device.FLD_simPhoneNumber,simPhone))); dsel.setLimit(2); // Note: The index on the column FLD_simPhoneNumber does not enforce uniqueness // (since null/empty values are allowed and needed) /* get record */ dbc = DBConnection.getDefaultConnection(); stmt = dbc.execute(dsel.toString()); rs = stmt.getResultSet(); while (rs.next()) { String acctId = rs.getString(FLD_accountID); String devId = rs.getString(FLD_deviceID); dev = new Device(new Device.Key(acctId,devId)); dev.setAllFieldValues(rs); if (rs.next()) { Print.logError("Found multiple occurances of this SIM phone number: " + simPhone); } break; // only one record } // it's possible at this point that we haven't even read 1 device } catch (SQLException sqe) { throw new DBException("Getting Device SIM phone number: " + simPhone, sqe); } finally { if (rs != null) { try { rs.close(); } catch (Throwable t) {} } if (stmt != null) { try { stmt.close(); } catch (Throwable t) {} } DBConnection.release(dbc); } /* return device */ // Note: 'dev' may be null if it wasn't found return dev; } // ------------------------------------------------------------------------ /** *** This method is called by "Transport.loadDeviceByUniqueID(String)" to load a Device *** within a Device Communication Server, based on a Unique-ID. It is up to the caller *** to check whether this Device or Account are inactive. *** @param uniqId The Unique-ID of the device (ie. IMEI, ESN, Serial#, etc) *** @return The loaded Device instance, or null if the Device was not found *** @throws DBException if a database error occurs **/ public static Device loadDeviceByUniqueID(String uniqId) throws DBException { /* invalid id? */ if ((uniqId == null) || uniqId.equals("")) { return null; // just say it doesn't exist } /* read device for unique-id */ Device dev = null; DBConnection dbc = null; Statement stmt = null; ResultSet rs = null; try { /* select */ // DBSelect: SELECT * FROM Device WHERE (uniqueID='unique') DBSelect dsel = new DBSelect(Device.getFactory()); DBWhere dwh = dsel.createDBWhere(); dsel.setWhere(dwh.WHERE_(dwh.EQ(Device.FLD_uniqueID,uniqId))); dsel.setLimit(2); // Note: The index on the column FLD_uniqueID does not enforce uniqueness // (since null/empty values are allowed and needed) /* get record */ dbc = DBConnection.getDefaultConnection(); stmt = dbc.execute(dsel.toString()); rs = stmt.getResultSet(); while (rs.next()) { String acctId = rs.getString(FLD_accountID); String devId = rs.getString(FLD_deviceID); dev = new Device(new Device.Key(acctId,devId)); dev.setAllFieldValues(rs); if (rs.next()) { Print.logError("Found multiple occurances of this unique-id: " + uniqId); } break; // only one record } // it's possible at this point that we haven't even read 1 device } catch (SQLException sqe) { throw new DBException("Getting Device unique-id: " + uniqId, sqe); } finally { if (rs != null) { try { rs.close(); } catch (Throwable t) {} } if (stmt != null) { try { stmt.close(); } catch (Throwable t) {} } DBConnection.release(dbc); } /* return device */ // Note: 'dev' may be null if it wasn't found return dev; } // ------------------------------------------------------------------------ /** *** This method is called by "Transport.loadDeviceByTransportID(...)" to load a Device *** within a Device Communication Server, based on the Account and Device IDs. *** @param account The Account instance representing the owning account *** @param devID The Device-ID *** @return The loaded Device instance, or null if the Device was not found *** @throws DBException if a database error occurs **/ public static Device loadDeviceByName(Account account, String devID) throws DBException { Device dev = Device.getDevice(account, devID); return dev; } // ------------------------------------------------------------------------ /** *** Gets the specified Device record *** @param account The Account *** @param devID The Device ID *** @return The Device record **/ public static Device getDevice(Account account, String devID) throws DBException { if ((account != null) && (devID != null)) { String acctID = account.getAccountID(); Device.Key key = new Device.Key(acctID, devID); if (key.exists()) { Device dev = key.getDBRecord(true); dev.setAccount(account); return dev; } else { // device does not exist return null; } } else { return null; // just say it doesn't exist } } /** *** Gets or Creates a Device record *** @param account The Account *** @param devID The Device ID *** @param create True to create the Device if it does not already exist *** @return The Device record *** @throws DBExeption **/ public static Device getDevice(Account account, String devID, boolean create) throws DBException { /* account-id specified? */ if (account == null) { throw new DBNotFoundException("Account not specified."); } String acctID = account.getAccountID(); /* device-id specified? */ if (StringTools.isBlank(devID)) { throw new DBNotFoundException("Device-ID not specified for account: " + acctID); } /* get/create */ Device dev = null; Device.Key devKey = new Device.Key(acctID, devID); if (!devKey.exists()) { if (create) { dev = devKey.getDBRecord(); dev.setAccount(account); dev.setCreationDefaultValues(); return dev; // not yet saved! } else { throw new DBNotFoundException("Device-ID does not exists: " + devKey); } } else if (create) { // we've been asked to create the device, and it already exists throw new DBAlreadyExistsException("Device-ID already exists '" + devKey + "'"); } else { dev = Device.getDevice(account, devID); if (dev == null) { throw new DBException("Unable to read existing Device-ID: " + devKey); } return dev; } } // ------------------------------------------------------------------------ /** *** Create/Save Device record *** @param account The Account *** @param devID The Device ID *** @param uniqueID The Device Unique ID *** @return The Device record *** @throws DBExeption **/ public static Device createNewDevice(Account account, String devID, String uniqueID) throws DBException { if ((account != null) && !StringTools.isBlank(devID)) { Device dev = Device.getDevice(account, devID, true); // does not return null if (!StringTools.isBlank(uniqueID)) { dev.setUniqueID(uniqueID); } dev.save(); return dev; } else { throw new DBException("Invalid Account/DeviceID specified"); } } /** *** (EXPERIMENTAL) Creates a virtual Device record *** @param acctID The Account ID *** @param devID The Device ID *** @return The Device record **/ public static Device createVirtualDevice(String acctID, String devID) { /* get/create */ Device.Key devKey = new Device.Key(acctID, devID); Device dev = devKey.getDBRecord(); dev.setCreationDefaultValues(); dev.setVirtual(true); return dev; } // ------------------------------------------------------------------------ /** *** Gets a set of Device IDs for the specified Account (oes not return null) *** @param acctId The Account ID *** @param userAuth The User record *** @param inclInactv True to include inactive Devices *** @return A set of Device IDs *** @throws DBExeption **/ public static OrderedSet getDeviceIDsForAccount(String acctId, User userAuth, boolean inclInactv) throws DBException { return Device.getDeviceIDsForAccount(acctId, userAuth, inclInactv, -1L); } /** *** Gets a set of Device IDs for the specified Account (oes not return null) *** @param acctId The Account ID *** @param userAuth The User record *** @param inclInactv True to include inactive Devices *** @param limit The maximum number of Device IDs to return *** @return A set of Device IDs *** @throws DBExeption **/ public static OrderedSet getDeviceIDsForAccount(String acctId, User userAuth, boolean inclInactv, long limit) throws DBException { /* no account specified? */ if (StringTools.isBlank(acctId)) { if (userAuth != null) { acctId = userAuth.getAccountID(); } else { Print.logError("Account not specified!"); return new OrderedSet(); } } /* read devices for account */ OrderedSet devList = new OrderedSet(); DBConnection dbc = null; Statement stmt = null; ResultSet rs = null; try { /* select */ // DBSelect: SELECT * FROM Device WHERE (accountID='acct') ORDER BY deviceID DBSelect dsel = new DBSelect(Device.getFactory()); dsel.setSelectedFields(Device.FLD_deviceID); DBWhere dwh = dsel.createDBWhere(); if (inclInactv) { dsel.setWhere(dwh.WHERE( dwh.EQ(Device.FLD_accountID,acctId) )); } else { dsel.setWhere(dwh.WHERE_( dwh.AND( dwh.EQ(Device.FLD_accountID,acctId), dwh.NE(Device.FLD_isActive,0) ) )); } dsel.setOrderByFields(Device.FLD_deviceID); dsel.setLimit(limit); /* get records */ dbc = DBConnection.getDefaultConnection(); stmt = dbc.execute(dsel.toString()); rs = stmt.getResultSet(); while (rs.next()) { String devId = rs.getString(Device.FLD_deviceID); if ((userAuth == null) || userAuth.isAuthorizedDevice(devId)) { devList.add(devId); } } } catch (SQLException sqe) { throw new DBException("Getting Account Device List", sqe); } finally { if (rs != null) { try { rs.close(); } catch (Throwable t) {} } if (stmt != null) { try { stmt.close(); } catch (Throwable t) {} } DBConnection.release(dbc); } /* return list */ return devList; } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // This section supports a method for obtaining human readable information from // the Device record for reporting, or email purposes. (currently this is // used by the 'rules' engine when generating notification emails). private static final String KEY_DEVICE[] = EventData.KEY_DEVICE; private static final String KEY_DEVICE_LINK[] = EventData.KEY_DEVICE_LINK; private static final String KEY_DEV_CONN_AGE[] = EventData.KEY_DEV_CONN_AGE; private static final String KEY_DEV_TRAILERS[] = EventData.KEY_DEV_TRAILERS; public static final String KEY_LICENSE_PLATE[] = new String[] { "licensePlate" }; // "ABC123" private static final String KEY_EVENT_COUNT24[] = EventData.KEY_EVENT_COUNT24; private static final String KEY_LAST_EPS[] = new String[] { "lastEventsPerSecond", "lastEPS", "eventsPerSecond" }; private static final String KEY_LAST_EPH[] = new String[] { "lastEventsPerHour" , "lastEPH", "eventsPerHour" }; private static final String KEY_DRIVERID[] = EventData.KEY_DRIVERID; private static final String KEY_DRIVER_DESC[] = EventData.KEY_DRIVER_DESC; public static final String KEY_DRIVER_BADGE[] = EventData.KEY_DRIVER_BADGE; public static final String KEY_DRIVER_LICENSE[]= EventData.KEY_DRIVER_LICENSE; private static final String KEY_FAULT_CODE[] = EventData.KEY_FAULT_CODE; private static final String KEY_FAULT_CODES[] = EventData.KEY_FAULT_CODES; private static final String KEY_FUEL_LEVEL[] = new String[] { "fuelLevel" }; // "25.0 %" private static final String KEY_LAST_FUEL_LEV[] = new String[] { "lastFuelLevel" }; // "25.0 %" private static final String KEY_FUEL_VOLUME[] = new String[] { "fuelLevelVolume" , "fuelVolume" }; // "12 gal" private static final String KEY_LAST_FUEL_VOL[] = new String[] { "lastFuelLevelVolume", "lastFuelVolume" }; // "12 gal" private static final String KEY_CORRIDORID[] = new String[] { "activeCorridor" , "corridorID" }; // "freeway" private static final String KEY_STOP_ELAPSED[] = new String[] { "stopElapsed" , "timeStopped" }; private static final String KEY_SPEED_LIMIT[] = new String[] { "devSpeedLimit" , "speedLimit" }; private static final String KEY_REMINDER[] = new String[] { "reminderMessage" , "reminder" }; private static final String KEY_COMMAND_STATE[] = new String[] { "commandState" }; private static final String KEY_COMMAND_TIME[] = new String[] { "commandDateTime" , "commandTime", "pingDateTime"}; private static final String KEY_ACK_DATETIME[] = new String[] { "ackDateTime" }; private static final String KEY_CUSTOM[] = new String[] { "custom" }; /** *** Gets the field title for the specified key *** @param key The key *** @param arg The type parameter *** @param locale The Locale *** @return The title **/ public static String getKeyFieldTitle(String key, String arg, Locale locale) { return Device._getKeyFieldString( true/*title*/, key, arg, locale, null/*BasicPrivateLabel*/, null/*Device*/); } /** *** Gets the field value for the specified key *** @param key The key *** @param arg The type parameter *** @param bpl The BasicPrivateLabel *** @return The value **/ public String getKeyFieldValue(String key, String arg, BasicPrivateLabel bpl) { Locale locale = (bpl != null)? bpl.getLocale() : null; return Device._getKeyFieldString( false/*value*/, key, arg, locale, bpl, this); } /** *** Gets the field title/value for the specified key *** @param getTitle True to get the title, false for value *** @param key The key *** @param arg The type parameter *** @param locale The Locale *** @param bpl The BasicPrivateLabel *** @param dev The Device record *** @return The title/value **/ public static String _getKeyFieldString( boolean getTitle, String key, String arg, Locale locale, BasicPrivateLabel bpl, Device dev) { /* check for valid field name */ if (key == null) { return null; } else if ((dev == null) && !getTitle) { return null; } if ((locale == null) && (bpl != null)) { locale = bpl.getLocale(); } I18N i18n = I18N.getI18N(Device.class, locale); long now = DateTime.getCurrentTimeSec(); /* Device values */ if (EventData._keyMatch(key,Device.KEY_DEVICE)) { if (getTitle) { return i18n.getString("Device.key.deviceDescription", "Device"); } else { return dev.getDescription(); } } else if (EventData._keyMatch(key,Device.KEY_DEVICE_LINK)) { if (getTitle) { return i18n.getString("Device.key.deviceLink", "Device Link"); } else { String url = dev.getLinkURL(); String dsc = StringTools.blankDefault(dev.getLinkDescription(), i18n.getString("Device.key.link", "Link")); if (StringTools.isBlank(url)) { return ""; } else if (StringTools.isBlank(arg) || arg.equalsIgnoreCase("a") || // "anchor" arg.equalsIgnoreCase("html") ) { if (!StringTools.isBlank(url)) { return EventUtil.MAP_ESCAPE_HTML+""+dsc+""; } else { return EventUtil.MAP_ESCAPE_HTML+""+dsc+""; } } else if (arg.equalsIgnoreCase("plain") || arg.equalsIgnoreCase("desc") ) { return dsc + ": " + url; } else { // "url" return url; } } } else if (EventData._keyMatch(key,Device.KEY_DEV_CONN_AGE)) { if (getTitle) { return i18n.getString("Device.key.sinceLastConnect", "Since Connection"); } else { // HHH:MM:SS long lastConnectTime = dev.getLastTotalConnectTime(); if (lastConnectTime <= 0L) { return "--:--:--"; } long ageSec = DateTime.getCurrentTimeSec() - lastConnectTime; if (ageSec < 0L) { ageSec = 0L; } long hours = (ageSec ) / 3600L; long min = (ageSec % 3600L) / 60L; long sec = (ageSec % 60L); StringBuffer sb = new StringBuffer(); sb.append(hours).append(":"); if (min < 10) { sb.append("0"); } sb.append(min ).append(":"); if (sec < 10) { sb.append("0"); } sb.append(sec ); return sb.toString(); } } else if (EventData._keyMatch(key,Device.KEY_DEV_TRAILERS)) { if (getTitle) { return i18n.getString("Device.key.attachedTrailers", "Attached Trailers"); } else { String e[] = dev.getAttachedEntityDescriptions(EntityManager.EntityType.TRAILER); if (!ListTools.isEmpty(e)) { return StringTools.join(e,","); } else { return ""; } } } else if (EventData._keyMatch(key,Device.KEY_LICENSE_PLATE)) { if (getTitle) { return i18n.getString("Device.key.licensePlate", "License Plate"); } else { return dev.getLicensePlate(); } } else if (EventData._keyMatch(key,Device.KEY_EVENT_COUNT24)) { if (getTitle) { return i18n.getString("Device.key.24HourEventCount", "24Hr Event Count"); } else { String a[] = StringTools.split(arg,','); int sinceHH = (a.length > 1)? StringTools.parseInt(a[0],24) : 24; int statCodes[] = ((a.length > 2) && !StringTools.isBlank(a[1]))? new int[] { StringTools.parseInt(a[1],StatusCodes.STATUS_NONE) } : null; long timeStart = now - DateTime.HourSeconds((sinceHH > 0)? sinceHH : 24); long timeEnd = -1L; long recordCount = -1L; try { recordCount = EventData.countRangeEvents( dev.getAccountID(), dev.getDeviceID(), timeStart, timeEnd, statCodes, false/*validGPS*/, EventData.LimitType.LAST/*limitType*/, -1L/*limit*/, // no limit null/*where*/); } catch (DBException dbe) { Print.logError("Unable to obtain EventData record count [" + dbe); } return String.valueOf(recordCount); } } else if (EventData._keyMatch(key,Device.KEY_LAST_EPS)) { // 2.5.1-B31 if (getTitle) { return i18n.getString("Device.key.lastEventsPerSecond", "Events/Sec"); } else { double eps = dev.getAgedEventsPerSecond(System.currentTimeMillis()); if (eps <= 0.0) { return i18n.getString("Device.notAvailable", "n/a"); } else { return StringTools.format(eps,"0.000"); } } } else if (EventData._keyMatch(key,Device.KEY_LAST_EPH)) { // 2.5.1-B31 if (getTitle) { return i18n.getString("Device.key.lastEventsPerHour", "Events/Hour"); } else { double eps = dev.getAgedEventsPerSecond(System.currentTimeMillis()); if (eps <= 0.0) { return i18n.getString("Device.notAvailable", "n/a"); } else { double eph = eps * 60.0 * 60.0; return StringTools.format(eph,"0.0"); } } } /* fuel */ if (EventData._keyMatch(key,Device.KEY_FUEL_LEVEL)) { if (getTitle) { return i18n.getString("Device.key.fuelLevel", "Fuel Level"); } else { double level = dev.getLastFuelLevel(); if (level < 0.0) { return i18n.getString("Device.notAvailable", "n/a"); } else { long pct = Math.round(level * 100.0); return pct+"%"; } } } else if (EventData._keyMatch(key,Device.KEY_LAST_FUEL_LEV)) { if (getTitle) { return i18n.getString("Device.key.lastFuelLevel", "Last Fuel Level"); } else { double level = dev.getLastFuelLevel(); if (level < 0.0) { return i18n.getString("Device.notAvailable", "n/a"); } else { long pct = Math.round(level * 100.0); return pct+"%"; } } } else if (EventData._keyMatch(key,Device.KEY_FUEL_VOLUME)) { if (getTitle) { return i18n.getString("Device.key.fuelVolume", "Fuel Volume"); } else { Account.VolumeUnits vu = Account.getVolumeUnits(dev.getAccount()); double L = dev.getFuelCapacity() * dev.getLastFuelLevel(); double V = vu.convertFromLiters(L); return StringTools.format(V,"0.0") + " " + vu.toString(locale); } } else if (EventData._keyMatch(key,Device.KEY_LAST_FUEL_VOL)) { if (getTitle) { return i18n.getString("Device.key.lastFuelVolume", "Last Fuel Volume"); } else { Account.VolumeUnits vu = Account.getVolumeUnits(dev.getAccount()); double L = dev.getFuelCapacity() * dev.getLastFuelLevel(); double V = vu.convertFromLiters(L); return StringTools.format(V,"0.0") + " " + vu.toString(locale); } } /* Driver */ if (EventData._keyMatch(key,Device.KEY_DRIVERID)) { if (getTitle) { return i18n.getString("Device.key.driverID", "Driver ID"); } else { // first check DriverID String driverID = dev.getDriverID(); if (!StringTools.isBlank(driverID)) { return driverID; } // next try attached Driver Entities String d[] = dev.getAttachedEntityIDs(EntityManager.EntityType.DRIVER); if (!ListTools.isEmpty(d)) { return StringTools.join(d,","); } // return blank return ""; } } else if (EventData._keyMatch(key,Device.KEY_DRIVER_DESC)) { if (getTitle) { return i18n.getString("Device.key.driverDescription", "Driver"); } else { // first check DriverID String driverID = dev.getDriverID(); if (!StringTools.isBlank(driverID)) { Driver driver = dev.getDriver(); if (driver != null) { return driver.getDescription(); } else { Print.logDebug("Unable to read Driver: " + driverID); return driverID; } } // next try attached Driver Entities String d[] = dev.getAttachedEntityDescriptions(EntityManager.EntityType.DRIVER); if (!ListTools.isEmpty(d)) { return StringTools.join(d,","); } // return blank return ""; } } else if (EventData._keyMatch(key,Device.KEY_DRIVER_BADGE)) { if (getTitle) { return i18n.getString("Device.key.driverBadge", "Driver Badge"); } else { String driverID = dev.getDriverID(); if (!StringTools.isBlank(driverID)) { Driver driver = dev.getDriver(); if (driver != null) { return driver.getBadgeID(); } else { Print.logDebug("Unable to read Driver: " + driverID); return driverID; } } // return blank return ""; } } else if (EventData._keyMatch(key,Device.KEY_DRIVER_LICENSE)) { if (getTitle) { return i18n.getString("Device.key.driverLicense", "Driver License"); } else { String driverID = dev.getDriverID(); if (!StringTools.isBlank(driverID)) { Driver driver = dev.getDriver(); if (driver != null) { return driver.getLicenseNumber(); } else { Print.logDebug("Unable to read Driver: " + driverID); return driverID; } } // return blank return ""; } } /* OBD fault values */ if (EventData._keyMatch(key,Device.KEY_FAULT_CODES)) { if (getTitle) { return i18n.getString("Device.key.faultCodes", "Fault Codes"); } else { String fault = dev.getLastFaultCode().toUpperCase(); if (!StringTools.isBlank(fault)) { RTProperties rtpFault = new RTProperties(fault); return DTOBDFault.GetFaultString(rtpFault); } // return blank return ""; } } else if (EventData._keyMatch(key,Device.KEY_FAULT_CODE)) { if (getTitle) { return i18n.getString("Device.key.faultCodes", "Fault Codes"); } else { String fault = dev.getLastFaultCode().toUpperCase(); if (!StringTools.isBlank(fault)) { RTProperties rtpFault = new RTProperties(fault); return DTOBDFault.GetFaultString(rtpFault); } // return blank return ""; } } /* Misc */ if (EventData._keyMatch(key,Device.KEY_CORRIDORID)) { if (getTitle) { return i18n.getString("Device.key.activeCorridor", "Active Corridor"); } else { String actvCorr = dev.getActiveCorridor(); return actvCorr; } } else if (EventData._keyMatch(key,Device.KEY_STOP_ELAPSED)) { if (getTitle) { return i18n.getString("Device.key.stopElapsed", "Stop Elapsed"); } else { long startTime = dev.getLastStartTime(); long stopTime = dev.getLastStopTime(); boolean isStopped = ((stopTime > 0L) && (stopTime > startTime)); long stopDelta = isStopped? (DateTime.getCurrentTimeSec() - stopTime) : 0L; if (stopDelta <= 0L) { return ""; } else { return StringTools.formatElapsedSeconds(stopDelta,StringTools.ELAPSED_FORMAT_HHMMSS); } } } else if (EventData._keyMatch(key,Device.KEY_SPEED_LIMIT)) { if (getTitle) { return i18n.getString("Device.key.speedLimit", "Speed Limit"); } else { double kph = dev.getSpeedLimitKPH(); if (kph <= 0.0) { // still <= 0.0 return i18n.getString("Device.notAvailable", "n/a"); } Account account = dev.getAccount(); if (account != null) { return account.getSpeedString(kph,true,locale); } else { return StringTools.format(kph,"0") + " " + Account.SpeedUnits.KPH.toString(locale); } } } /* reminder */ if (EventData._keyMatch(key,Device.KEY_REMINDER)) { if (getTitle) { return i18n.getString("Device.key.reminder", "Reminder"); } else { String reminder = dev.getReminderMessage(); return StringTools.trim(reminder); } } /* command state */ if (EventData._keyMatch(key,Device.KEY_COMMAND_STATE)) { int bitNdx = StringTools.parseInt(arg,0); if (getTitle) { return i18n.getString("EventData.key.commandState", "Command State #{0}", String.valueOf(bitNdx)); } else { return dev.getCommandStateMaskBit(bitNdx)? AccountRecord.GetSimpleLocalString("true" ,locale) : AccountRecord.GetSimpleLocalString("false",locale); } } /* ping time */ if (EventData._keyMatch(key,Device.KEY_COMMAND_TIME)) { if (getTitle) { return i18n.getString("EventData.key.commandTime", "Command Time"); } else { long T = dev.getLastPingTime(); Account acct = dev.getAccount(); //TimeZone tmz = dev.getTimeZone(null); TimeZone tmz = (acct != null)? acct.getTimeZone(null) : DateTime.getGMTTimeZone(); return EventData.getTimestampString(T, acct, tmz, bpl); } } /* ack time */ if (EventData._keyMatch(key,Device.KEY_ACK_DATETIME)) { if (getTitle) { return i18n.getString("EventData.key.ackTime", "Ack Time"); } else { long T = dev.getLastAckTime(); Account acct = dev.getAccount(); //TimeZone tmz = dev.getTimeZone(null); TimeZone tmz = (acct != null)? acct.getTimeZone(null) : DateTime.getGMTTimeZone(); return EventData.getTimestampString(T, acct, tmz, bpl); } } /* custom */ if (EventData._keyMatch(key,Device.KEY_CUSTOM)) { if (getTitle) { if (!StringTools.isBlank(arg) && (bpl != null)) { String K = BasicPrivateLabel.PROP_DeviceInfo_custom_ + arg; String D = bpl.getStringProperty(K, null); if (!StringTools.isBlank(D)) { return D; } } return i18n.getString("Device.key.custom", "Custom"); } else { String value = dev.getCustomAttribute(arg); return StringTools.trim(value); } } /* Device fields */ if (getTitle) { DBField dbFld = Device.getFactory().getField(key); if (dbFld != null) { return dbFld.getTitle(locale); } } else { String fldName = dev.getFieldName(key); // this gets the field name with proper case DBField dbFld = (fldName != null)? dev.getField(fldName) : null; if (dbFld != null) { Object val = dev.getFieldValue(fldName); // straight from table if (val == null) { val = dbFld.getDefaultValue(); } Account account = dev.getAccount(); if (account != null) { val = account.convertFieldUnits(dbFld, val, true/*inclUnits*/, locale); return StringTools.trim(val); } else { return dbFld.formatValue(val); } } } // Device field not found /* try account */ if (getTitle) { return Account._getKeyFieldString( true/*title*/, key, arg, locale, null/*BasicPrivateLabel*/, null/*Account*/); } else { return Account._getKeyFieldString( false/*value*/, key, arg, locale, bpl, dev.getAccount()); } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ private static Comparator devDescComparator = null; /** *** Gets the Device Description Sort Comparator *** @return The Device Description Sort Comparator **/ public static Comparator getDeviceDescriptionComparator() { if (devDescComparator == null) { devDescComparator = new DeviceDescriptionComparator(); // ascending } return devDescComparator; } /** *** Comparator optimized for EventData device description **/ public static class DeviceDescriptionComparator implements Comparator { private boolean ascending = true; public DeviceDescriptionComparator() { this(true); } public DeviceDescriptionComparator(boolean ascending) { this.ascending = ascending; } public int compare(Device dv1, Device dv2) { // assume we are comparing Device records if (dv1 == dv2) { return 0; // exact same object (or both null) } else if (dv1 == null) { return this.ascending? -1 : 1; // null < non-null } else if (dv2 == null) { return this.ascending? 1 : -1; // non-null > null } else { String D1 = dv1.getDescription().toLowerCase(); String D2 = dv2.getDescription().toLowerCase(); return this.ascending? D1.compareTo(D2) : D2.compareTo(D1); } } public boolean equals(Object other) { if (other instanceof DeviceDescriptionComparator) { DeviceDescriptionComparator ddc = (DeviceDescriptionComparator)other; return (this.ascending == ddc.ascending); } return false; } } // ------------------------------------------------------------------------ // ------------------------------------------------------------------------ // Main admin entry point below private static final String ARG_ACCOUNT[] = new String[] { "account" , "acct" , "a" }; private static final String ARG_DEVICE[] = new String[] { "device" , "dev" , "d" }; private static final String ARG_UNIQID[] = new String[] { "uniqueid" , "unique", "uniq", "uid", "u" }; private static final String ARG_CREATE[] = new String[] { "create" }; private static final String ARG_EDIT[] = new String[] { "edit" , "ed" }; private static final String ARG_EDITALL[] = new String[] { "editall" , "eda" }; private static final String ARG_DELETE[] = new String[] { "delete" }; private static final String ARG_EVENTS[] = new String[] { "events" , "ev" }; private static final String ARG_FORMAT[] = new String[] { "format" , "fmt" }; //private static final String ARG_SETPROP[] = new String[] { "setprop" }; private static final String ARG_INSERT[] = new String[] { "insertGP" }; private static final String ARG_CLEARACK[] = new String[] { "clearAck" }; private static final String ARG_RESET_ACCUM[] = new String[] { "resetAccum", "resetAccumulators" }; private static final String ARG_MAINTKM[] = new String[] { "maint" , "maintkm"}; private static final String ARG_CHECKRULES[] = new String[] { "ckRules" }; private static final String ARG_RESET_ODOM[] = new String[] { "resetOdom" }; private static final String ARG_SEND_COMMAND[] = new String[] { "sendCmd" }; private static final String ARG_CNT_FUTURE_EV[] = new String[] { "countFutureEvents" }; private static final String ARG_DEL_FUTURE_EV[] = new String[] { "deleteFutureEvents" }; private static final String ARG_CNT_OLD_EV[] = new String[] { "countOldEvents" }; private static final String ARG_DEL_OLD_EV[] = new String[] { "deleteOldEvents" }; private static final String ARG_CONFIRM_DEL[] = new String[] { "confirmDelete" }; private static final String ARG_ZONECHECK[] = new String[] { "zoneCheck" }; private static final String ARG_SIM_PHONE[] = new String[] { "simPhone" }; /** *** Convenience for creating a combined account/device description *** @param acctID The Account ID *** @param devID The Device ID *** @return The combined account/device description **/ private static String _fmtDevID(String acctID, String devID) { return acctID + "/" + devID; } /** *** Usage display **/ private static void usage() { Print.sysPrintln("Usage:"); Print.sysPrintln(" java ... " + Device.class.getName() + " {options}"); Print.sysPrintln("Common Options:"); Print.sysPrintln(" -account= Acount ID which owns Device"); Print.sysPrintln(" -device= Device ID to create/edit"); Print.sysPrintln(" -uniqueid= Unique ID to create/edit"); Print.sysPrintln(""); Print.sysPrintln(" -create Create a new Device"); Print.sysPrintln(" -edit Edit an existing (or newly created) Device"); Print.sysPrintln(" -delete Delete specified Device"); Print.sysPrintln(""); Print.sysPrintln(" -events= Retrieve the last events"); Print.sysPrintln(" -ckRules=/, Check rule (may change db!)"); Print.sysPrintln(""); Print.sysPrintln(" -countFutureEvents= Count events beyond (now + sec) into the future"); Print.sysPrintln(" -deleteFutureEvents= Delete events beyond (now + sec) into the future"); Print.sysPrintln(""); Print.sysPrintln(" -countOldEvents=