context/context-management/src/main/java/org/onap/policy/apex/context/Persistor.java

   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;
  22
  23 import java.util.Set;
  24
  25 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  26 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
  27 import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
  28
  29 /**
  30  * This interface is implemented by plugin classes that persist Context Albums in Apex.
  31  *
  32  * @author Liam Fallon (liam.fallon@ericsson.com)
  33  */
  34 public interface Persistor {
  35
  36     /**
  37      * Initialize the persistor with its properties.
  38      *
  39      * @param key The key that identifies this persistor
  40      * @throws ContextException On errors initializing the persistor
  41      */
  42     void init(AxArtifactKey key) throws ContextException;
  43
  44     /**
  45      * Get the key of the persistor.
  46      *
  47      * @return the contextSetKey
  48      */
  49     AxArtifactKey getKey();
  50
  51     /**
  52      * Read a context item from the persistence mechanism.
  53      *
  54      * @param key the key of the context item
  55      * @param contextItemClassName the name of the context item class, a subclass of {@link AxContextSchema}
  56      * @return the context item that has been read
  57      * @throws ContextException on persistence read errors
  58      */
  59     AxContextSchema readContextItem(AxReferenceKey key, Class<?> contextItemClassName) throws ContextException;
  60
  61     /**
  62      * Read all the values of a particular type from persistence.
  63      *
  64      * @param ownerKey the owner key
  65      * @param contextItemClassName The class name of the objects to return
  66      * @return the set of context item values read from persistence or null if none were found
  67      * @throws ContextException On read errors
  68      */
  69     Set<AxContextSchema> readContextItems(AxArtifactKey ownerKey, Class<?> contextItemClassName)
  70             throws ContextException;
  71
  72     /**
  73      * Write a context item value to the persistence mechanism.
  74      *
  75      * @param contextItem the context item
  76      * @return the context item that has been written
  77      */
  78     Object writeContextItem(Object contextItem);
  79 }