Changes for checkstyle 8.32
[policy/apex-pdp.git] / context / context-management / src / main / java / org / onap / policy / apex / context / impl / locking / jvmlocal / JvmLocalLockManager.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
4  * ================================================================================
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * SPDX-License-Identifier: Apache-2.0
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.apex.context.impl.locking.jvmlocal;
22
23 import java.util.concurrent.locks.ReadWriteLock;
24 import java.util.concurrent.locks.ReentrantReadWriteLock;
25 import org.onap.policy.apex.context.ContextException;
26 import org.onap.policy.apex.context.impl.locking.AbstractLockManager;
27
28 /**
29  * A lock manager that returns locks that have a range of just the local JVM. The implementation uses a Jav
30  * {@link ReentrantReadWriteLock} as the lock for context album items.
31  *
32  * @author Liam Fallon (liam.fallon@ericsson.com)
33  */
34 public class JvmLocalLockManager extends AbstractLockManager {
35     /**
36      * {@inheritDoc}.
37      */
38     @Override
39     public ReadWriteLock getReentrantReadWriteLock(final String lockId) throws ContextException {
40         return new ReentrantReadWriteLock();
41     }
42
43     /**
44      * {@inheritDoc}.
45      */
46     @Override
47     public void shutdown() {
48         // Nothing to do for this lock manager
49     }
50 }