champ-lib/champ-core/src/main/java/org/onap/aai/champcore/ChampTransaction.java

   1 /**
   2  * ============LICENSE_START==========================================
   3  * org.onap.aai
   4  * ===================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 Amdocs
   7  * ===================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22 package org.onap.aai.champcore;
  23
  24 import java.util.ArrayList;
  25 import java.util.Collections;
  26 import java.util.List;
  27 import java.util.UUID;
  28
  29 import org.onap.aai.champcore.event.ChampEvent;
  30 import org.onap.aai.champcore.exceptions.ChampTransactionException;
  31
  32 /**
  33  * This class defines the interface for a graph transaction object.
  34  */
  35 public abstract class ChampTransaction {
  36
  37   /** Unique identifier for this transaction (largely for logging purposes). */
  38   protected UUID  id;
  39
  40   protected List<ChampEvent> eventList = Collections.synchronizedList(new ArrayList<ChampEvent>());
  41
  42   public ChampTransaction() {
  43
  44     // Create a unique identifier for this transaction.
  45     id = UUID.randomUUID();
  46   }
  47
  48   public String id() {
  49     return id.toString();
  50   }
  51
  52   public void logEvent(ChampEvent event) {
  53     eventList.add(event);
  54   }
  55
  56   public List<ChampEvent> getEnqueuedEvents() {
  57     return eventList;
  58   }
  59
  60   /**
  61    * Finalize all updates to the graph which have been made within the context
  62    * of this transaction.
  63    */
  64   public abstract void commit() throws ChampTransactionException ;
  65
  66
  67   /**
  68    * Aborts all graph changes made within the context of this transaction, backing
  69    * out all changes as if they had never happened.
  70    */
  71   public abstract void rollback() throws ChampTransactionException ;
  72
  73 }