code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/logic/events/ResourceEvent.scala

   1 /*
   2  * Copyright 2011 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.logic.events
  37
  38 import gr.grnet.aquarium.logic.accounting.Policy
  39 import net.liftweb.json.{JsonAST, Xml}
  40 import gr.grnet.aquarium.util.json.JsonHelpers
  41 import gr.grnet.aquarium.logic.accounting.dsl.{DSLResource, DSLComplexResource}
  42
  43 /**
  44  * Event sent to Aquarium by clients for resource accounting.
  45  *
  46  * @author Christos KK Loverdos <loverdos@gmail.com>.
  47  * @author Georgios Gousios <gousiosg@gmail.com>.
  48  */
  49 case class ResourceEvent(
  50     override val id: String,           // The id at the client side (the sender) TODO: Rename to remoteId or something...
  51     override val occurredMillis: Long, // When it occurred at client side (the sender)
  52     override val receivedMillis: Long, // When it was received by Aquarium
  53     userId: String,                    // The user for which this resource is relevant
  54     clientId: String,                  // The unique client identifier (usually some hash)
  55     resource: String,                  // String representation of the resource type (e.g. "bndup", "vmtime").
  56     eventVersion: String,
  57     value: Float,
  58     details: ResourceEvent.Details)
  59   extends AquariumEvent(id, occurredMillis, receivedMillis) {
  60
  61   def validate() : Boolean = {
  62
  63     if (getInstanceId.isEmpty)
  64       return false
  65
  66     true
  67   }
  68
  69   /**
  70    * Return the instance id affected by this resource event. If either the
  71    * resource or the instance id field cannot be found, this method returns an
  72    * empty String.
  73    */
  74   def getInstanceId: String = {
  75     Policy.policy.findResource(this.resource) match {
  76       case None => ""
  77       case Some(x) => x.isComplex match {
  78         case false => "1"
  79         case true =>
  80           details.getOrElse(x.asInstanceOf[DSLComplexResource].descriminatorField, "")
  81       }
  82     }
  83   }
  84
  85   def setRcvMillis(millis: Long) = copy(receivedMillis = millis)
  86 }
  87
  88 object ResourceEvent {
  89   type Details = Map[String, String]
  90
  91   def fromJson(json: String): ResourceEvent = {
  92     JsonHelpers.jsonToObject[ResourceEvent](json)
  93   }
  94
  95   def fromJValue(jsonAST: JsonAST.JValue): ResourceEvent = {
  96     JsonHelpers.jValueToObject[ResourceEvent](jsonAST)
  97   }
  98
  99   def fromBytes(bytes: Array[Byte]): ResourceEvent = {
 100     JsonHelpers.jsonBytesToObject[ResourceEvent](bytes)
 101   }
 102
 103   def fromXml(xml: String): ResourceEvent = {
 104     fromJValue(Xml.toJson(scala.xml.XML.loadString(xml)))
 105   }
 106
 107   object JsonNames {
 108     final val _id = "_id"
 109     final val id = "id"
 110     final val userId = "userId"
 111     final val timestamp = "timestamp" // TODO: deprecate in favor of "occurredMillis"
 112     final val occurredMillis = "occurredMillis"
 113     final val receivedMillis = "receivedMillis"
 114     final val clientId = "clientId"
 115
 116     // ResourceType: VMTime
 117     final val vmId = "vmId"
 118     final val action = "action" // "on", "off"
 119   }
 120 }