a0e329d3e29a90bb57c7455a50d8cae609f518ab
[aquarium] / src / main / scala / gr / grnet / aquarium / actor / message / service / dispatcher / DispatcherMessage.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.actor.message
37 package service
38 package dispatcher
39
40 import gr.grnet.aquarium.logic.events.{ResourceEvent, UserEvent}
41 import gr.grnet.aquarium.user.UserState
42 import gr.grnet.aquarium.util.json.{JsonHelpers, JsonSupport}
43
44
45 /**
46  * This is the base class of the messages the dispatcher understands.
47  *
48  * @author Christos KK Loverdos <loverdos@gmail.com>.
49  */
50 sealed trait DispatcherMessage extends ActorMessage {
51   def isError: Boolean = false
52 }
53
54 sealed trait DispatcherResponseMessage extends DispatcherMessage {
55   def error: Option[String]
56
57   override def isError = error.isDefined
58
59   def responseBody: Any
60   def responseBodyToJson: String = {
61     responseBody match {
62       case null ⇒
63         throw new NullPointerException("Unexpected null response body in %s".format(this))
64       case other ⇒
65         JsonHelpers.anyToJson(other)
66     }
67   }
68 }
69
70 case class RequestUserBalance(userId: String, timestamp: Long) extends DispatcherMessage
71 case class BalanceValue(balance: Double) extends JsonSupport
72 case class ResponseUserBalance(userId: String, balance: Double, error: Option[String]) extends DispatcherResponseMessage {
73   def responseBody = BalanceValue(balance)
74 }
75
76 case class UserResponseGetBalance(userId: String, balance: Double) extends DispatcherResponseMessage {
77   def responseBody = BalanceValue(balance)
78   def error = None
79 }
80
81 case class UserRequestGetState(userId: String, timestamp: Long) extends DispatcherMessage
82 case class UserResponseGetState(userId: String, state: UserState) extends DispatcherResponseMessage {
83   def responseBody = state
84   val error = None
85 }
86
87 /**
88  * Dispatcher message that triggers the resource event processing pipeline.
89  *
90  * Note that the prefix `Process` means that no reply is created or needed.
91  */
92 case class ProcessResourceEvent(rce: ResourceEvent) extends DispatcherMessage
93
94 /**
95  * Dispatcher message that triggers the user event processing pipeline.
96  *
97  * Note that the prefix `Process` means that no reply is created or needed.
98  */
99 case class ProcessUserEvent(ue: UserEvent) extends DispatcherMessage
100
101
102 case class AdminRequestPingAll() extends DispatcherMessage