aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/plugins-context/context-locking/context-locking-hazelcast
diff options
context:
space:
mode:
authorwaqas.ikram <waqas.ikram@ericsson.com>2018-06-05 16:18:01 +0100
committerwaqas.ikram <waqas.ikram@ericsson.com>2018-06-05 16:18:47 +0100
commitf94d7521936e66febee983ee7633aacaaf9d7390 (patch)
treebc93547a9541ca4f868a0f70f6e6d020458a1557 /plugins/plugins-context/context-locking/context-locking-hazelcast
parent37d6fd9069eb30d88c4ad80b5f35099ed173cc13 (diff)
Adding apex plugins/plugins-context modules
Change-Id: I36fc295ffbd22661bf8bd091bfb20ebf6dcc7f5e Issue-ID: POLICY-862 Signed-off-by: waqas.ikram <waqas.ikram@ericsson.com>
Diffstat (limited to 'plugins/plugins-context/context-locking/context-locking-hazelcast')
-rw-r--r--plugins/plugins-context/context-locking/context-locking-hazelcast/pom.xml59
-rw-r--r--plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java84
-rw-r--r--plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java104
-rw-r--r--plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/package-info.java27
4 files changed, 274 insertions, 0 deletions
diff --git a/plugins/plugins-context/context-locking/context-locking-hazelcast/pom.xml b/plugins/plugins-context/context-locking/context-locking-hazelcast/pom.xml
new file mode 100644
index 000000000..3e581ecad
--- /dev/null
+++ b/plugins/plugins-context/context-locking/context-locking-hazelcast/pom.xml
@@ -0,0 +1,59 @@
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 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=========================================================
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.onap.policy.apex-pdp.plugins.plugins-context.context-locking</groupId>
+ <artifactId>context-locking</artifactId>
+ <version>2.0.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>context-locking-hazelcast</artifactId>
+ <name>${project.artifactId}</name>
+ <description>[${project.parent.artifactId}] Plugin for locking using Hazelcast</description>
+
+ <dependencies>
+ <dependency>
+ <groupId>com.hazelcast</groupId>
+ <artifactId>hazelcast</artifactId>
+ <version>${version.hazelcast}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.policy.apex-pdp.core</groupId>
+ <artifactId>core-infrastructure</artifactId>
+ <version>${project.version}</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.policy.apex-pdp.plugins.plugins-context.context-distribution</groupId>
+ <artifactId>context-distribution-hazelcast</artifactId>
+ <version>${project.version}</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.onap.policy.apex-pdp.plugins.plugins-context.context-distribution</groupId>
+ <artifactId>context-distribution-infinispan</artifactId>
+ <version>${project.version}</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project> \ No newline at end of file
diff --git a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java
new file mode 100644
index 000000000..73678ad2a
--- /dev/null
+++ b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java
@@ -0,0 +1,84 @@
+/*-
+ * ============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.hazelcast;
+
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
+
+import com.hazelcast.core.HazelcastInstance;
+import com.hazelcast.core.ILock;
+
+/**
+ * This class maps a Hazelcast {@link ILock} to a Java {@link ReadWriteLock}.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class HazelcastLock implements ReadWriteLock {
+ // The Lock ID
+ private final String lockID;
+
+ // The hazelcast lock
+ private final ILock readLock;
+ private final ILock writeLock;
+
+ /**
+ * Create a Hazelcast lock.
+ *
+ * @param hazelcastInstance the hazelcast instance to use to create the lock
+ * @param lockId The unique ID of the lock.
+ */
+ public HazelcastLock(final HazelcastInstance hazelcastInstance, final String lockId) {
+ lockID = lockId;
+
+ // Create the Hazelcast read and write locks
+ readLock = hazelcastInstance.getLock(lockId + "_READ");
+ writeLock = hazelcastInstance.getLock(lockId + "_WRITE");
+ }
+
+ /**
+ * Get the lock Id of the lock.
+ *
+ * @return the lock ID
+ */
+ public String getLockID() {
+ return lockID;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.util.concurrent.locks.ReadWriteLock#readLock()
+ */
+ @Override
+ public Lock readLock() {
+ return readLock;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.util.concurrent.locks.ReadWriteLock#writeLock()
+ */
+ @Override
+ public Lock writeLock() {
+ return writeLock;
+ }
+}
diff --git a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java
new file mode 100644
index 000000000..34258bf24
--- /dev/null
+++ b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java
@@ -0,0 +1,104 @@
+/*-
+ * ============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.hazelcast;
+
+import java.util.concurrent.locks.ReadWriteLock;
+
+import org.onap.policy.apex.context.ContextException;
+import org.onap.policy.apex.context.impl.locking.AbstractLockManager;
+import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
+import org.slf4j.ext.XLogger;
+import org.slf4j.ext.XLoggerFactory;
+
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.HazelcastInstance;
+
+/**
+ * The Class HazelcastLockManager manages Hazelcast locks for locks on items in Apex context albums.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class HazelcastLockManager extends AbstractLockManager {
+ // Logger for this class
+ private static final XLogger LOGGER = XLoggerFactory.getXLogger(HazelcastLockManager.class);
+
+ private HazelcastInstance hazelcastInstance;
+
+ /**
+ * Constructor, set up a lock manager that uses Hazelcast locking.
+ *
+ * @throws ContextException On errors connecting to the Hazelcast cluster
+ */
+ public HazelcastLockManager() throws ContextException {
+ LOGGER.entry("HazelcastLockManager(): setting up the Hazelcast lock manager . . .");
+
+ LOGGER.exit("HazelcastLockManager(): Hazelcast lock manager set up");
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.onap.policy.apex.context.impl.locking.AbstractLockManager#init(org.onap.policy.apex.
+ * model. basicmodel.concepts.AxArtifactKey)
+ */
+ @Override
+ public void init(final AxArtifactKey key) throws ContextException {
+ LOGGER.entry("init(" + key + ")");
+
+ super.init(key);
+
+ // Set up the Hazelcast instance for lock handling
+ hazelcastInstance = Hazelcast.newHazelcastInstance();
+
+ LOGGER.exit("init(" + key + ")");
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.onap.policy.apex.core.context.impl.locking.AbstractLockManager#getReentrantReadWriteLock(
+ * java.lang.String)
+ */
+ @Override
+ public ReadWriteLock getReentrantReadWriteLock(final String lockId) throws ContextException {
+ // Check if the framework is active
+ if (hazelcastInstance != null && hazelcastInstance.getLifecycleService().isRunning()) {
+ return new HazelcastLock(hazelcastInstance, lockId);
+ } else {
+ throw new ContextException("creation of hazelcast lock failed, see error log for details");
+ }
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.onap.policy.apex.core.context.LockManager#shutdown()
+ */
+ @Override
+ public void shutdown() {
+ if (hazelcastInstance == null) {
+ return;
+ }
+ hazelcastInstance.shutdown();
+ hazelcastInstance = null;
+ }
+}
diff --git a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/package-info.java b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/package-info.java
new file mode 100644
index 000000000..8d35556c4
--- /dev/null
+++ b/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/package-info.java
@@ -0,0 +1,27 @@
+/*-
+ * ============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=========================================================
+ */
+
+/**
+ * Implements locking on context items in APEX context albums using
+ * <a href="http://hazelcast.org/">Hazelcast</a> distributed locking.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+package org.onap.policy.apex.plugins.context.locking.hazelcast;