blob: 9aac801a32e2d8982b0c0a541f8a1bd602281f8e (
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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2020 Nordix Foundation.
* Modifications Copyright (C) 2021 Bell Canada. 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.context.impl.locking;
import org.onap.policy.apex.context.ContextException;
import org.onap.policy.apex.context.LockManager;
import org.onap.policy.apex.context.parameters.ContextParameterConstants;
import org.onap.policy.apex.context.parameters.LockManagerParameters;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.common.parameters.ParameterService;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/**
* This class returns a {@link LockManager} for the particular type of locking mechanism that has been configured for
* use.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class LockManagerFactory {
// Get a reference to the logger
private static final XLogger LOGGER = XLoggerFactory.getXLogger(LockManagerFactory.class);
/**
* Return a {@link LockManager} for the particular type of locking mechanism configured for use.
*
* @param key The key for the lock manager
* @return a lock manager that can generate locks using some underlying mechanism
* @throws ContextException on errors in getting a lock manager
*/
public LockManager createLockManager(final AxArtifactKey key) throws ContextException {
LOGGER.entry("Lock Manager factory, key=" + key);
final var lockManagerParameters =
(LockManagerParameters) ParameterService.get(ContextParameterConstants.LOCKING_GROUP_NAME);
// Get the class for the lock manager using reflection
Object lockManagerObject = null;
final String pluginClass = lockManagerParameters.getPluginClass();
try {
lockManagerObject = Class.forName(pluginClass).getDeclaredConstructor().newInstance();
} catch (Exception e) {
LOGGER.error(
"Apex context lock manager class not found for context lock manager plugin \"" + pluginClass + "\"",
e);
throw new ContextException(
"Apex context lock manager class not found for context lock manager plugin \"" + pluginClass + "\"",
e);
}
// Check the class is a lock manager
if (!(lockManagerObject instanceof LockManager)) {
LOGGER.error("Specified Apex context lock manager plugin class \"{}\" "
+ "does not implement the LockManager interface", pluginClass);
throw new ContextException("Specified Apex context lock manager plugin class \"" + pluginClass
+ "\" does not implement the LockManager interface");
}
// The context lock manager to return
final var lockManager = (LockManager) lockManagerObject;
// Lock and load (OK sorry!!!) the lock manager
lockManager.init(key);
LOGGER.exit("Lock manager factory, key=" + key + ", selected lock manager of class " + lockManager.getClass());
return lockManager;
}
}
|
