code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/policy/ChargingType.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 /**
  39  * A charging type gives a name to an existing charging behavior. The idea is to be able to reuse
  40  * the same charging behavior for charge types that may be advertised differently. For example, buying a book
  41  * and issuing a direct credit discount have the exactly same charging behavior (just add/subtract a specific
  42  * amount of credits to/from the wallet) but they are different business-wise.<p/>
  43  *
  44  * Using the original terminology of Aquarium, `vmtime` is a charging type. The exact implementation code that
  45  * implements the semantics of `vmtime` is its charging behavior.
  46  *
  47  * @param name     The name (alias) of the charging behaviour. Examples are
  48  *                 `vmtime`, `diskspace`, `bandwidth`.
  49  *
  50  * @param behavior The implementation class for the charging behaviour.
  51  *
  52  * @author Christos KK Loverdos <loverdos@gmail.com>
  53  */
  54 case class ChargingType(name: String, behavior: ChargingBehavior)