2 * Copyright 2011 GRNET S.A. All rights reserved.
4 * Redistribution and use in source and binary forms, with or
5 * without modification, are permitted provided that the following
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
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.
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.
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.
36 package gr.grnet.aquarium.logic.events
38 import net.liftweb.json.{JsonAST, Xml}
39 import gr.grnet.aquarium.util.json.JsonHelpers
40 import gr.grnet.aquarium.logic.accounting.dsl._
41 import com.ckkloverdos.maybe.{MaybeOption, Maybe}
43 import gr.grnet.aquarium.util.date.MutableDateCalc
46 * Event sent to Aquarium by clients for resource accounting.
48 * @author Christos KK Loverdos <loverdos@gmail.com>.
49 * @author Georgios Gousios <gousiosg@gmail.com>.
51 case class ResourceEvent(
52 override val id: String, // The id at the client side (the sender) TODO: Rename to remoteId or something...
53 override val occurredMillis: Long, // When it occurred at client side (the sender)
54 override val receivedMillis: Long, // When it was received by Aquarium
55 userId: String, // The user for which this resource is relevant
56 clientId: String, // The unique client identifier (usually some hash)
57 resource: String, // String representation of the resource type (e.g. "bndup", "vmtime").
58 instanceId: String, // String representation of the resource instance id
61 details: ResourceEvent.Details)
62 extends AquariumEvent(id, occurredMillis, receivedMillis) {
64 def validate() : Boolean = {
68 def safeResource = if(resource eq null) "" else resource
69 def safeInstanceId = if(instanceId eq null) "" else instanceId
71 def hasResource = !safeResource.isEmpty
72 def hasInstanceId = !safeInstanceId.isEmpty
74 def fullResourceInfo = (safeResource, safeInstanceId)
76 def occurredDate = new Date(occurredMillis)
78 def occurredDeltaFrom(that: ResourceEvent): Long = {
79 this.occurredMillis - that.occurredMillis
82 def isOccurredWithinMillis(fromMillis: Long, toMillis: Long): Boolean = {
83 require(fromMillis <= toMillis, "fromMillis <= toMillis")
84 fromMillis <= occurredMillis && occurredMillis <= toMillis
87 def isOccurredWithinDates(fromDate: Date, toDate: Date): Boolean = {
88 isOccurredWithinMillis(fromDate.getTime, toDate.getTime)
91 def isReceivedWithinMillis(fromMillis: Long, toMillis: Long): Boolean = {
92 require(fromMillis <= toMillis, "fromMillis <= toMillis")
93 fromMillis <= receivedMillis && receivedMillis <= toMillis
96 def isReceivedWithinDates(fromDate: Date, toDate: Date): Boolean = {
97 isReceivedWithinMillis(fromDate.getTime, toDate.getTime)
100 def isReceivedWithinDateCalcs(fromDate: MutableDateCalc, toDate: MutableDateCalc): Boolean = {
101 isReceivedWithinMillis(fromDate.getMillis, toDate.getMillis)
104 def isOccurredOrReceivedWithinMillis(fromMillis: Long, toMillis: Long): Boolean = {
105 isOccurredWithinMillis(fromMillis, toMillis) ||
106 isReceivedWithinMillis(fromMillis, toMillis)
109 def isOccurredOrReceivedWithinDates(fromDate: Date, toDate: Date): Boolean = {
110 isOccurredWithinDates(fromDate, toDate) ||
111 isReceivedWithinDates(fromDate, toDate)
114 def isOutOfSyncForBillingMonth(yearOfBillingMonth: Int, billingMonth: Int) = {
115 val billingStartDateCalc = new MutableDateCalc(yearOfBillingMonth, billingMonth)
116 val billingStartMillis = billingStartDateCalc.toMillis
117 // NOTE: no need to `copy` the mutable `billingStartDateCalc` here because we use it once
118 val billingStopMillis = billingStartDateCalc.goEndOfThisMonth.toMillis
120 isOutOfSyncForBillingPeriod(billingStartMillis, billingStopMillis)
123 def isOutOfSyncForBillingPeriod(billingStartMillis: Long, billingStopMillis: Long): Boolean = {
124 isReceivedWithinMillis(billingStartMillis, billingStopMillis) &&
125 (occurredMillis < billingStartMillis || occurredMillis > billingStopMillis)
128 def toDebugString(resourcesMap: DSLResourcesMap, useOnlyInstanceId: Boolean = false): String = {
129 val instanceInfo = if(useOnlyInstanceId) instanceId else "%s::%s".format(resource, instanceId)
130 val bvalue = beautifyValue(resourcesMap)
131 val occurredFormatted = new MutableDateCalc(occurredMillis).toYYYYMMDDHHMMSS
132 if(occurredMillis == receivedMillis) {
133 "EVENT(%s, [%s], %s, %s, %s, %s, %s)".format(
143 "EVENT(%s, [%s], [%s], %s, %s, %s, %s, %s)".format(
146 new MutableDateCalc(receivedMillis),
157 def beatifyValue(resourceProvider: (String) ⇒ Option[DSLResource]): String = {
158 resourceProvider(this.resource) match {
159 case Some(DSLComplexResource(_, _, OnOffCostPolicy, _)) ⇒
160 OnOffPolicyResourceState(this.value).state.toUpperCase
161 case Some(rc @ DSLComplexResource(_, _, _, _)) ⇒
162 "%s [%s]".format(value, rc.unit)
163 case Some(DSLSimpleResource(_, _, OnOffCostPolicy)) ⇒
164 OnOffPolicyResourceState(this.value).state.toUpperCase
165 case Some(rc @ DSLSimpleResource(_, _, _)) ⇒
166 "%s [%s]".format(value, rc.unit)
173 * Returns a beautiful string representation of the value.
175 * @param policy The policy to be asked for resources.
176 * @return A beautiful string representation of the value.
178 def beautifyValue(policy: DSLPolicy): String = {
179 beatifyValue(policy.findResource)
183 * Returns a beautiful string representation of the value.
185 * @param resourcesMap The resources map to be asked for resources.
186 * @return A beautiful string representation of the value.
188 def beautifyValue(resourcesMap: DSLResourcesMap): String = {
189 beatifyValue(resourcesMap.findResourceOoooooooooooold)
193 * Return `true` iff this is an event regarding a resource with an
194 * [[gr.grnet.aquarium.logic.accounting.dsl.OnOffCostPolicy]].
196 def isOnOffEvent(policy: DSLPolicy): Boolean = {
197 policy.findResource(this.resource).map(_.costPolicy) match {
198 case Some(OnOffCostPolicy) ⇒ true
204 * Return `true` iff this is an event regarding a resource with an
205 * [[gr.grnet.aquarium.logic.accounting.dsl.OnOffCostPolicy]] and a
208 def isOnEvent(policy: DSLPolicy): Boolean = {
209 policy.findResource(this.resource) match {
210 case Some(DSLComplexResource(_, _, OnOffCostPolicy, _)) ⇒
211 OnOffPolicyResourceState(this.value).isOn
212 case Some(DSLSimpleResource(_, _, OnOffCostPolicy)) ⇒
213 OnOffPolicyResourceState(this.value).isOn
220 * Return `true` iff this is an event regarding a resource with an
221 * [[gr.grnet.aquarium.logic.accounting.dsl.OnOffCostPolicy]] and a
222 * `value` of `"off"`.
224 def isOffEvent(policy: DSLPolicy): Boolean = {
225 policy.findResource(this.resource) match {
226 case Some(DSLComplexResource(_, _, OnOffCostPolicy, _)) ⇒
227 OnOffPolicyResourceState(this.value).isOff
228 case Some(DSLSimpleResource(_, _, OnOffCostPolicy)) ⇒
229 OnOffPolicyResourceState(this.value).isOff
235 def copyWithReceivedMillis(millis: Long) = copy(receivedMillis = millis)
238 * Find the cost policy of the resource named in this resource event.
240 * We do not expect cost policies for resources to change, because they are supposed
241 * to be one of their constant characteristics. That is why do not issue a time-dependent
242 * query here for the event's current policy.
244 * Should the need arises to change the cost policy for a resource, this is a good enough
245 * reason to consider creating another type of resource.
247 def findCostPolicyM(defaultPolicy: DSLPolicy): Maybe[DSLCostPolicy] = {
248 defaultPolicy.findResource(this.safeResource).map(_.costPolicy): Maybe[DSLCostPolicy]
252 * Find the cost policy of the resource named in this resource event.
254 * We do not expect cost policies for resources to change, because they are supposed
255 * to be one of their constant characteristics. That is why do not issue a time-dependent
256 * query here for the event's current policy.
258 * Should the need arises to change the cost policy for a resource, this is a good enough
259 * reason to consider creating another type of resource.
261 def findCostPolicyM(resourcesMap: DSLResourcesMap): Maybe[DSLCostPolicy] = {
263 rc <- resourcesMap.findResourceM(this.safeResource)
270 object ResourceEvent {
271 type Details = Map[String, String]
273 type ResourceType = String
274 type ResourceIdType = String
275 type FullResourceType = (ResourceType, ResourceIdType)
276 type FullResourceTypeMap = Map[FullResourceType, ResourceEvent]
277 type FullMutableResourceTypeMap = scala.collection.mutable.Map[FullResourceType, ResourceEvent]
279 def fromJson(json: String): ResourceEvent = {
280 JsonHelpers.jsonToObject[ResourceEvent](json)
283 def fromJValue(jsonAST: JsonAST.JValue): ResourceEvent = {
284 JsonHelpers.jValueToObject[ResourceEvent](jsonAST)
287 def fromBytes(bytes: Array[Byte]): ResourceEvent = {
288 JsonHelpers.jsonBytesToObject[ResourceEvent](bytes)
291 def fromXml(xml: String): ResourceEvent = {
292 fromJValue(Xml.toJson(scala.xml.XML.loadString(xml)))
296 final val _id = "_id"
298 final val userId = "userId"
299 final val occurredMillis = "occurredMillis"
300 final val receivedMillis = "receivedMillis"
301 final val clientId = "clientId"
302 final val resource = "resource"
303 final val resourceId = "resourceId"
304 final val eventVersion = "eventVersion"
305 final val value = "value"
306 final val details = "details"