summaryrefslogtreecommitdiffstats
path: root/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockFacade.java
blob: 928255031a21d10d5b4a0b40f7a51f54c33d5488 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * 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 java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.Lock;

import org.apache.curator.framework.recipes.locks.InterProcessMutex;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * This class provides a facade over the {@link Lock} interface for Curator locks.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class CuratorLockFacade implements Lock {
    // Logger for this class
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(CuratorLockFacade.class);

    // The Lock ID
    private final String lockId;

    // The mutex used for Curator locking
    private final InterProcessMutex lockMutex;

    /**
     * Create the lock Facade.
     *
     * @param lockMutex The lock mutex behind the facade
     * @param lockId The ID of the lock
     */
    public CuratorLockFacade(final InterProcessMutex lockMutex, final String lockId) {
        this.lockId = lockId;
        this.lockMutex = lockMutex;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#lock()
     */
    @Override
    public void lock() {
        try {
            lockMutex.acquire();
        } catch (final Exception e) {
            LOGGER.warn("failed to acquire lock for \"" + lockId, e);
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#lockInterruptibly()
     */
    @Override
    public void lockInterruptibly() throws InterruptedException {
        LOGGER.warn("lockInterruptibly() not supported for \"" + lockId);
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#tryLock()
     */
    @Override
    public boolean tryLock() {
        try {
            lockMutex.acquire();
            return true;
        } catch (final Exception e) {
            LOGGER.warn("failed to acquire lock for \"" + lockId, e);
            return false;
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#tryLock(long, java.util.concurrent.TimeUnit)
     */
    @Override
    public boolean tryLock(final long time, final TimeUnit unit) throws InterruptedException {
        try {
            lockMutex.acquire(time, unit);
            return true;
        } catch (final Exception e) {
            LOGGER.warn("failed to acquire lock for \"" + lockId, e);
            return false;
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#unlock()
     */
    @Override
    public void unlock() {
        try {
            lockMutex.release();
        } catch (final Exception e) {
            LOGGER.warn("failed to release lock for \"" + lockId, e);
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see java.util.concurrent.locks.Lock#newCondition()
     */
    @Override
    public Condition newCondition() {
        LOGGER.warn("newCondition() not supported for \"" + lockId);
        return null;
    }
}