code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/event/model/WalletEntry.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 java.util.Date
  39 import gr.grnet.aquarium.converter.{JsonTextFormat, StdConverters}
  40
  41 /**
  42  * A WalletEntry is a derived entity. Its data represent money/credits and are calculated based on
  43  * resource events.
  44  *
  45  * Wallet entries give us a picture of when credits are calculated from resource events.
  46  *
  47  * @author Georgios Gousios <gousiosg@gmail.com>
  48  * @author Christos KK Loverdos <loverdos@gmail.com>
  49  */
  50 case class WalletEntry(
  51                         id: String, // The id at the client side (the sender) TODO: Rename to remoteId or something...
  52                         occurredMillis: Long, // The time of oldest matching resource event
  53                         receivedMillis: Long, // The time the cost calculation was done
  54                         sourceEventIDs: List[String], // The events that triggered this WalletEntry
  55                         value: Double,
  56                         reason: String,
  57                         userId: String,
  58                         resource: String,
  59                         instanceId: String,
  60                         finalized: Boolean,
  61                         eventVersion: String = "1.0",
  62                         userID: String = "",
  63                         details: Map[String, String] = Map()
  64                         ) extends ExternalEventModel {
  65
  66
  67   assert(occurredMillis > 0)
  68   assert(value >= 0F)
  69   assert(!userId.isEmpty)
  70
  71   def validate = true
  72
  73   def fromResourceEvent(rceId: String): Boolean = {
  74     sourceEventIDs contains rceId
  75   }
  76
  77   def withReceivedMillis(millis: Long) = copy(receivedMillis = millis)
  78
  79   def withDetails(newDetails: Map[String, String], newOccurredMillis: Long) =
  80     this.copy(details = newDetails, occurredMillis = newOccurredMillis)
  81
  82   def occurredDate = new Date(occurredMillis)
  83
  84   def receivedDate = new Date(receivedMillis)
  85 }
  86
  87 object WalletEntry {
  88   def fromJson(json: String): WalletEntry = {
  89     StdConverters.AllConverters.convertEx[WalletEntry](JsonTextFormat(json))
  90   }
  91
  92   def zero = WalletEntry("", 1L, 1L, Nil, 1, "", "foo", "bar", "0", false)
  93
  94   object JsonNames {
  95     final val _id = "_id"
  96     final val id = "id"
  97     final val occurredMillis = "occurredMillis"
  98     final val receivedMillis = "receivedMillis"
  99     final val sourceEventIDs = "sourceEventIDs"
 100     final val value = "value"
 101     final val reason = "reason"
 102     final val userId = "userId"
 103     final val resource = "resource"
 104     final val instanceId = "instanceId"
 105     final val finalized = "finalized"
 106   }
 107
 108 }