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.{AquariumInternalError, Timespan}
  39 import gr.grnet.aquarium.util.json.JsonSupport
  40 import gr.grnet.aquarium.charging.ChargingBehavior
  41 import gr.grnet.aquarium.converter.{JsonTextFormat, StdConverters}
  42
  43 /**
  44  * A policy is the fundamental business-related configuration of Aquarium.
  45  * Policies change over the course of time. The underlying representation must be immutable.
  46  *
  47  * TODO: The following sentence will self-destruct at most after 200 commits.
  48  * This model supersedes the original DSLPolicy, after changes in requirements and some thoughts on simplicity.
  49  *
  50  * @author Christos KK Loverdos <loverdos@gmail.com>
  51  */
  52
  53 trait PolicyModel extends Ordered[PolicyModel] with JsonSupport {
  54   final def compare(that: PolicyModel): Int = {
  55     if(this.validFromMillis < that.validFromMillis) {
  56       -1
  57     } else if(this.validFromMillis == that.validFromMillis) {
  58       0
  59     } else {
  60       1
  61     }
  62   }
  63
  64   def originalID: String
  65
  66   def parentID: Option[String]
  67
  68   def inStoreID: Option[String]
  69
  70   def validFromMillis: Long
  71   def validToMillis: Long
  72   /**
  73    * The time period within which this policy is valid.
  74    */
  75   def validityTimespan: Timespan = Timespan(validFromMillis, validToMillis)
  76
  77   /**
  78    * All known resource types for the policy's validity period.
  79    */
  80   def resourceTypes: Set[ResourceType]
  81
  82   /**
  83    * All known charging behaviors for the policy's validity period.<p/>
  84    *
  85    * Note than since a charging behavior is semantically attached to an implementation, a change in the set
  86    * of known charging behaviors normally means a change in the implementation of Aquarium.
  87    */
  88   def chargingBehaviors: Set[String/*ImplementationClassName*/]
  89
  90   /**
  91    * Each role is mapped to a full price table.
  92    */
  93   def roleMapping: Map[String/*Role*/, FullPriceTable]
  94
  95
  96   /**
  97    * All the known roles for the policy's validity period.
  98    * These names must be common between all communicating parties, i.e. the IM component that sends
  99    * [[gr.grnet.aquarium.event.model.im.IMEventModel]] events.
 100    *
 101    * This is a derived set, from the keys of `roleMapping`
 102    */
 103   def roles: Set[String] = roleMapping.keySet
 104
 105   def resourceTypesMap: Map[String, ResourceType] = Map(resourceTypes.map(rt ⇒ (rt.name, rt)).toSeq: _*)
 106
 107   def resourceTypeByName(resource: String): Option[ResourceType] = resourceTypes.find(_.name == resource)
 108 }
 109
 110 object PolicyModel {
 111   def fromJsonString(json: String): StdPolicy = {
 112     StdConverters.AllConverters.convertEx[StdPolicy](JsonTextFormat(json))
 113   }
 114
 115   def apply(
 116       originalID: String,
 117       inStoreID: Option[String],
 118       parentID: Option[String],
 119       validFromMillis: Long,
 120       validToMillis: Long,
 121       resourceTypes: Set[ResourceType],
 122       chargingBehaviors: Set[String],
 123       roleMapping: Map[String /* role name */, FullPriceTable]
 124   ): PolicyModel = {
 125
 126     StdPolicy(
 127       originalID,
 128       inStoreID,
 129       parentID,
 130       validFromMillis,
 131       validToMillis,
 132       resourceTypes,
 133       chargingBehaviors,
 134       roleMapping
 135     )
 136   }
 137 }