60de80a7f2aa316a67e9f3c1459c2b75e630355f
[policy/apex-pdp.git] /
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.persistence;
22
23 import org.onap.policy.apex.context.ContextException;
24 import org.onap.policy.apex.context.Persistor;
25 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
26 import org.onap.policy.apex.context.parameters.PersistorParameters;
27 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
28 import org.onap.policy.apex.model.utilities.Assertions;
29 import org.onap.policy.common.parameters.ParameterService;
30 import org.slf4j.ext.XLogger;
31 import org.slf4j.ext.XLoggerFactory;
32
33 /**
34  * This class returns a persistor for the particular type of persistor mechanism that has been configured for use.
35  *
36  * @author Liam Fallon (liam.fallon@ericsson.com)
37  */
38 public class PersistorFactory {
39     // Get a reference to the logger
40     private static final XLogger LOGGER = XLoggerFactory.getXLogger(PersistorFactory.class);
41
42     /**
43      * Return a persistor for the persistence mechanism configured for use.
44      *
45      * @param key The key for the persistor
46      * @return a persistor
47      * @throws ContextException on invalid persistor types
48      */
49     public Persistor createPersistor(final AxArtifactKey key) throws ContextException {
50         LOGGER.entry("persistor factory, key=" + key);
51         Assertions.argumentOfClassNotNull(key, ContextException.class, "Parameter \"key\" may not be null");
52
53         final PersistorParameters persistorParameters = ParameterService
54                         .get(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
55
56         // Get the class for the persistor using reflection
57         Object persistorObject = null;
58         final String pluginClass = persistorParameters.getPluginClass();
59         try {
60             persistorObject = Class.forName(pluginClass).newInstance();
61         } catch (InstantiationException | IllegalAccessException | ClassNotFoundException e) {
62             LOGGER.error("Apex context persistor class not found for context persistor plugin \"" + pluginClass + "\"",
63                             e);
64             throw new ContextException("Apex context persistor class not found for context persistor plugin \""
65                             + pluginClass + "\"", e);
66         }
67
68         // Check the class is a persistor
69         if (!(persistorObject instanceof Persistor)) {
70             LOGGER.error("Specified Apex context persistor plugin class \"{}\" "
71                             + "does not implement the ContextDistributor interface", pluginClass);
72             throw new ContextException("Specified Apex context persistor plugin class \"" + pluginClass
73                             + "\" does not implement the ContextDistributor interface");
74         }
75
76         // The persistor to return
77         final Persistor persistor = (Persistor) persistorObject;
78
79         // Lock and load the persistor
80         persistor.init(key);
81
82         LOGGER.exit("Persistor factory, key=" + key + ", selected persistor of class " + persistor.getClass());
83         return persistor;
84     }
85 }