context/context-management/src/main/java/org/onap/policy/apex/context/impl/persistence/ephemeral/EphemeralPersistor.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.impl.persistence.ephemeral;
  22
  23 import java.util.Set;
  24 import java.util.TreeSet;
  25 import org.onap.policy.apex.context.ContextException;
  26 import org.onap.policy.apex.context.Persistor;
  27 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  28 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
  29 import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
  30
  31 /**
  32  * This class acts as an "in memory" persistor for a single JVM. It just initiates stubs the Persistor interface and
  33  * does not persist anything.
  34  *
  35  * @author Liam Fallon (liam.fallon@ericsson.com)
  36  */
  37 public class EphemeralPersistor implements Persistor {
  38
  39     // The key of this persistor
  40     private AxArtifactKey key;
  41
  42     /**
  43      * {@inheritDoc}.
  44      */
  45     @Override
  46     public void init(final AxArtifactKey persistorKey) throws ContextException {
  47         this.key = persistorKey;
  48     }
  49
  50     /**
  51      * {@inheritDoc}.
  52      */
  53     @Override
  54     public AxArtifactKey getKey() {
  55         return key;
  56     }
  57
  58     /**
  59      * {@inheritDoc}.
  60      */
  61     @Override
  62     public AxContextSchema readContextItem(final AxReferenceKey itemKey, final Class<?> contextItemClass) {
  63         // Can't read from this persistor as nothing is persisted
  64         return null;
  65     }
  66
  67     /**
  68      * {@inheritDoc}.
  69      */
  70     @Override
  71     public Set<AxContextSchema> readContextItems(final AxArtifactKey ownerKey, final Class<?> contextItemClass)
  72             throws ContextException {
  73         // No reading from persistence on the Ephemeral persistor, return an empty set
  74         return new TreeSet<>();
  75     }
  76
  77     /**
  78      * {@inheritDoc}.
  79      */
  80     @Override
  81     public Object writeContextItem(final Object contextItem) {
  82         // No writing to persistence on the Ephemeral persistor
  83         return contextItem;
  84     }
  85 }