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