blob: 45f316b1b42c77e9b80d733506bbaa91eb471c0d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*
*
* 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.agent;
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>
* UNSUBSCRIBE_REQUEST: The UNSUBSCRIBE_REQUEST is sent by a Console to terminate an existing subscription. The Agent
* application should terminate the given subscription if it exists, and cancel sending any further
* updates against it.
*
* The getParams() method of a UNSUBSCRIBE_REQUEST WorkItem will return a String holding the
* subscriptionId
*
* The getHandle() method returns null.
* </pre>
* @author Fraser Adams
*/
public final class UnsubscribeRequestWorkItem extends WorkItem
{
/**
* Construct an UnsubscribeRequestWorkItem. Convenience constructor not in API
*
* @param params the ResubscribeParams used to populate the WorkItem's param
*/
public UnsubscribeRequestWorkItem(final String params)
{
super(WorkItemType.UNSUBSCRIBE_REQUEST, null, params);
}
/**
* Return the subscriptionId String stored in the params Map.
* @return the subscriptionId String stored in the params Map.
*/
public String getSubscriptionId()
{
return (String)getParams();
}
}
|
