aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManagerParameters.java
blob: 1b525e14758889957c0a1e4051c1ba5b20ae9824 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * Licensed 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.plugins.context.locking.curator;

import org.onap.policy.apex.context.parameters.LockManagerParameters;

/**
 * Bean class for Curator locking parameters.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class CuratorLockManagerParameters extends LockManagerParameters {
    // @formatter:off
    /** The default address used to connect to the Zookeeper server. */
    public static final String DEFAULT_ZOOKEEPER_ADDRESS = "localhost:2181";

    /** The default sleep time to use when connecting to the Zookeeper server. */
    public static final int DEFAULT_ZOOKEEPER_CONNECT_SLEEP_TIME = 1000;

    /** The default number of times to retry failed connections to the Zookeeper server. */
    public static final int DEFAULT_ZOOKEEPER_CONNECT_RETRIES = 3;

    // Curator parameters
    private String zookeeperAddress       = DEFAULT_ZOOKEEPER_ADDRESS;
    private int zookeeperConnectSleepTime = DEFAULT_ZOOKEEPER_CONNECT_SLEEP_TIME;
    private int zookeeperContextRetries   = DEFAULT_ZOOKEEPER_CONNECT_RETRIES;
    // @formatter:on

    /**
     * The Constructor.
     */
    public CuratorLockManagerParameters() {
        super();
    }

    /**
     * Gets the zookeeper address.
     *
     * @return the zookeeper address
     */
    public String getZookeeperAddress() {
        return zookeeperAddress;
    }

    /**
     * Sets the zookeeper address.
     *
     * @param zookeeperAddress the zookeeper address
     */
    public void setZookeeperAddress(final String zookeeperAddress) {
        this.zookeeperAddress = zookeeperAddress;
    }

    /**
     * Gets the zookeeper connect sleep time.
     *
     * @return the zookeeper connect sleep time
     */
    public int getZookeeperConnectSleepTime() {
        return zookeeperConnectSleepTime;
    }

    /**
     * Sets the zookeeper connect sleep time.
     *
     * @param zookeeperConnectSleepTime the zookeeper connect sleep time
     */
    public void setZookeeperConnectSleepTime(final int zookeeperConnectSleepTime) {
        this.zookeeperConnectSleepTime = zookeeperConnectSleepTime;
    }

    /**
     * Gets the zookeeper context retries.
     *
     * @return the zookeeper context retries
     */
    public int getZookeeperContextRetries() {
        return zookeeperContextRetries;
    }

    /**
     * Sets the zookeeper context retries.
     *
     * @param zookeeperContextRetries the zookeeper context retries
     */
    public void setZookeeperContextRetries(final int zookeeperContextRetries) {
        this.zookeeperContextRetries = zookeeperContextRetries;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        return "CuratorLockManagerParameters [zookeeperAddress=" + zookeeperAddress + ", zookeeperConnectSleepTime="
                + zookeeperConnectSleepTime + ", zookeeperContextRetries=" + zookeeperContextRetries + "]";
    }
}