summaryrefslogtreecommitdiff
path: root/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java
diff options
context:
space:
mode:
Diffstat (limited to 'qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java')
-rw-r--r--qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java62
1 files changed, 62 insertions, 0 deletions
diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java
new file mode 100644
index 0000000000..d9123e9a2c
--- /dev/null
+++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionIndicationWorkItem.java
@@ -0,0 +1,62 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+package org.apache.qpid.qmf2.console;
+
+import java.util.Map;
+
+// QMF2 Imports
+import org.apache.qpid.qmf2.common.Handle;
+import org.apache.qpid.qmf2.common.WorkItem;
+
+/**
+ * Descriptions below are taken from <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API Proposal</a>
+ * <pre>
+ * SUBSCRIPTION_INDICATION: The SUBSCRIPTION_INDICATION WorkItem signals the arrival of an update to subscribed
+ * data from the Agent.
+ *
+ * The getParams() method of a SUBSCRIPTION_INDICATION WorkItem will return an instance
+ * of the SubscribeIndication class. The getHandle() method returns null.
+ * </pre>
+ * @author Fraser Adams
+ */
+
+public final class SubscriptionIndicationWorkItem extends WorkItem
+{
+ /**
+ * Construct a SubscriptionIndicationWorkItem. Convenience constructor not in API
+ *
+ * @param params the SubscribeParams used to populate the WorkItem's param
+ */
+ public SubscriptionIndicationWorkItem(final SubscribeIndication params)
+ {
+ super(WorkItemType.SUBSCRIPTION_INDICATION, null, params);
+ }
+
+ /**
+ * Return the SubscribeIndication stored in the params.
+ * @return the SubscribeIndication stored in the params.
+ */
+ public SubscribeIndication getSubscribeIndication()
+ {
+ return (SubscribeIndication)getParams();
+ }
+}
+