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.Timespan
  39
  40 /**
  41  * A policy is the fundamental business-related configuration of Aquarium.
  42  * Policies change over the course of time. The underlying representation must be immutable.
  43  *
  44  * TODO: The following sentence will self-destruct at most after 200 commits.
  45  * This model supersedes the original DSLPolicy, after changes in requirements and some thoughts on simplicity.
  46  *
  47  * @author Christos KK Loverdos <loverdos@gmail.com>
  48  */
  49
  50 trait PolicyModel {
  51   def id: String
  52
  53   def parentID: Option[String]
  54
  55   def idInStore: String
  56
  57
  58   /**
  59    * The time period within which this policy is valid.
  60    */
  61   def validityTimespan: Timespan
  62
  63   /**
  64    * All known resource types for the policy's validity period.
  65    */
  66   def resourceTypes: Set[ResourceType]
  67
  68
  69   /**
  70    * All known charging types for the policy's validity period.
  71    */
  72   def chargingTypes: Set[ChargingType]
  73
  74   /**
  75    * All known charging behaviors for the policy's validity period.<p/>
  76    *
  77    * Note than since a charging behavior is semantically attached to an implementation, a change in the set
  78    * of known charging behaviors normally means a change in the implementation of Aquarium.
  79    */
  80   def chargingBehaviors: List[ChargingBehavior]
  81
  82   /**
  83    * Each role is mapped to a full price table.
  84    */
  85   def roleMapping: Map[String/*Role*/, FullPriceTable]
  86
  87
  88   /**
  89    * All the known roles for the policy's validity period.
  90    * These names must be common between all communicating parties, i.e. the IM component that sends
  91    * [[gr.grnet.aquarium.event.model.im.IMEventModel]] events.
  92    *
  93    * This is a derived set, from the keys of `roleMapping`
  94    */
  95   def roles: Set[String] = roleMapping.keySet
  96
  97 }