Now using schema-based messages
[aquarium] / src / main / scala / gr / grnet / aquarium / message / MessageConstants.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.message
37
38 /**
39  * Provides constants for known values expected in message objects.
40  *
41  * @author Christos KK Loverdos <loverdos@gmail.com>
42  */
43 object MessageConstants {
44   final val EventVersion_1_0 = "1.0"
45   final val DefaultSelectorKey = "default"
46
47   final object DetailsKeys {
48     // This is set in the details map to indicate a synthetic resource event (ie not a real one).
49     // Examples of synthetic resource events are those that are implicitly generated at the
50     // end of the billing period (e.g. `OFF`s).
51     final val aquarium_is_synthetic    = "__aquarium_is_synthetic__"
52
53     final val aquarium_is_implicit_end = "__aquarium_is_implicit_end__"
54
55     final val aquarium_is_dummy_first = "__aquarium_is_dummy_first__"
56
57     final val aquarium_is_realtime_virtual = "__aquarium_is_realtime_virtual__"
58
59     final val aquarium_reference_event_id = "__aquarium_reference_event_id__"
60
61     final val aquarium_reference_event_id_in_store = "__aquarium_reference_event_id_in_store__"
62   }
63
64   final object IMEventMsg {
65     final object EventTypes {
66       final val create = "create"
67       final val modify = "modify"
68     }
69   }
70 }