code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/charging/ChargingBehavior.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.Aquarium
  39 import gr.grnet.aquarium.charging.state.UserStateModel
  40 import gr.grnet.aquarium.computation.BillingMonthInfo
  41 import gr.grnet.aquarium.event.{CreditsModel, DetailsModel}
  42 import gr.grnet.aquarium.message.avro.gen.{WalletEntryMsg, EffectivePriceTableMsg, FullPriceTableMsg, ResourcesChargingStateMsg, ResourceTypeMsg, ResourceInstanceChargingStateMsg, ResourceEventMsg}
  43 import gr.grnet.aquarium.uid.{PrefixedUIDGenerator, ConcurrentVMLocalUIDGenerator}
  44 import gr.grnet.aquarium.policy.{EffectivePriceTableModel, FullPriceTableModel}
  45
  46 /**
  47  * A charging behavior indicates how charging for a resource will be done
  48  * wrt the various states a resource instance can be in.
  49  *
  50  * @author Christos KK Loverdos <loverdos@gmail.com>
  51  */
  52
  53 trait ChargingBehavior {
  54   def selectorLabelsHierarchy: List[String]
  55
  56   /**
  57    * Provides some initial charging details that will be part of the mutable charging state
  58    * ([[gr.grnet.aquarium.message.avro.gen.ResourcesChargingStateMsg]]).
  59    */
  60   def initialChargingDetails: DetailsModel.Type
  61
  62   def computeSelectorPath(
  63       ChargingBehaviorDetails: DetailsModel.Type,
  64       resourceInstanceChargingState: ResourceInstanceChargingStateMsg,
  65       currentResourceEvent: ResourceEventMsg,
  66       referenceStartMillis: Long,
  67       referenceStopMillis: Long,
  68       totalCredits: CreditsModel.Type
  69   ): List[String]
  70
  71   def selectEffectivePriceTableModel(
  72       fullPriceTable: FullPriceTableModel,
  73       chargingBehaviorDetails: DetailsModel.Type,
  74       resourceInstanceChargingState: ResourceInstanceChargingStateMsg,
  75       currentResourceEvent: ResourceEventMsg,
  76       referenceStartMillis: Long,
  77       referenceStopMillis: Long,
  78       totalCredits: Double
  79   ): EffectivePriceTableModel
  80
  81   /**
  82    *
  83    * @return The number of wallet entries recorded and the credit difference generated during processing (these are
  84    *         the credits to subtract from the total credits).
  85    */
  86   def processResourceEvent(
  87       aquarium: Aquarium,
  88       resourceEvent: ResourceEventMsg,
  89       resourceType: ResourceTypeMsg,
  90       billingMonthInfo: BillingMonthInfo,
  91       resourcesChargingState: ResourcesChargingStateMsg,
  92       userStateModel: UserStateModel,
  93       walletEntryRecorder: WalletEntryMsg ⇒ Unit
  94   ): (Int, CreditsModel.Type)
  95
  96   def computeCreditsToSubtract(
  97       resourceInstanceChargingState: ResourceInstanceChargingStateMsg,
  98       oldCredits: CreditsModel.Type,
  99       timeDeltaMillis: Long,
 100       unitPrice: Double
 101   ): (CreditsModel.Type, String /* explanation */)
 102
 103   /**
 104    * Given the charging state of a resource instance and the details of the incoming message, compute the new
 105    * accumulating amount.
 106    */
 107   def computeNewAccumulatingAmount(
 108       resourceInstanceChargingState: ResourceInstanceChargingStateMsg,
 109       eventDetails: DetailsModel.Type
 110   ): CreditsModel.Type
 111
 112   def createVirtualEventsForRealtimeComputation(
 113       userID: String,
 114       resourceTypeName: String,
 115       resourceInstanceID: String,
 116       eventOccurredMillis: Long,
 117       resourceInstanceChargingState: ResourceInstanceChargingStateMsg
 118   ): List[ResourceEventMsg]
 119 }