CancelSubscriptionTask (Core XMPP Server 4.8.2 API)

java.lang.Object
- org.jivesoftware.openfire.pubsub.cluster.NodeTask
- - org.jivesoftware.openfire.pubsub.cluster.SubscriptionTask
  - - org.jivesoftware.openfire.pubsub.cluster.CancelSubscriptionTask

All Implemented Interfaces:

Externalizable, Serializable, Runnable, ClusterTask<Void>
```
public class CancelSubscriptionTask
extends SubscriptionTask
```
A cluster task used to cancel a pubsub node subscription (a relation between an entity an a pubsub node). Note that this task aims to update in-memory state only: it will not apply affiliation changes to persistent data storage (it is assumed that the cluster node where the task originated takes responsibility for that). As a result, this task might not apply changes if the node that is the subject of this task is currently not loaded in-memory of the cluster node on which this task operates.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.jivesoftware.openfire.pubsub.cluster.NodeTask
  nodeId, serviceId, uniqueNodeIdentifier

Constructor Summary

Constructors
Constructor	Description
`CancelSubscriptionTask()`	This no-argument constructor is provided for serialization purposes.
`CancelSubscriptionTask(NodeSubscription subscription)`	Constructs a new task that cancels a subscription to a pubsub node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void run()
- Methods inherited from class org.jivesoftware.openfire.pubsub.cluster.SubscriptionTask
  getOwner, getState, getSubscriberJid, getSubscriptionId, getSubscriptionIfLoaded, readExternal, toString, writeExternal
- Methods inherited from class org.jivesoftware.openfire.pubsub.cluster.NodeTask
  getNodeId, getNodeIfLoaded, getResult, getServiceIfLoaded, getUniqueNodeIdentifier
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CancelSubscriptionTask
```
public CancelSubscriptionTask()
```
    This no-argument constructor is provided for serialization purposes. It should generally not be used otherwise.
  - CancelSubscriptionTask
```
public CancelSubscriptionTask(@Nonnull
                              NodeSubscription subscription)
```
    Constructs a new task that cancels a subscription to a pubsub node.
    
    Parameters:
    
    subscription - The to-be-cancelled subscription
- Method Detail
  - run
```
public void run()
```