code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/policy/PolicyModel.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.policy
  37
  38 import gr.grnet.aquarium.message.avro.ModelFactory
  39 import gr.grnet.aquarium.message.avro.gen.{FullPriceTableMsg, PolicyMsg}
  40 import gr.grnet.aquarium.util.json.JsonSupport
  41 import scala.collection.JavaConverters.asScalaBufferConverter
  42 import scala.collection.immutable
  43 import gr.grnet.aquarium.AquariumInternalError
  44
  45 /**
  46  * A policy is the fundamental business-related configuration of Aquarium.
  47  * Policies change over the course of time. The underlying representation must be immutable.
  48  *
  49  * TODO: The following sentence will self-destruct at most after 200 commits.
  50  * This model supersedes the original DSLPolicy, after changes in requirements and some thoughts on simplicity.
  51  *
  52  * @author Christos KK Loverdos <loverdos@gmail.com>
  53  */
  54
  55 case class PolicyModel(
  56     msg: PolicyMsg
  57 ) extends Ordered[PolicyModel] with JsonSupport {
  58
  59   /**
  60    * Each role is mapped to a full price table.
  61    */
  62   val roleMapping = ModelFactory.newRoleMapping(msg.getRoleMapping)
  63
  64   /**
  65    * All known charging behaviors for the policy's validity period. These are the fully
  66    * qualified class names that implement [[gr.grnet.aquarium.charging.ChargingBehavior]]<p/>
  67    * Note than since a charging behavior is semantically attached to an implementation,
  68    * a change in the set of known charging behaviors normally means a change in the
  69    * implementation of Aquarium.
  70    */
  71   val chargingBehaviors = immutable.Set(msg.getChargingBehaviors().asScala.toSeq: _*)
  72
  73   /**
  74    * All known resource types for the policy's validity period.
  75    */
  76   val resourceTypes = immutable.Set(msg.getResourceTypes().asScala.map(ModelFactory.newResourceType).toSeq: _*)
  77
  78   def validFromMillis = msg.getValidFromMillis: Long
  79
  80   def validToMillis = msg.getValidToMillis: Long
  81
  82   final def compare(that: PolicyModel): Int = {
  83     if(this.validFromMillis < that.validFromMillis) {
  84       -1
  85     } else if(this.validFromMillis == that.validFromMillis) {
  86       0
  87     } else {
  88       1
  89     }
  90   }
  91
  92   /**
  93    * All the known roles for the policy's validity period.
  94    * These names must be common between all communicating parties, i.e. the IM component that sends
  95    * [[gr.grnet.aquarium.message.avro.gen.IMEventMsg]] events.
  96    *
  97    * This is a derived set, from the keys of `roleMapping`
  98    */
  99   val roles = roleMapping.keySet
 100
 101   val resourceTypesMap = immutable.Map(resourceTypes.map(rt ⇒ (rt.name, rt)).toSeq: _*)
 102
 103   def resourceTypeByName(resource: String) = resourceTypes.find(_.name == resource)
 104 }