code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/OnceChargingBehavior.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 gr.grnet.aquarium.AquariumException
  40 import scala.collection.mutable
  41 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
  42 import gr.grnet.aquarium.policy.FullPriceTable
  43
  44 /**
  45  * A charging behavior for which resource events just carry a credit amount that will be added to the total one.
  46  *
  47  * Examples are: a) Give a gift of X credits to the user, b) User bought a book, so charge for the book price.
  48  *
  49  * @author Christos KK Loverdos <loverdos@gmail.com>
  50  */
  51 final class OnceChargingBehavior
  52     extends ChargingBehavior(
  53       ChargingBehaviorAliases.once,
  54       Set(ChargingBehaviorNameInput, CurrentValueInput)) {
  55
  56   protected def computeSelectorPath(
  57       chargingData: mutable.Map[String, Any],
  58       currentResourceEvent: ResourceEventModel,
  59       referenceTimeslot: Timeslot,
  60       previousValue: Double,
  61       totalCredits: Double,
  62       oldAccumulatingAmount: Double,
  63       newAccumulatingAmount: Double
  64   ): List[String] = {
  65     List(FullPriceTable.DefaultSelectorKey)
  66   }
  67   /**
  68    * This is called when we have the very first event for a particular resource instance, and we want to know
  69    * if it is billable or not.
  70    */
  71   def isBillableFirstEvent(event: ResourceEventModel) = {
  72     true
  73   }
  74
  75   def mustGenerateDummyFirstEvent = false // no need to
  76
  77   def computeNewAccumulatingAmount(oldAmount: Double, newEventValue: Double, details: Map[String, String]) = {
  78     oldAmount
  79   }
  80
  81   def getResourceInstanceInitialAmount = 0.0
  82
  83   def supportsImplicitEvents = false
  84
  85   def mustConstructImplicitEndEventFor(resourceEvent: ResourceEventModel) = false
  86
  87   def constructImplicitEndEventFor(resourceEvent: ResourceEventModel, occurredMillis: Long) = {
  88     throw new AquariumException("constructImplicitEndEventFor() Not compliant with %s".format(this))
  89   }
  90 }
  91
  92 object OnceChargingBehavior {
  93   private[this] final val TheOne = new OnceChargingBehavior
  94
  95   def apply(): OnceChargingBehavior = TheOne
  96 }