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