1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.store.group.impl;
import org.onosproject.net.DeviceId;
import org.onosproject.net.group.GroupBuckets;
import org.onosproject.net.group.GroupDescription;
import org.onosproject.net.group.GroupKey;
import org.onosproject.net.group.GroupStore.UpdateType;
/**
* Format of the Group store message that is used to
* communicate with the peer nodes in the cluster.
*/
public final class GroupStoreMessage {
private final DeviceId deviceId;
private final GroupKey appCookie;
private final GroupDescription groupDesc;
private final UpdateType updateType;
private final GroupBuckets updateBuckets;
private final GroupKey newAppCookie;
private final Type type;
/**
* Type of group store request.
*/
public enum Type {
ADD,
UPDATE,
DELETE
}
private GroupStoreMessage(Type type,
DeviceId deviceId,
GroupKey appCookie,
GroupDescription groupDesc,
UpdateType updateType,
GroupBuckets updateBuckets,
GroupKey newAppCookie) {
this.type = type;
this.deviceId = deviceId;
this.appCookie = appCookie;
this.groupDesc = groupDesc;
this.updateType = updateType;
this.updateBuckets = updateBuckets;
this.newAppCookie = newAppCookie;
}
/**
* Creates a group store message for group ADD request.
*
* @param deviceId device identifier in which group to be added
* @param desc group creation parameters
* @return constructed group store message
*/
public static GroupStoreMessage createGroupAddRequestMsg(DeviceId deviceId,
GroupDescription desc) {
return new GroupStoreMessage(Type.ADD,
deviceId,
null,
desc,
null,
null,
null);
}
/**
* Creates a group store message for group UPDATE request.
*
* @param deviceId the device ID
* @param appCookie the current group key
* @param updateType update (add or delete) type
* @param updateBuckets group buckets for updates
* @param newAppCookie optional new group key
* @return constructed group store message
*/
public static GroupStoreMessage createGroupUpdateRequestMsg(DeviceId deviceId,
GroupKey appCookie,
UpdateType updateType,
GroupBuckets updateBuckets,
GroupKey newAppCookie) {
return new GroupStoreMessage(Type.UPDATE,
deviceId,
appCookie,
null,
updateType,
updateBuckets,
newAppCookie);
}
/**
* Creates a group store message for group DELETE request.
*
* @param deviceId the device ID
* @param appCookie the group key
* @return constructed group store message
*/
public static GroupStoreMessage createGroupDeleteRequestMsg(DeviceId deviceId,
GroupKey appCookie) {
return new GroupStoreMessage(Type.DELETE,
deviceId,
appCookie,
null,
null,
null,
null);
}
/**
* Returns the device identifier of this group request.
*
* @return device identifier
*/
public DeviceId deviceId() {
return deviceId;
}
/**
* Returns the application cookie associated with this group request.
*
* @return application cookie
*/
public GroupKey appCookie() {
return appCookie;
}
/**
* Returns the group create parameters associated with this group request.
*
* @return group create parameters
*/
public GroupDescription groupDesc() {
return groupDesc;
}
/**
* Returns the group buckets to be updated as part of this group request.
*
* @return group buckets to be updated
*/
public GroupBuckets updateBuckets() {
return updateBuckets;
}
/**
* Returns the update group operation type.
*
* @return update operation type
*/
public UpdateType updateType() {
return updateType;
}
/**
* Returns the new application cookie associated with this group operation.
*
* @return new application cookie
*/
public GroupKey newAppCookie() {
return newAppCookie;
}
/**
* Returns the type of this group operation.
*
* @return group message type
*/
public Type type() {
return type;
}
}
|
