32af9113396f4f7ec89e854dfac8c235b62ccada
[aquarium] / src / main / scala / gr / grnet / aquarium / event / model / im / IMEventModel.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.event.model
37 package im
38
39 /**
40  * The model of any event sent from the `Identity Management` (IM) external system.
41  *
42  * By definition, this is the model agreed upon between Aquarium and IM.
43  *
44  * @author Christos KK Loverdos <loverdos@gmail.com>
45  */
46
47 trait IMEventModel extends ExternalEventModel {
48   def clientID: String
49
50   def isActive: Boolean
51
52   def role: String
53
54   def eventType: String
55
56   def isStateActive = isActive
57
58   def isStateSuspended = !isActive
59
60   def isCreateUser = eventType.equalsIgnoreCase(IMEventModel.EventTypeNames.create)
61
62   def isModifyUser = eventType.equalsIgnoreCase(IMEventModel.EventTypeNames.modify)
63 }
64
65 object IMEventModel {
66   trait NamesT extends ExternalEventModel.NamesT {
67     final val clientID = "clientID"
68     final val isActive = "isActive"
69     final val role = "role"
70     final val eventType = "eventType"
71   }
72
73   object Names extends NamesT
74
75   trait EventTypeNamesT {
76     final val create = "create"
77     final val modify = "modify"
78   }
79
80   object EventTypeNames extends EventTypeNamesT
81 }