code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/event/NewWalletEntry.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
  37 package event
  38
  39 import gr.grnet.aquarium.logic.accounting.Chargeslot
  40 import gr.grnet.aquarium.util.date.MutableDateCalc
  41 import gr.grnet.aquarium.logic.accounting.dsl.{Timeslot, DSLResource}
  42 import converter.{JsonTextFormat, StdConverters}
  43 import resource.ResourceEventModel
  44
  45 /**
  46  * The following equation must hold: `newTotalCredits = oldTotalCredits + entryCredits`.
  47  *
  48  * @author Christos KK Loverdos <loverdos@gmail.com>
  49  *
  50  * @param userId The user ID this wallet entry is related to.
  51  * @param entryCredits The credit amount generated for this wallet entry.
  52  * @param oldTotalCredits
  53  * @param newTotalCredits
  54  * @param whenComputedMillis When the computation took place
  55  * @param yearOfBillingMonth
  56  * @param billingMonth
  57  * @param resourceEvents
  58  * @param chargeslots The details of the credit computation
  59  * @param resourceDef
  60  */
  61 case class NewWalletEntry(userId: String,
  62                           entryCredits: Double,
  63                           oldTotalCredits: Double,
  64                           newTotalCredits: Double,
  65                           whenComputedMillis: Long,
  66                           referenceTimeslot: Timeslot,
  67                           yearOfBillingMonth: Int,
  68                           billingMonth: Int,
  69                           resourceEvents: List[ResourceEventModel], // current is at the head
  70                           chargeslots: List[Chargeslot],
  71                           resourceDef: DSLResource,
  72                           isSynthetic: Boolean) {
  73
  74   def currentResourceEvent = resourceEvents.head
  75   def resource = currentResourceEvent.resource
  76   def instanceId = currentResourceEvent.instanceID
  77   def chargslotCount = chargeslots.length
  78   def isOutOfSync = currentResourceEvent.isOutOfSyncForBillingMonth(yearOfBillingMonth, billingMonth)
  79
  80   def toDebugString = "%s%s(%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)".format(
  81     if(isSynthetic) "*" else "",
  82     gr.grnet.aquarium.util.shortClassNameOf(this),
  83     userId,
  84     referenceTimeslot,
  85     entryCredits,
  86     oldTotalCredits,
  87     newTotalCredits,
  88     new MutableDateCalc(whenComputedMillis).toYYYYMMDDHHMMSSSSS,
  89     yearOfBillingMonth,
  90     billingMonth,
  91     resourceEvents,
  92     chargeslots,
  93     resourceDef
  94   )
  95 }
  96
  97 object NewWalletEntry {
  98   def fromJson(json: String): NewWalletEntry = {
  99     StdConverters.AllConverters.convertEx[NewWalletEntry](JsonTextFormat(json))
 100   }
 101
 102   object JsonNames {
 103     final val _id = "_id"
 104     final val id = "id"
 105     final val entryCredits = "entryCredits"
 106     final val oldTotalCredits = "oldTotalCredits"
 107     final val newTotalCredits = "newTotalCredits"
 108     final val whenComputedMillis = "whenComputedMillis"
 109     final val yearOfBillingMonth = "yearOfBillingMonth"
 110     final val billingMonth = "billingMonth"
 111     final val currentResourceEvent = "currentResourceEvent"
 112     final val previousResourceEvent = "previousResourceEvent"
 113     final val chargeslots = "chargeslots"
 114     final val resourceDef = "resourceDef"
 115   }
 116 }