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