code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/event/EventModel.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 /**
  39  * Basic properties for all events.
  40  * An event represents some state change, where state is specific to the use-case.
  41  *
  42  *@author Christos KK Loverdos <loverdos@gmail.com>
  43  */
  44
  45 trait EventModel {
  46   /**
  47    * The unique event id. The responsibility for the id generation is to the event generator.
  48    */
  49   def id: String
  50
  51   /**
  52    * The Unix time of the state change occurrence that this event represents.
  53    */
  54   def occurredMillis: Long
  55
  56   /**
  57    * The ID given to this event if/when persisted to a store.
  58    * The exact type of the id is store-specific.
  59    */
  60   def storeID: Option[AnyRef] = None
  61
  62   def eventVersion: String
  63
  64   /**
  65    * An extension point that provides even more properties.
  66    */
  67   def details: Map[String, String]
  68
  69   def withDetails(newDetails: Map[String, String], newOccurredMillis: Long): EventModel
  70 }
  71
  72
  73 object EventModel {
  74   trait NamesT {
  75     final val id = "id"
  76     final val occurredMillis = "occurredMillis"
  77     final val storeID = "storeID"
  78     final val eventVersion = "eventVersion"
  79     final val details = "details"
  80   }
  81
  82   object Names extends NamesT
  83 }