com.ibm.datapower.wamt.amp
Class SubscriptionState

java.lang.Object
  extended by com.ibm.datapower.wamt.amp.SubscriptionState

public class SubscriptionState
extends java.lang.Object

Provides enumerated values and helper methods for the state of the subscription as reported by the device. This is similar to SubscriptionResponseCode, but reports only on the current state, not the response to a state change request.

See Also:
Commands.pingDevice(DeviceContext, String)

Field Summary
static SubscriptionState ACTIVE
          This specified subscription exists on the device, and all notifications sent from the device since the subscription request have been acknowledged by the NotificationCatcher.
static java.lang.String COPYRIGHT_2009_2013
           
static SubscriptionState FAULT
          The specified subscription has errors, likely due to notifications that the device attempted to send to the NotificationCatcher, but the NotificationCatcher did not acknowledge them for whatever reason.
static SubscriptionState NONE
          The specified subscription does not exist.
 
Method Summary
 boolean equals(java.lang.Object that)
          Compare two objects to see if they are equivalent.
 int hashCode()
           
 java.lang.String toString()
          Get a human-readable String representation of this object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2013

public static final java.lang.String COPYRIGHT_2009_2013
See Also:
Constant Field Values

ACTIVE

public static final SubscriptionState ACTIVE
This specified subscription exists on the device, and all notifications sent from the device since the subscription request have been acknowledged by the NotificationCatcher. You should assume that all notifications sent from the device have been received by the NotificationCatcher. If the device was booted after it failed to deliver notifications to the NotificationCatcher, then the subscription should not exist because subscriptions are not persisted across reboots.


NONE

public static final SubscriptionState NONE
The specified subscription does not exist. Since subscriptions are not persisted on the device, subscriptions may disappear when the device is rebooted. This is a good indication that the device rebooted since the subscription was requested via Commands.subscribeToDevice(DeviceContext, String, StringCollection, URL). You should assume that notifications from the device have been lost.


FAULT

public static final SubscriptionState FAULT
The specified subscription has errors, likely due to notifications that the device attempted to send to the NotificationCatcher, but the NotificationCatcher did not acknowledge them for whatever reason. When the device fails to get an acknowledgement of a notification, it will discard the notification and place the subscription in FAULT state, and prepare to send the next notification. You should assume that notifications from the device have been lost.

Method Detail

equals

public boolean equals(java.lang.Object that)
Compare two objects to see if they are equivalent.

Overrides:
equals in class java.lang.Object
Parameters:
that - the other object to compare to "this"
Returns:
true if the two objects are equivalent, false otherwise
See Also:
ACTIVE, NONE, FAULT

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Get a human-readable String representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
a human-readable String representation of this object


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.