e650aff0d719ed5159516ddc4fa2706d330cfb33
[aquarium] / src / main / scala / gr / grnet / aquarium / user / UserState.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.user
37
38 import gr.grnet.aquarium.util.json.{JsonHelpers, JsonSupport}
39 import net.liftweb.json.{Extraction, parse => parseJson, JsonAST, Xml}
40 import gr.grnet.aquarium.logic.accounting.dsl.DSLResource
41
42
43 /**
44  * A comprehensive representation of the User's state.
45  *
46  * Note that it is made of autonomous parts that are actually data snapshots.
47  *
48  * The different snapshots need not agree on the snapshot time, ie. some state
49  * part may be stale, while other may be fresh.
50  *
51  * @author Christos KK Loverdos <loverdos@gmail.com>
52  */
53
54 case class UserState(
55     userId: String,
56     active: Boolean,
57     credits: CreditSnapshot,
58     agreement: AgreementSnapshot,
59     roles: RolesSnapshot,
60     paymentOrders: PaymentOrdersSnapshot,
61     ownedGroups: OwnedGroupsSnapshot,
62     groupMemberships: GroupMembershipsSnapshot,
63     ownedResources: OwnedResourcesSnapshot)
64   extends JsonSupport {
65
66   private[this] def _allSnapshots: List[Long] = {
67     List(
68       credits.snapshotTime, agreement.snapshotTime, roles.snapshotTime,
69       paymentOrders.snapshotTime, ownedGroups.snapshotTime, groupMemberships.snapshotTime,
70       ownedResources.snapshotTime)
71   }
72
73   def earlierSnapshotTime: Long = _allSnapshots min
74
75   def latestSnapshotTime: Long  = _allSnapshots max
76 }
77
78
79 object UserState {
80   def fromJson(json: String): UserState = {
81     JsonHelpers.jsonToObject[UserState](json)
82   }
83
84   def fromJValue(jsonAST: JsonAST.JValue): UserState = {
85     JsonHelpers.jValueToObject[UserState](jsonAST)
86   }
87
88   def fromBytes(bytes: Array[Byte]): UserState = {
89     JsonHelpers.jsonBytesToObject[UserState](bytes)
90   }
91
92   def fromXml(xml: String): UserState = {
93     fromJValue(Xml.toJson(scala.xml.XML.loadString(xml)))
94   }
95 }