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