diff options
author | liamfallon <liam.fallon@ericsson.com> | 2018-07-18 11:23:20 +0100 |
---|---|---|
committer | liamfallon <liam.fallon@ericsson.com> | 2018-07-18 11:23:34 +0100 |
commit | b109c218ab7db28fd1cbe62c808496dfdedad809 (patch) | |
tree | aeb65f55c9cb138830e849d276cfd4ad3b861512 /plugins/plugins-context/context-locking/context-locking-hazelcast/src/main | |
parent | 1eb5198939bd1d60665ff49e49763d0067c1bcb5 (diff) |
Fix incorrect naming on context plugins
This change fixes inconsistent naming on the context plugins
in APEX. All plugins should fillow the naming convention of
plugin-A.plugin-A.B.plugin.A.B.C and so on. Not following
this convention breaks the APEX documentation build.
Issue-ID: POLICY-954
Change-Id: I8aad4a28d143427e60017eaa119ee4f7ce9f5b3d
Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'plugins/plugins-context/context-locking/context-locking-hazelcast/src/main')
3 files changed, 0 insertions, 215 deletions
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 deleted file mode 100644 index 73678ad2a..000000000 --- a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java +++ /dev/null @@ -1,84 +0,0 @@ -/*- - * ============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 deleted file mode 100644 index 34258bf24..000000000 --- a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java +++ /dev/null @@ -1,104 +0,0 @@ -/*- - * ============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 deleted file mode 100644 index 8d35556c4..000000000 --- a/plugins/plugins-context/context-locking/context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/package-info.java +++ /dev/null @@ -1,27 +0,0 @@ -/*- - * ============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; |