code.grnet.gr Git - aquarium/blob - 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 import gr.grnet.aquarium.util._
  40
  41 /**
  42  * The model of any event sent from the `Identity Management` (IM) external system.
  43  *
  44  * By definition, this is the model agreed upon between Aquarium and IM.
  45  *
  46  * @author Christos KK Loverdos <loverdos@gmail.com>
  47  */
  48
  49 trait IMEventModel extends ExternalEventModel {
  50   def clientID: String
  51
  52   def isActive: Boolean
  53
  54   def role: String
  55
  56   def eventType: String
  57
  58   def isStateActive = isActive
  59
  60   def isStateSuspended = !isActive
  61
  62   def isCreateUser = eventType.equalsIgnoreCase(IMEventModel.EventTypeNames.create)
  63
  64   def isModifyUser = eventType.equalsIgnoreCase(IMEventModel.EventTypeNames.modify)
  65
  66   override def toDebugString = {
  67     "%s(userID=%s, id=%s, isActive=%s, role='%s')".format(shortClassNameOf(this), userID, id, isActive, role)
  68   }
  69 }
  70
  71 object IMEventModel {
  72   trait NamesT extends ExternalEventModel.NamesT {
  73     final val clientID = "clientID"
  74     final val isActive = "isActive"
  75     final val role = "role"
  76     final val eventType = "eventType"
  77   }
  78
  79   object Names extends NamesT
  80
  81   trait EventTypeNamesT {
  82     final val create = "create"
  83     final val modify = "modify"
  84   }
  85
  86   object EventTypeNames extends EventTypeNamesT
  87 }