Tweeking configuration
[aquarium] / src / main / scala / gr / grnet / aquarium / event / PolicyEntry.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
37 package event
38
39 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
40 import java.util.Date
41 import converter.{JsonTextFormat, StdConverters}
42
43 /**
44  * Store entry for serialized policy data.
45  *
46  * @author Georgios Gousios <gousiosg@gmail.com>
47  */
48 case class PolicyEntry(
49     id: String,           //SHA-1 of the provided policyYaml string
50     occurredMillis: Long, //Time this event was stored
51     receivedMillis: Long, //Does not make sense for local events -> not used
52     policyYAML: String,                //The serialized policy
53     validFrom: Long,                   //The timestamp since when the policy is valid
54     validTo: Long,                      //The timestamp until when the policy is valid
55     eventVersion: String = "1.0",
56     userID: String = "",
57     details: Map[String, String] = Map()
58  ) extends ExternalEventModel {
59
60   assert(if(validTo != -1) validTo > validFrom else validFrom > 0)
61
62   def validate = true
63
64   def withReceivedMillis(millis: Long) = copy(receivedMillis = millis)
65
66   def withDetails(newDetails: Map[String, String], newOccurredMillis: Long) =
67     this.copy(details = newDetails, occurredMillis = newOccurredMillis)
68
69   def fromToTimeslot = Timeslot(new Date(validFrom), new Date(validTo))
70 }
71
72 object PolicyEntry {
73
74   def fromJson(json: String): PolicyEntry = {
75     StdConverters.AllConverters.convertEx[PolicyEntry](JsonTextFormat(json))
76   }
77
78   object JsonNames {
79     final val _id = "_id"
80     final val id = "id"
81     final val occurredMillis = "occurredMillis"
82     final val receivedMillis = "receivedMillis"
83     final val policyYAML = "policyYAML"
84     final val validFrom = "validFrom"
85     final val validTo = "validTo"
86   }
87 }