code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/event/model/ExternalEventModel.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.model
  37
  38 import gr.grnet.aquarium.util.makeBytes
  39 import gr.grnet.aquarium.util.shortClassNameOf
  40 import gr.grnet.aquarium.util.json.JsonSupport
  41 import gr.grnet.aquarium.util.xml.XmlSupport
  42 import gr.grnet.aquarium.util.date.MutableDateCalc
  43
  44 /**
  45  * The base model for all events coming from external systems.
  46  *
  47  * @author Christos KK Loverdos <loverdos@gmail.com>
  48  */
  49
  50 trait ExternalEventModel extends EventModel with JsonSupport with XmlSupport {
  51   /**
  52    * When it was received by Aquarium
  53    */
  54   def receivedMillis: Long
  55
  56   def userID: String
  57
  58
  59   def toBytes: Array[Byte] = makeBytes(toJsonString)
  60
  61   def withReceivedMillis(newReceivedMillis: Long): ExternalEventModel
  62
  63   def toDebugString = "%s(userID=%s, id=%s, occurred=%s)".format(
  64     shortClassNameOf(this),
  65     userID,
  66     id,
  67     new MutableDateCalc(occurredMillis).toString)
  68 }
  69
  70 object ExternalEventModel {
  71   trait NamesT extends EventModel.NamesT {
  72     final val receivedMillis = "receivedMillis"
  73     final val userID = "userID"
  74   }
  75
  76   object Names extends NamesT
  77 }