OnlineHandler (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.gem.SendEvent
- - com.ergotech.secs.gem.OnlineHandler

All Implemented Interfaces:

SystemHandlerInterface, java.io.Serializable
```
public class OnlineHandler
extends SendEvent
implements SystemHandlerInterface, java.io.Serializable
```
This will control the online/offline state of the machine. There can only be one ControlState per tool and so only one OnlineHandler. The OnlineHander/GEM Tool can be in the same JVM as a multiple GEM Hosts. An example of this would be a cluster tool where communication to the other elements of the cluster is by SECS/GEM or the integration of a component, eg Barcode Reader that is SECS/GEM compliant.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTEMPT_ONLINE` ATTEMPT_ONLINE value is 2 matching E5 definition.
`static int`	`DEFAULT_INITIAL_STATE` The default initial state.
`static int`	`EQUIPMENT_OFFLINE` EQUIPMENT_OFFLINE value is 1 matching E5 definition.
`static int`	`HOST_OFFLINE` HOST_OFFLINE value is 3 matching E5 definition.
`static int`	`LOCAL_ONLINE` LOCAL_ONLINE value is 4 matching E5 definition.
`static int`	`MAX_STATE` MAX_STATE value is REMOTE_ONLINE
`boolean`	`permissiveLocalOnlineMessageVerification` if this flag is true, then all messages are permitted in local-online unless specifically excluded.
`static int`	`REMOTE_ONLINE` REMOTE_ONLINE value is 5 matching E5 definition.

Fields inherited from class com.ergotech.secs.gem.SendEvent
equipmentName

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface
cvsRev

Constructor Summary

Constructors
Constructor and Description
`OnlineHandler()` The default constructor.
`OnlineHandler(java.lang.String equipmentName, int initialState)` Creates the handler with the specified initial state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateChangeNotifier(StateChangeNotification notifier)` Object added will recieve notification of state changes.
`void`	`allowUnsafeAndPossiblyDangerousViolationsOfTheGEMControlStateModel(boolean flag)` Enable unsafe and possibily dangerous violations of the GEM control state model.
`void`	`attemptOnlineAndWait()` This will return true if we are online...
`boolean`	`blockOnVerify(SecsMsg msg, int state)` Returns false if the message verifiers exist and the message is acceptable to the verifiers.
`void`	`changeState(int state)` This does not check if the transition is valid, it just goes into the new state and sends an event.
`void`	`controlStateValueInput(ValueChangedEvent event)` This is the input to this component from the "ControlState" server.
`void`	`destroy()` Remove clean up the handler.
`int`	`getCurrentState()` This will return the current state.
`int`	`getDefaultOfflineState()` The control state will transition to this state if an attempt online fails.
`java.lang.String`	`getEquipmentName()`
`boolean`	`getLocal()` This will return if we consider ourselves in local state.
`boolean`	`getOnline()` Returns true if the state is one of the two online states.
`void`	`localRemoteStateValueInput(ValueChangedEvent event)` This is an input that can be used to control the current local/remote substate.
`void`	`onlineOfflineStateValueInput(ValueChangedEvent event)` This is an input that can be used to control the current online/offline state.
`boolean`	`processMessage(SecsTrigger msg)` All messages will go through here.
`void`	`registerCEID(SecsFormat3x5x controlStateChangedCEID, SecsFormat3x5x equipmentOffLineCEID, SecsFormat3x5x equipmentOnLineCEID, SecsFormat3x5x controlStateLocalCEID, SecsFormat3x5x controlStateRemoteCEID, SecsFormat3x5x attemptOnlineCEID)` Sets the four CEIDs, that are associated with the state transitions.
`void`	`registerCEIDs()` Attempts to identify the CEIDs.
`void`	`registerIncomingMsg(int state, java.lang.String msg, MessageVerifier verifier)` All messages registered will be halted when the machine is in the state provided.
`void`	`registerIncomingOnlineLocalMsg(java.lang.String msg, MessageVerifier verifier)` All messages registered will be halted when the machine is in online-local mode.
`void`	`registerOutgoingMsg(int state, java.lang.String msg, MessageVerifier verifier)` All messages registered will be halted when the machine is in the state provided.
`void`	`registerOutgoingOnlineLocalMsg(java.lang.String msg, MessageVerifier verifier)` All messages registered will be halted when the machine is in online-local mode.
`void`	`removeStateChangeNotifier(StateChangeNotification notifier)` Removes an object that was recieving notification of state changes.
`boolean`	`S1F13(SecsMsg msg)` This will allow S1F13's to go through if offline.
`boolean`	`S1F14(SecsMsg msg)` This will allow the replys to a S1F14 to go through.
`boolean`	`S1F15(SecsMsg msg)` Request OFF-LINE.
`boolean`	`S1F17(SecsMsg msg)` Request ON-LINE.
`boolean`	`sendingAllowed(SecsMsg msg, java.util.Map<java.lang.String,MessageVerifier> verifiers)` This will return true if the msg is allowed to be sent based on the verifiers.
`void`	`sendSxF0(SecsMsg msg)` Send the SxF0 message.
`void`	`setDefaultOfflineState(int defaultOfflineState)` The control state will transition to this state if an attempt online fails.
`void`	`setEquipmentName(java.lang.String equipmentName)`
`void`	`setLocal()` This will change to local state.
`void`	`setLocal(boolean local)` This will change to local or remote (true or false);
`void`	`setOnline(boolean newValue)` This will set the system online or equipment offline.
`void`	`setRemote()` This will change to remote state.
`java.lang.String`	`toString()`
`boolean`	`verifyMessage(SecsMsg msg)` This checks outgoing messages to make sure that we allow them to go out.

Methods inherited from class com.ergotech.secs.gem.SendEvent
addClockAsDVVAL, equals, getAllExtendedAttributes, getExtendedAttribute, hashCode, sendEvent, setAlarm, setExtendedAttribute

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

- Field Detail
  - ATTEMPT_ONLINE
```
public static final int ATTEMPT_ONLINE
```
    ATTEMPT_ONLINE value is 2 matching E5 definition.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_STATE
```
public static final int DEFAULT_INITIAL_STATE
```
    The default initial state.
    
    See Also:
    
    Constant Field Values
  - EQUIPMENT_OFFLINE
```
public static final int EQUIPMENT_OFFLINE
```
    EQUIPMENT_OFFLINE value is 1 matching E5 definition.
    
    See Also:
    
    Constant Field Values
  - HOST_OFFLINE
```
public static final int HOST_OFFLINE
```
    HOST_OFFLINE value is 3 matching E5 definition.
    
    See Also:
    
    Constant Field Values
  - LOCAL_ONLINE
```
public static final int LOCAL_ONLINE
```
    LOCAL_ONLINE value is 4 matching E5 definition.
    
    See Also:
    
    Constant Field Values
  - MAX_STATE
```
public static final int MAX_STATE
```
    MAX_STATE value is REMOTE_ONLINE
    
    See Also:
    
    Constant Field Values
  - permissiveLocalOnlineMessageVerification
```
public boolean permissiveLocalOnlineMessageVerification
```
    if this flag is true, then all messages are permitted in local-online unless specifically excluded.
  - REMOTE_ONLINE
```
public static final int REMOTE_ONLINE
```
    REMOTE_ONLINE value is 5 matching E5 definition.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OnlineHandler
```
public OnlineHandler()
```
    The default constructor. Sets the state to the default initial_state.
  - OnlineHandler
```
public OnlineHandler(java.lang.String equipmentName,
                     int initialState)
```
    Creates the handler with the specified initial state. Initial state is not used.
- Method Detail
  - addStateChangeNotifier
```
public void addStateChangeNotifier(StateChangeNotification notifier)
```
    Object added will recieve notification of state changes.
  - allowUnsafeAndPossiblyDangerousViolationsOfTheGEMControlStateModel
```
public void allowUnsafeAndPossiblyDangerousViolationsOfTheGEMControlStateModel(boolean flag)
```
    Enable unsafe and possibily dangerous violations of the GEM control state model.
    
    Parameters:
    
    flag - set to true to enable unsafe and possibly dangerous violations of the GEM control state model.
  - attemptOnlineAndWait
```
public void attemptOnlineAndWait()
                          throws SecsException
```
    This will return true if we are online... hostoffline... or equipmentonline and we make a connection. If we send a S1F1 and don't get a proper reply, we will change to hostoffline. otherwise we will go to either local_online or remote_online.
    
    Throws:
    
    SecsException
  - blockOnVerify
```
public boolean blockOnVerify(SecsMsg msg,
                             int state)
```
    Returns false if the message verifiers exist and the message is acceptable to the verifiers. Returns true if the message should be blocked.
  - changeState
```
public void changeState(int state)
                 throws DeclinedStateChangeException
```
    This does not check if the transition is valid, it just goes into the new state and sends an event.
    
    Throws:
    
    DeclinedStateChangeException - thrown if the state change is rejected
  - controlStateValueInput
```
public void controlStateValueInput(ValueChangedEvent event)
                            throws VIBUpdateFailedException
```
    This is the input to this component from the "ControlState" server. This has an additional side effect that it will configure the messages allowable in online local state. It will change the component to permissive and allow everything except S2F41 messages. The change to permissive is unavoidable, that is, if it is changed from permissive elsewhere any value received here will change it back to permissive. Additional message verifiers can be registered and these will not be affected by this method.
    
    Throws:
    
    VIBUpdateFailedException
  - destroy
```
public void destroy()
```
    Remove clean up the handler.
  - getCurrentState
```
public int getCurrentState()
```
    This will return the current state.
  - getDefaultOfflineState
```
public int getDefaultOfflineState()
```
    The control state will transition to this state if an attempt online fails.
    
    Returns:
    
    the default offline state
  - getEquipmentName
```
public java.lang.String getEquipmentName()
```
    Returns:
    
    Returns the equipmentName.
  - getLocal
```
public boolean getLocal()
```
    This will return if we consider ourselves in local state. If we are offline, then this will keep track of what our last state was when we turned offline (and what state we will go into when we go online next).
  - getOnline
```
public boolean getOnline()
```
    Returns true if the state is one of the two online states.
  - localRemoteStateValueInput
```
public void localRemoteStateValueInput(ValueChangedEvent event)
                                throws VIBUpdateFailedException
```
    This is an input that can be used to control the current local/remote substate. Remote is true/non-zero local is false/zero.
    
    Throws:
    
    VIBUpdateFailedException
  - onlineOfflineStateValueInput
```
public void onlineOfflineStateValueInput(ValueChangedEvent event)
                                  throws VIBUpdateFailedException
```
    This is an input that can be used to control the current online/offline state. Online is true/non-zero. Offline is false/zero.
    
    Throws:
    
    VIBUpdateFailedException
  - processMessage
```
public boolean processMessage(SecsTrigger msg)
```
    All messages will go through here. This will determine if we are allowing messages to come from the host to the equipment.
  - registerCEID
```
public void registerCEID(SecsFormat3x5x controlStateChangedCEID,
                         SecsFormat3x5x equipmentOffLineCEID,
                         SecsFormat3x5x equipmentOnLineCEID,
                         SecsFormat3x5x controlStateLocalCEID,
                         SecsFormat3x5x controlStateRemoteCEID,
                         SecsFormat3x5x attemptOnlineCEID)
```
    Sets the four CEIDs, that are associated with the state transitions.
  - registerCEIDs
```
public void registerCEIDs()
```
    Attempts to identify the CEIDs. This will find the server for the DVNAME "ControlState" and then find the CEID. The GemCEID associated with that server is the "Control state changed" CEID. The "Equipment OFF-LINE" CEID is that ID+1. That ID+2 is the "Control State LOCAL" CEID and ID+3 is the "Control State REMOTE"
  - registerIncomingMsg
```
public void registerIncomingMsg(int state,
                                java.lang.String msg,
                                MessageVerifier verifier)
```
    All messages registered will be halted when the machine is in the state provided. If you would like the ability to allow a message, call this method with the msg in the form "S1F13" and a verifier. Calling this on the same message will override the last verifier. Setting the verifier to null will remove the verifier.
    
    Parameters:
    
    state - a value between EQUIPMENT_OFFLINE and REMOTE_ONLINE
    
    msg - a string representation of the message in SxFy format (case sensitive)
    
    verifier - a message verifier, probably MessageVerifier.getDefault();
  - registerIncomingOnlineLocalMsg
```
public void registerIncomingOnlineLocalMsg(java.lang.String msg,
                                           MessageVerifier verifier)
```
    All messages registered will be halted when the machine is in online-local mode. If you would like the ability to allow a message, call this method with the msg in the form "S1F13" and a verifier. Calling this on the same message will override the last verifier.
  - registerOutgoingMsg
```
public void registerOutgoingMsg(int state,
                                java.lang.String msg,
                                MessageVerifier verifier)
```
    All messages registered will be halted when the machine is in the state provided. If you would like the ability to allow a message, call this method with the msg in the form "S1F13" and a verifier. Calling this on the same message will override the last verifier. Setting the verifier to null will remove the verifier.
    
    Parameters:
    
    state - a value between EQUIPMENT_OFFLINE and REMOTE_ONLINE
    
    msg - a string representation of the message in SxFy format (case sensitive)
    
    verifier - a message verifier, probably MessageVerifier.getDefault();
  - registerOutgoingOnlineLocalMsg
```
public void registerOutgoingOnlineLocalMsg(java.lang.String msg,
                                           MessageVerifier verifier)
```
    All messages registered will be halted when the machine is in online-local mode. If you would like the ability to allow a message, call this method with the msg in the form "S1F13" and a verifier. Calling this on the same message will override the last verifier.
  - removeStateChangeNotifier
```
public void removeStateChangeNotifier(StateChangeNotification notifier)
```
    Removes an object that was recieving notification of state changes.
  - S1F13
```
public boolean S1F13(SecsMsg msg)
```
    This will allow S1F13's to go through if offline. If online, then message will go through processMessage
  - S1F14
```
public boolean S1F14(SecsMsg msg)
```
    This will allow the replys to a S1F14 to go through. (if offline, processMessage will look at other states)
  - S1F15
```
public boolean S1F15(SecsMsg msg)
```
    Request OFF-LINE.
  - S1F17
```
public boolean S1F17(SecsMsg msg)
```
    Request ON-LINE.
  - sendingAllowed
```
public boolean sendingAllowed(SecsMsg msg,
                              java.util.Map<java.lang.String,MessageVerifier> verifiers)
```
    This will return true if the msg is allowed to be sent based on the verifiers. If no verifiers are defined for this message the return will be false (denied).
  - sendSxF0
```
public void sendSxF0(SecsMsg msg)
```
    Send the SxF0 message. x is determined from the passed message.
  - setDefaultOfflineState
```
public void setDefaultOfflineState(int defaultOfflineState)
```
    The control state will transition to this state if an attempt online fails.
    
    Parameters:
    
    defaultOfflineState - the default offline state
  - setEquipmentName
```
public void setEquipmentName(java.lang.String equipmentName)
```
    Parameters:
    
    equipmentName - The equipmentName to set.
  - setLocal
```
public void setLocal()
```
    This will change to local state.
  - setLocal
```
public void setLocal(boolean local)
              throws VIBUpdateFailedException
```
    This will change to local or remote (true or false);
    
    Throws:
    
    VIBUpdateFailedException
  - setOnline
```
public void setOnline(boolean newValue)
               throws DeclinedStateChangeException
```
    This will set the system online or equipment offline.
    
    Throws:
    
    DeclinedStateChangeException
  - setRemote
```
public void setRemote()
```
    This will change to remote state.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - verifyMessage
```
public boolean verifyMessage(SecsMsg msg)
                      throws SecsException
```
    This checks outgoing messages to make sure that we allow them to go out.
    
    Specified by:
    
    verifyMessage in interface SystemHandlerInterface
    
    Throws:
    
    SecsException

Class OnlineHandler

Field Summary

Fields inherited from class com.ergotech.secs.gem.SendEvent

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.secs.gem.SendEvent

Methods inherited from class java.lang.Object

Field Detail

ATTEMPT_ONLINE

DEFAULT_INITIAL_STATE

EQUIPMENT_OFFLINE

HOST_OFFLINE

LOCAL_ONLINE

MAX_STATE

permissiveLocalOnlineMessageVerification

REMOTE_ONLINE

Constructor Detail

OnlineHandler

OnlineHandler

Method Detail

addStateChangeNotifier

allowUnsafeAndPossiblyDangerousViolationsOfTheGEMControlStateModel

attemptOnlineAndWait

blockOnVerify

changeState

controlStateValueInput

destroy

getCurrentState

getDefaultOfflineState

getEquipmentName

getLocal

getOnline

localRemoteStateValueInput

onlineOfflineStateValueInput

processMessage

registerCEID

registerCEIDs

registerIncomingMsg

registerIncomingOnlineLocalMsg

registerOutgoingMsg

registerOutgoingOnlineLocalMsg

removeStateChangeNotifier

S1F13

S1F14

S1F15

S1F17

sendingAllowed

sendSxF0

setDefaultOfflineState

setEquipmentName

setLocal

setLocal

setOnline

setRemote

toString

verifyMessage