com.edustructures.sifworks
Class ADKFlags

java.lang.Object
  com.edustructures.sifworks.ADKFlags

public class ADKFlags
extends java.lang.Object

Flags and constants used throughout the ADK.

Provisioning Flags

The PROV_ flags are used to control the provisioning process when the agent registers with zones and topics. These flags are typically passed to methods such as Zone.connect, Topic.setSubscriber, Topic.setPublisher, and Agent.shutdown.

SIF provisioning messages include:

• <SIF_Register>
• <SIF_Unregister>
• <SIF_Provide>
• <SIF_Unsubscribe>
• <SIF_Subscribe>
• <SIF_Unsubscribe>

Version:

ADK 1.0

Field Summary

static int	PROV_NONE Provisioning Option: No provisioning action should be taken
static int	PROV_PROVIDE Provisioning Option: Send a SIF_Provide message
static int	PROV_REGISTER Provisioning Option: Send a SIF_Register message
static int	PROV_SUBSCRIBE Provisioning Option: Send a SIF_Subscribe message
static int	PROV_UNPROVIDE Provisioning Option: Send a SIF_Unprovide message
static int	PROV_UNREGISTER Provisioning Option: Send a SIF_Unregister message
static int	PROV_UNSUBSCRIBE Provisioning Option: Send a SIF_Unsubscribe message
static int	QUEUE_LOCAL Identifies the Agent Local Queue (as opposed to the agent's queue on the ZIS)
static int	QUEUE_SERVER Identifies the agent's queue on the ZIS (as opposed to the Agent Local Queue)
static int	SLEEP_ON_CONNECT Instruct the ADK to put the agent to sleep upon successful connection to the zone.

Constructor Summary

ADKFlags()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_LOCAL

public static final int QUEUE_LOCAL

Identifies the Agent Local Queue (as opposed to the agent's queue on the ZIS)

See Also:

Constant Field Values

QUEUE_SERVER

public static final int QUEUE_SERVER

Identifies the agent's queue on the ZIS (as opposed to the Agent Local Queue)

See Also:

Constant Field Values

PROV_NONE

public static final int PROV_NONE

Provisioning Option: No provisioning action should be taken

See Also:

Constant Field Values

PROV_REGISTER

public static final int PROV_REGISTER

Provisioning Option: Send a SIF_Register message

See Also:

Constant Field Values

PROV_UNREGISTER

public static final int PROV_UNREGISTER

Provisioning Option: Send a SIF_Unregister message

See Also:

Constant Field Values

PROV_PROVIDE

public static final int PROV_PROVIDE

Provisioning Option: Send a SIF_Provide message

See Also:

Constant Field Values

PROV_UNPROVIDE

public static final int PROV_UNPROVIDE

Provisioning Option: Send a SIF_Unprovide message

See Also:

Constant Field Values

PROV_SUBSCRIBE

public static final int PROV_SUBSCRIBE

Provisioning Option: Send a SIF_Subscribe message

See Also:

Constant Field Values

PROV_UNSUBSCRIBE

public static final int PROV_UNSUBSCRIBE

Provisioning Option: Send a SIF_Unsubscribe message

See Also:

Constant Field Values

SLEEP_ON_CONNECT

public static final int SLEEP_ON_CONNECT

Instruct the ADK to put the agent to sleep upon successful connection to the zone. The agent is responsible for waking up the agent when it is ready to begin receiving messages. This flags should be passed to the Zone.connect method to prevent the agent from receiving messages upon a successful connection to the zone.

See Also:

Constant Field Values

Constructor Detail

ADKFlags

public ADKFlags()