code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/event/AquariumEventModel.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.event
  37
  38 import gr.grnet.aquarium.util.json.JsonSupport
  39
  40 /**
  41  * The base model for all events coming from external systems.
  42  *
  43  * @author Christos KK Loverdos <loverdos@gmail.com>
  44  */
  45
  46 trait AquariumEventModel extends JsonSupport {
  47   def id: String
  48   def occurredMillis: Long
  49   def receivedMillis: Long
  50   def userID: String
  51   def eventVersion: String
  52   def details: Map[String, String]
  53
  54   /**
  55    * The ID given to this event if/when persisted to a store.
  56    * The exact type of the id is store-specific.
  57    */
  58   def storeID: Option[AnyRef]
  59
  60   def isStoredEvent: Boolean = false
  61
  62   def withReceivedMillis(newReceivedMillis: Long): AquariumEventModel
  63 }
  64
  65 object AquariumEventModel {
  66   trait NamesT {
  67     final val id = "id"
  68     final val occurredMillis = "occurredMillis"
  69     final val receivedMillis = "receivedMillis"
  70     final val userID = "userID"
  71     final val eventVersion = "eventVersion"
  72     final val details = "details"
  73   }
  74
  75   object Names extends NamesT
  76 }