summaryrefslogtreecommitdiff
path: root/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java
diff options
context:
space:
mode:
Diffstat (limited to 'qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java')
-rw-r--r--qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java49
1 files changed, 49 insertions, 0 deletions
diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java
new file mode 100644
index 0000000000..6f7b1812c6
--- /dev/null
+++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentAddedWorkItem.java
@@ -0,0 +1,49 @@
+/*
+ *
+ * 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;
+
+/**
+ * Descriptions below are taken from <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API Proposal</a>
+ * <pre>
+ * AGENT_ADDED: When the QMF Console receives the first heartbeat from an Agent, an AGENT_ADDED WorkItem
+ * is pushed onto the work-queue. The WorkItem's getParam() call returns a map which contains
+ * a reference to the new Console Agent instance. The reference is indexed from the map using
+ * the key string "agent". There is no handle associated with this WorkItem.
+ *
+ * Note: If a new Agent is discovered as a result of the Console findAgent() method, then no
+ * AGENT_ADDED WorkItem is generated for that Agent.
+ * </pre>
+ * @author Fraser Adams
+ */
+
+public final class AgentAddedWorkItem extends AgentAccessWorkItem
+{
+ /**
+ * Construct an AgentAddedWorkItem. Convenience constructor not in API
+ *
+ * @param agent the Agent used to populate the WorkItem's param
+ */
+ public AgentAddedWorkItem(final Agent agent)
+ {
+ super(WorkItemType.AGENT_ADDED, null, newParams(agent, null));
+ }
+}
+