code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/ContinuousChargingBehavior.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.charging
  37
  38 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
  39 import scala.collection.mutable
  40 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
  41
  42 /**
  43  * In practice a resource usage will be charged for the total amount of usage
  44  * between resource usage changes.
  45  *
  46  * Example resource that might be adept to a continuous policy is diskspace, as in Pithos+ service.
  47  *
  48  * @author Christos KK Loverdos <loverdos@gmail.com>
  49  */
  50 final class ContinuousChargingBehavior
  51     extends ChargingBehavior(
  52       ChargingBehaviorAliases.continuous,
  53       Set(ChargingBehaviorNameInput, UnitPriceInput, OldTotalAmountInput, TimeDeltaInput)) {
  54
  55   protected def computeSelectorPath(
  56       chargingData: mutable.Map[String, Any],
  57       currentResourceEvent: ResourceEventModel,
  58       referenceTimeslot: Timeslot,
  59       previousValue: Double,
  60       totalCredits: Double,
  61       oldAccumulatingAmount: Double,
  62       newAccumulatingAmount: Double
  63   ): List[String] = {
  64     Nil
  65   }
  66
  67   def computeNewAccumulatingAmount(oldAmount: Double, newEventValue: Double, details: Map[String, String]): Double = {
  68     // If the total is in the details, get it, or else compute it
  69     details.get("total") match {
  70       case Some(total) ⇒
  71         total.toDouble
  72
  73       case _ ⇒
  74         oldAmount + newEventValue
  75     }
  76   }
  77
  78   def getResourceInstanceInitialAmount: Double = {
  79     0.0
  80   }
  81
  82   /**
  83    * This is called when we have the very first event for a particular resource instance, and we want to know
  84    * if it is billable or not.
  85    */
  86   def isBillableFirstEvent(event: ResourceEventModel) = {
  87     true
  88   }
  89
  90   def mustGenerateDummyFirstEvent = true
  91
  92   def supportsImplicitEvents = {
  93     true
  94   }
  95
  96   def mustConstructImplicitEndEventFor(resourceEvent: ResourceEventModel) = {
  97     true
  98   }
  99
 100   def constructImplicitEndEventFor(resourceEvent: ResourceEventModel, newOccurredMillis: Long) = {
 101     assert(supportsImplicitEvents && mustConstructImplicitEndEventFor(resourceEvent))
 102
 103     val details = resourceEvent.details
 104     val newDetails = ResourceEventModel.setAquariumSyntheticAndImplicitEnd(details)
 105
 106     resourceEvent.withDetails(newDetails, newOccurredMillis)
 107   }
 108 }
 109
 110 object ContinuousChargingBehavior {
 111   private[this] final val TheOne = new ContinuousChargingBehavior
 112
 113   def apply(): ContinuousChargingBehavior = TheOne
 114 }