summaryrefslogtreecommitdiff
path: root/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/ManagedBDBHAMessageStore.java
blob: bfc7bbf1289f9927d5a90e504206edfe4ea55cc6 (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
66
67
68
69
70
71
72
73
74
75
/*
 * 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.server.store.berkeleydb;

import java.io.IOException;

import javax.management.JMException;
import javax.management.openmbean.TabularData;

import org.apache.qpid.management.common.mbeans.annotations.MBeanAttribute;
import org.apache.qpid.management.common.mbeans.annotations.MBeanOperation;

public interface ManagedBDBHAMessageStore
{
    public static final String TYPE = "BDBHAMessageStore";

    public static final String ATTR_GROUP_NAME = "GroupName";
    public static final String ATTR_NODE_NAME = "NodeName";
    public static final String ATTR_NODE_HOST_PORT = "NodeHostPort";
    public static final String ATTR_HELPER_HOST_PORT = "HelperHostPort";
    public static final String ATTR_REPLICATION_POLICY = "ReplicationPolicy";
    public static final String ATTR_NODE_STATE = "NodeState";
    public static final String ATTR_DESIGNATED_PRIMARY = "DesignatedPrimary";

    @MBeanAttribute(name=ATTR_GROUP_NAME, description="Name identifying the group")
    String getGroupName() throws IOException;

    @MBeanAttribute(name=ATTR_NODE_NAME, description="Unique name identifying the node within the group")
    String getNodeName() throws IOException;

    @MBeanAttribute(name=ATTR_NODE_HOST_PORT, description="Host/port used to replicate data between this node and others in the group")
    String getNodeHostPort() throws IOException;

    @MBeanAttribute(name=ATTR_NODE_STATE, description="Current state of this node")
    String getNodeState() throws IOException;

    @MBeanAttribute(name=ATTR_HELPER_HOST_PORT, description="Host/port used to allow a new node to discover other group members")
    String getHelperHostPort() throws IOException;

    @MBeanAttribute(name=ATTR_REPLICATION_POLICY, description="Replication policy")
    String getReplicationPolicy() throws IOException;

    @MBeanAttribute(name=ATTR_DESIGNATED_PRIMARY, description="Designated primary flag. Applicable to the two node case.")
    boolean getDesignatedPrimary() throws IOException;

    @MBeanOperation(name="getAllNodesInGroup", description="Get all nodes within the group, regardless of whether currently attached or not")
    TabularData getAllNodesInGroup() throws IOException, JMException;

    @MBeanOperation(name="removeNodeFromGroup", description="Remove an existing node from the group")
    void removeNodeFromGroup(String nodeName) throws JMException;

    @MBeanOperation(name="setDesignatedPrimary", description="Set/unset this node as the designated primary for the group. Applicable to the two node case.")
    void setDesignatedPrimary(boolean primary) throws JMException;

    @MBeanOperation(name="updateAddress", description="Update the address of another node. The node must be in a STOPPED state.")
    void updateAddress(String nodeName, String newHostName, int newPort) throws JMException;
}