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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.apex.context;
24 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
25 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
26 import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
29 * This interface is implemented by plugin classes that persist Context Albums in Apex.
31 * @author Liam Fallon (liam.fallon@ericsson.com)
33 public interface Persistor {
36 * Initialize the persistor with its properties.
38 * @param key The key that identifies this persistor
39 * @throws ContextException On errors initializing the persistor
41 void init(AxArtifactKey key) throws ContextException;
44 * Get the key of the persistor.
46 * @return the contextSetKey
48 AxArtifactKey getKey();
51 * Read a context item from the persistence mechanism.
53 * @param key the key of the context item
54 * @param contextItemClassName the name of the context item class, a subclass of {@link AxContextSchema}
55 * @return the context item that has been read
56 * @throws ContextException on persistence read errors
58 AxContextSchema readContextItem(AxReferenceKey key, Class<?> contextItemClassName) throws ContextException;
61 * Read all the values of a particular type from persistence.
63 * @param ownerKey the owner key
64 * @param contextItemClassName The class name of the objects to return
65 * @return the set of context item values read from persistence or null if none were found
66 * @throws ContextException On read errors
68 Set<AxContextSchema> readContextItems(AxArtifactKey ownerKey, Class<?> contextItemClassName)
69 throws ContextException;
72 * Write a context item value to the persistence mechanism.
74 * @param contextItem the context item
75 * @return the context item that has been written
77 Object writeContextItem(Object contextItem);