Java Mine
ContentsIndexHome
PreviousUpNext
MineServer Members

The following tables list the members exposed by MineServer.

 
Name 
Description 
 
Public EventGatewayMessage; *

  • Fired when a message is received from a gateway.
*
  • @param gatewayMessage Class holding data about the gateway communication.
  • @throws java.lang.InterruptedException
 
 

  • Fired when an exception is caught allowing the exception to be logged.

public EventLogException; *

  • Fires the LogException event.
*
  • @param ex Exception to be passed.
  • @param location Method name where the exception occurred.
 
 

  • Fired when changes have been made to the gateway object that can be
  • persisted to a permanent data store.

public EventPersistGateway; *

  • Fires PersistGateway event.
*
  • @param gatewayID Numerical identifier of gateway.
 
 

  • Fired when changes have been made to the sensor object that can be
  • persisted to a permanent data store.

public EventPersistSensor; *

  • Fires PersitSensor event.
*
  • @param sensor Sensor that has been modified.
 
 
public EventSensorMessage; *

  • Fired when one or more sensor messages are received.
*
  • @param sensorMessages List of sensor data messages.
  • @param gatewayID Numerical identifier of gateway that send the messages.
 
 
public event EventHandlerUnknownGateway; *

  • Fired when Mine receives a message from an unregistered gateway.
*
  • @param gatewayID numeric identifier of the gateway
  • @param gatewayType is type associated with the gateway
 
 
public event EventHandlerUnknownSensor; *

  • Fired when a gateway declines a join from a sensor.
*
  • @param sensorID numeric identifier of the sensor
  • @param sensorApplication is type associated with the sensor
 
 
Name 
Description 
 
GATEWAY RESPONSE HANDLING 
 
Name 
Description 
 
> 
Properties 
 
>> 
This is >>, a member of class MineServer. 
 
This is addExceptionProcessingHandler, a member of class MineServer. 
 
This is addGatewayDataProcessingHandler, a member of class MineServer. 
 
This is addGatewayResponseHandler, a member of class MineServer. 
 
This is addPersistGatewayHandler, a member of class MineServer. 
 
This is addPersistSensorHandler, a member of class MineServer. 
 
This is addSensorDataProcessingHandler, a member of class MineServer. 
 
This is addUnknownGatewayHandler, a member of class MineServer. 
 
This is addUnknownSensorHandler, a member of class MineServer. 
 
This is assignExternalDeviceStorageHandler, a member of class MineServer. 
 

Clear queue of all commands to be sent to sensor @param sensorID Numerical identifier of sensor to send command @throws Exception if sensor is not found 
 

Returns a UTC Calendar based on the seconds passed in @param seconds the seconds since January 1st 2010 
 

Returns a simpleDateFormat of ("E MMM dd yyyy hh:mm:ss a")date and time will look like -> Fri Jan 01 2010 12:00:00 PM. for display purposes @param calendar Calendar object used for date and time information 
 

Queues sensor specific command to be sent down @param sensorID Numerical identifier of sensor to send command @param commandFrame Frame for command as returned by SensorBaseProfile class @param isUrgent Will set the urgent flag so that the command is broadcast when received by the gateway @throws Exception if sensor is not found 
 

Access to the object instances used by the server. Returns null if gatewayID does not belong to any of the registered gateways. @param gatewayID Numeric identifier of the gateway object. @return The gateway object stored in memory 
 
class MineServerInternal { Internal Methods 
 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways. @param sensorID Numeric identifier of the gateway object's sensorID. @return The gateway object stored in memory 
 

Access to the object instances used by the server. Returns empty if gatewayID is not found. @param sensorID is the sensor assigned ID @throws InterruptedException if gateway is invalid @return The list of sensor objects assigned to the gateway 
 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways. @param sensorID Numeric identifier of the sensor object. @return The sensor object stored in memory @throws InterruptedException if gateway is invalid 
 

Access to the object instances used by the server. @param gatewayID Numeric identifier of the gateway object. @return The list of sensor objects assigned to the gateway @throws InterruptedException if gateway is invalid 
 

Returns a UTC Calendar based on the seconds passed in @param seconds the seconds since January 1st 2010 
 
This is GetStartUPParameters, a member of class MineServer. 
 

Returns the current version of the API  
 
This is HandleActionControlAck, a member of class MineServer. 
 
This is HandleFindGateway, a member of class MineServer. 
 
This is HandleParentMessage, a member of class MineServer. 
 
This is HandleReadDataAck, a member of class MineServer. 
 
This is HandleWriteDataAck, a member of class MineServer. 
 
This is the overview for the MineServer constructor overload. 
 
This is OnACTLAck, a member of class MineServer. 
 
This is OnBootloaderAck, a member of class MineServer. 
 
This is OnFindGateway, a member of class MineServer. 
 
This is OnNetworkStatus, a member of class MineServer. 
 
This is OnParentMsg, a member of class MineServer. 
 
This is OnProcessData, a member of class MineServer. 
 
This is OnReadDataAck, a member of class MineServer. 
 
This is OnSensorStatus, a member of class MineServer. 
 
This is OnWriteDataAck, a member of class MineServer. 
 
This is ParseIP, a member of class MineServer. 
 
This is ParseMessage, a member of class MineServer. 
 
This is ProcessBytes, a member of class MineServer. 
 

Adds the gateway to the servers list of valid objects @param gateway Gateway object @throws Exception There is already a gateway registered with the same gatewayID, or gatewayID property of gateway is not valid (Zero is not a valid gatewayID) 
 

Adds the sensor to the servers list of valid objects @param gatewayID is the ID number assigned to the gateway @param sensor Sensor object ArgumentNullException Parameter "sensor" is null @throws java.lang.Exception There is already a sensor registered with the same sensorID, or sensorID property of sensor is not valid (Zero is not a valid sensorID) 
 
This is removeExceptionProcessingHandler, a member of class MineServer. 
 
This is removeExternalDeviceStorageHandler, a member of class MineServer. 
 

Removes the gateway from the servers list of valid objects @param gatewayID Numeric identifier of the gateway object. 
 
This is removeGatewayDataProcessingHandler, a member of class MineServer. 
 
This is removeGatewayResponseHandler, a member of class MineServer. 
 
This is removePersistGatewayHandler, a member of class MineServer. 
 
This is removePersistSensorHandler, a member of class MineServer. 
 

Removes the sensor from the servers list of valid objects @param sensorID Numeric identifier of the sensor object. @throws InterruptedException if sensor is unregistered 
 
This is removeSensorDataProcessingHandler, a member of class MineServer. 
 
This is removeUnknownGatewayHandler, a member of class MineServer. 
 
This is removeUnknownSensorHandler, a member of class MineServer. 
 
This is the overview for the resetEncryptionAck method overload. 
 

gets how many seconds its been since January 1st 2010 to set date timesreturns the time based off of UTC / 
 
Public Methods 
 

This call starts the socket listeners that the gateways will use to communicate @throws Exception if IP/Port is already bound to another socket. 
 

This call stops the socket listeners that the gateways will use to communicate @throws InterruptedException TCP socket is used @throws IOException UDP socket is used 
 

Returns a UTC Calendar object @param calendar Calendar object used for date and time information 
Copyright (c) 2022. All rights reserved.
What do you think about this topic? Send feedback!