GemSpoolHandler (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.gem.GemSpoolHandler

All Implemented Interfaces:

StateChangeNotification, MessageResponseInterface, SystemHandlerInterface, java.io.Serializable
```
public class GemSpoolHandler
extends java.lang.Object
implements java.io.Serializable, MessageResponseInterface, SystemHandlerInterface, StateChangeNotification
```
This is a MessageHandler for Spooling

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GemSpoolHandler.JSONMessage
Save the message to a JSON structure using the existing JSSONEncode/Decode methods.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GemSpoolHandler.JSONMessage` Save the message to a JSON structure using the existing JSSONEncode/Decode methods.

Field Summary

Fields
Modifier and Type Field and Description

static int debugLevel
- Fields inherited from interface com.ergotech.secs.MessageResponseInterface
  cvsRev
- Fields inherited from interface com.ergotech.secs.SystemHandlerInterface
  cvsRev
- Fields inherited from interface com.ergotech.secs.gem.StateChangeNotification
  cvsRev

Fields
Modifier and Type	Field and Description
`static int`	`debugLevel`

Constructor Summary

Constructors
Constructor and Description

GemSpoolHandler()
Required default constructor for GSON.

Constructors
Constructor and Description
`GemSpoolHandler()` Required default constructor for GSON.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Initialize the spooler variable and send the activated event report.
`void`	`changeStateProposed(int oldState, int newState)` Implement the state change notification to know when to activate the spooler.
`void`	`deactivate()` Set the spooler variables and send the deactivated event report.
`boolean`	`deSpool()` Send the data.
`void`	`destroy()`
`int`	`getCurrentBlockTransmitCount()`
`SecsMsg`	`getCurrentlyDespooling()`
`java.util.Map<java.lang.Integer,java.util.BitSet>`	`getLocallyRegisteredRequests()`
`int`	`getMaxSpoolTransmit()`
`int`	`getSpoolCountTotal()`
`java.util.Date`	`getSpoolFullTime()`
`static GemSpoolHandler`	`getSpoolHandler(java.lang.String equipmentName)` Returns the persistent instance of the spool handler or null if one has not been created for the provided equipment name.
`static GemSpoolHandler`	`getSpoolHandler(java.lang.String equipmentName, SecsFormat3x5x activateCEID, SecsFormat3x5x deactivateCEID, SecsFormat3x5x spoolingTransmitFailure)` Returns the persistent instance of the spool handler.
`static GemSpoolHandler`	`getSpoolHandler(java.lang.String equipmentName, SecsFormat3x5x activateCEID, SecsFormat3x5x deactivateCEID, SecsFormat3x5x spoolingTransmitFailure, boolean createNew)` Returns the persistent instance of the spool handler.
`int`	`getSpoolHead()`
`java.util.Date`	`getSpoolStartTime()`
`int`	`getSpoolTail()`
`static java.lang.String`	`init(java.lang.String name, boolean delete)` Initialize the disk.
`boolean`	`isActive()` Returns true if spooling is active
`boolean`	`isEnabled()` Returns true if spooling is enabled.
`boolean`	`isOverWriteSpool()`
`boolean`	`isSpoolFull()`
`boolean`	`isSpoolingEnabled()`
`static GemSpoolHandler`	`loadFromDisk(java.lang.String equipmentName, SecsFormat3x5x activateCEID, SecsFormat3x5x deactivateCEID, SecsFormat3x5x spoolingTransmitFailure)` Returns the persistent instance of the spool handler.
`static GemSpoolHandler`	`loadFromXML(java.lang.String equipmentName, SecsFormat3x5x activateCEID, SecsFormat3x5x deactivateCEID, SecsFormat3x5x spoolingTransmitFailure)` This will load the last saved persistence file.
`void`	`purge()` Purge the spool queue.
`void`	`register(int stream)` Spool all messages in the stream.
`void`	`register(int stream, int function)` Register to spool the particular stream/function.
`boolean`	`responseReceived(int status, SecsMsg primary, SecsMsg response)` The MsgResponseInterface.
`boolean`	`S2F43(SecsMsg msg)` This method receives an S2F43 and sends an S2F44.
`boolean`	`S6F23(SecsMsg msg)` Process the S6F23 message.
`void`	`setCurrentBlockTransmitCount(int currentBlockTransmitCount)`
`void`	`setCurrentlyDespooling(SecsMsg currentlyDespooling)`
`void`	`setEnabled(boolean flag)` Enable spooling.
`void`	`setEnabled(ValueChangedEvent event)` This is the target of the called back for the EnableSpooling DVNAME.
`void`	`setLocallyRegisteredRequests(java.util.Map<java.lang.Integer,java.util.BitSet> locallyRegisteredRequests)`
`void`	`setMaxSpoolTransmit(int maxSpoolTransmit)`
`void`	`setOverWriteSpool(boolean overWriteSpool)`
`void`	`setSpoolCountTotal(int spoolCountTotal)`
`void`	`setSpoolFull(boolean spoolFull)`
`void`	`setSpoolFullTime(java.util.Date spoolFullTime)`
`void`	`setSpoolHead(int spoolHead)`
`void`	`setSpoolingEnabled(boolean spoolingEnabled)`
`void`	`setSpoolStartTime(java.util.Date spoolStartTime)`
`void`	`setSpoolTail(int spoolTail)`
`void`	`showSpool(java.lang.String header, int debug)` Show the spool for the only spooler.
`boolean`	`spoolMessage(SecsMsg msg)` This will accept spool requests and determine how to handle them.
`void`	`store()` Store the object to it's persistent form.
`void`	`storeToXML()` Save the handler object.
`boolean`	`verifyMessage(SecsMsg msg)` This checks to see if we need to spool the message.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - debugLevel
```
public static int debugLevel
```
- Constructor Detail
  - GemSpoolHandler
```
public GemSpoolHandler()
```
    Required default constructor for GSON.
- Method Detail
  - activate
```
public void activate()
```
    Initialize the spooler variable and send the activated event report.
  - changeStateProposed
```
public void changeStateProposed(int oldState,
                                int newState)
                         throws DeclinedStateChangeException
```
    Implement the state change notification to know when to activate the spooler. The transitions are COMMUNICATING to NOT COMMUNICATING and WAIT CRA to WAIT DELAY.
    
    Specified by:
    
    changeStateProposed in interface StateChangeNotification
    
    Throws:
    
    DeclinedStateChangeException
  - deactivate
```
public void deactivate()
```
    Set the spooler variables and send the deactivated event report.
  - deSpool
```
public boolean deSpool()
```
    Send the data. This will also send the deactivated event report when the last spooled message is sent.
  - destroy
```
public void destroy()
```
  - getCurrentBlockTransmitCount
```
public int getCurrentBlockTransmitCount()
```
  - getCurrentlyDespooling
```
public SecsMsg getCurrentlyDespooling()
```
  - getLocallyRegisteredRequests
```
public java.util.Map<java.lang.Integer,java.util.BitSet> getLocallyRegisteredRequests()
```
  - getMaxSpoolTransmit
```
public int getMaxSpoolTransmit()
```
  - getSpoolCountTotal
```
public int getSpoolCountTotal()
```
  - getSpoolFullTime
```
public java.util.Date getSpoolFullTime()
```
  - getSpoolHandler
```
public static GemSpoolHandler getSpoolHandler(java.lang.String equipmentName)
```
    Returns the persistent instance of the spool handler or null if one has not been created for the provided equipment name.
  - getSpoolHandler
```
public static GemSpoolHandler getSpoolHandler(java.lang.String equipmentName,
                                              SecsFormat3x5x activateCEID,
                                              SecsFormat3x5x deactivateCEID,
                                              SecsFormat3x5x spoolingTransmitFailure)
                                       throws java.io.IOException
```
    Returns the persistent instance of the spool handler. This is equivelent to calling getSpoolHandler(String activateCEID, String deactivateCEID, false).
    
    Parameters:
    
    equipmentName - TODO
    
    Throws:
    
    java.io.IOException
  - getSpoolHandler
```
public static GemSpoolHandler getSpoolHandler(java.lang.String equipmentName,
                                              SecsFormat3x5x activateCEID,
                                              SecsFormat3x5x deactivateCEID,
                                              SecsFormat3x5x spoolingTransmitFailure,
                                              boolean createNew)
                                       throws java.io.IOException
```
    Returns the persistent instance of the spool handler.
    
    Parameters:
    
    createNew - forces the creation of a new handler even if a persistent copy exists.
    
    Throws:
    
    java.io.IOException
  - getSpoolHead
```
public int getSpoolHead()
```
  - getSpoolStartTime
```
public java.util.Date getSpoolStartTime()
```
  - getSpoolTail
```
public int getSpoolTail()
```
  - init
```
public static java.lang.String init(java.lang.String name,
                                    boolean delete)
                             throws java.io.IOException
```
    Initialize the disk. This will create the directory if it does not exist and will delete the contents if the parameter "delete" is true. The directory is created as a subdirectory of the directory pointed to by the system property "user.dir" and is called "spool". "user.dir" is usually the directory that the application started in but can be set as an argument to the JVM. The IOException will be thrown if a file (not a directory) with the name "spool" exists or if the directory cannot be created.
    
    Parameters:
    
    delete - cleans the directory if true.
    
    Throws:
    
    java.io.IOException - if there is some error creating a directory with the name "spool".
  - isActive
```
public boolean isActive()
```
    Returns true if spooling is active
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if spooling is enabled.
  - isOverWriteSpool
```
public boolean isOverWriteSpool()
```
  - isSpoolFull
```
public boolean isSpoolFull()
```
  - isSpoolingEnabled
```
public boolean isSpoolingEnabled()
```
  - loadFromDisk
```
public static GemSpoolHandler loadFromDisk(java.lang.String equipmentName,
                                           SecsFormat3x5x activateCEID,
                                           SecsFormat3x5x deactivateCEID,
                                           SecsFormat3x5x spoolingTransmitFailure)
```
    Returns the persistent instance of the spool handler. This will return null if there is some problem loading the object /** This is a passthrough to loadFromXML
    
    Parameters:
    
    equipmentName - the equipment name. This is not part of the persistance but must be valid so is provided here.
    
    activateCEID - the activate CEID. This is not part of the persistance but must be valid so is provided here.
    
    deactivateCEID - the deactivate CEID. This is not part of the persistance but must be valid so is provided here.
    
    spoolingTransmitFailure - the CEID triggered on a spool transmit failure. This is not part of the persistance but must be valid so is provided here.
    
    Returns:
    
    the loaded GemSpoolHandler or null if the persistance file cannot be restored.
  - loadFromXML
```
public static GemSpoolHandler loadFromXML(java.lang.String equipmentName,
                                          SecsFormat3x5x activateCEID,
                                          SecsFormat3x5x deactivateCEID,
                                          SecsFormat3x5x spoolingTransmitFailure)
```
    This will load the last saved persistence file.
    
    Parameters:
    
    equipmentName - the equipment name. This is not part of the persistance but must be valid so is provided here.
    
    activateCEID - the activate CEID. This is not part of the persistance but must be valid so is provided here.
    
    deactivateCEID - the deactivate CEID. This is not part of the persistance but must be valid so is provided here.
    
    spoolingTransmitFailure - the CEID triggered on a spool transmit failure. This is not part of the persistance but must be valid so is provided here.
    
    Returns:
    
    the loaded GemSpoolHandler or null if the persistance file cannot be restored.
  - purge
```
public void purge()
           throws java.io.IOException
```
    Purge the spool queue.
    
    Throws:
    
    java.io.IOException
  - register
```
public void register(int stream)
```
    Spool all messages in the stream. This can be called to configure spooling locally, however if there is a conflict between what is set here and what is set through the SECS link the configuration set through the SECS link take precedence. This means that if the SECS link sets any spooling configuration, what is set here will be ignored.
  - register
```
public void register(int stream,
                     int function)
```
    Register to spool the particular stream/function. This can be called to configure spooling locally, however if there is a conflict between what is set here and what is set through the SECS link the configuration set through the SECS link take precedence. This means that if the SECS link sets any spooling configuration, what is set here will be ignored.
  - responseReceived
```
public boolean responseReceived(int status,
                                SecsMsg primary,
                                SecsMsg response)
```
    The MsgResponseInterface. This will continue to despool messages.
    
    Specified by:
    
    responseReceived in interface MessageResponseInterface
  - S2F43
```
public boolean S2F43(SecsMsg msg)
```
    This method receives an S2F43 and sends an S2F44. It will check the format of the message an store the streams/function if the format is correct
  - S6F23
```
public boolean S6F23(SecsMsg msg)
```
    Process the S6F23 message. This will clear the spool if RSDC = 1 or call the method "deSpool" if RSDC = 0
  - setCurrentBlockTransmitCount
```
public void setCurrentBlockTransmitCount(int currentBlockTransmitCount)
```
  - setCurrentlyDespooling
```
public void setCurrentlyDespooling(SecsMsg currentlyDespooling)
```
  - setEnabled
```
public void setEnabled(boolean flag)
```
    Enable spooling.
    
    Parameters:
    
    flag - true to enable spooling false to disable spooling.
  - setEnabled
```
public void setEnabled(ValueChangedEvent event)
```
    This is the target of the called back for the EnableSpooling DVNAME.
  - setLocallyRegisteredRequests
```
public void setLocallyRegisteredRequests(java.util.Map<java.lang.Integer,java.util.BitSet> locallyRegisteredRequests)
```
  - setMaxSpoolTransmit
```
public void setMaxSpoolTransmit(int maxSpoolTransmit)
```
  - setOverWriteSpool
```
public void setOverWriteSpool(boolean overWriteSpool)
```
  - setSpoolCountTotal
```
public void setSpoolCountTotal(int spoolCountTotal)
```
  - setSpoolFull
```
public void setSpoolFull(boolean spoolFull)
```
  - setSpoolFullTime
```
public void setSpoolFullTime(java.util.Date spoolFullTime)
```
  - setSpoolHead
```
public void setSpoolHead(int spoolHead)
```
  - setSpoolingEnabled
```
public void setSpoolingEnabled(boolean spoolingEnabled)
```
  - setSpoolStartTime
```
public void setSpoolStartTime(java.util.Date spoolStartTime)
```
  - setSpoolTail
```
public void setSpoolTail(int spoolTail)
```
  - showSpool
```
public void showSpool(java.lang.String header,
                      int debug)
```
    Show the spool for the only spooler. The will temporarily set the debug level to the level specified
  - spoolMessage
```
public boolean spoolMessage(SecsMsg msg)
```
    This will accept spool requests and determine how to handle them.
    
    Returns:
    
    whether we successfully spooled the message.
    
    Throws:
    
    MessageSpooledException - if the message is spooled
  - store
```
public void store()
```
    Store the object to it's persistent form.
  - storeToXML
```
public void storeToXML()
```
    Save the handler object.
  - verifyMessage
```
public boolean verifyMessage(SecsMsg msg)
                      throws SecsException
```
    This checks to see if we need to spool the message.
    
    Specified by:
    
    verifyMessage in interface SystemHandlerInterface
    
    Throws:
    
    SecsException

Class GemSpoolHandler

Nested Class Summary

Field Summary

Fields inherited from interface com.ergotech.secs.MessageResponseInterface

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface

Fields inherited from interface com.ergotech.secs.gem.StateChangeNotification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debugLevel

Constructor Detail

GemSpoolHandler

Method Detail

activate

changeStateProposed

deactivate

deSpool

destroy

getCurrentBlockTransmitCount

getCurrentlyDespooling

getLocallyRegisteredRequests

getMaxSpoolTransmit

getSpoolCountTotal

getSpoolFullTime

getSpoolHandler

getSpoolHandler

getSpoolHandler

getSpoolHead

getSpoolStartTime

getSpoolTail

init

isActive

isEnabled

isOverWriteSpool

isSpoolFull

isSpoolingEnabled

loadFromDisk

loadFromXML

purge

register

register

responseReceived

S2F43

S6F23

setCurrentBlockTransmitCount

setCurrentlyDespooling

setEnabled

setEnabled

setLocallyRegisteredRequests

setMaxSpoolTransmit

setOverWriteSpool

setSpoolCountTotal

setSpoolFull

setSpoolFullTime

setSpoolHead

setSpoolingEnabled

setSpoolStartTime

setSpoolTail

showSpool

spoolMessage

store

storeToXML

verifyMessage