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
185
186
187
188
189
190
|
#set( $symbol_pound = '#' )
#set( $symbol_dollar = '$' )
#set( $symbol_escape = '\' )
/*
* Copyright 2014,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 ${package};
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.collect.ImmutableSet;
import org.onosproject.ui.RequestHandler;
import org.onosproject.ui.UiMessageHandler;
import org.onosproject.ui.table.TableModel;
import org.onosproject.ui.table.TableRequestHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.Override;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
* Skeletal ONOS UI Table-View message handler.
*/
public class AppUiTableMessageHandler extends UiMessageHandler {
private static final String SAMPLE_TABLE_DATA_REQ = "sampleTableDataRequest";
private static final String SAMPLE_TABLE_DATA_RESP = "sampleTableDataResponse";
private static final String SAMPLE_TABLES = "sampleTables";
private static final String SAMPLE_TABLE_DETAIL_REQ = "sampleTableDetailsRequest";
private static final String SAMPLE_TABLE_DETAIL_RESP = "sampleTableDetailsResponse";
private static final String DETAILS = "details";
private static final String ID = "id";
private static final String LABEL = "label";
private static final String CODE = "code";
private static final String COMMENT = "comment";
private static final String RESULT = "result";
private static final String[] COLUMN_IDS = { ID, LABEL, CODE };
private final Logger log = LoggerFactory.getLogger(getClass());
@Override
protected Collection<RequestHandler> createRequestHandlers() {
return ImmutableSet.of(
new SampleTableDataRequestHandler(),
new SampleTableDetailRequestHandler()
);
}
// handler for sample table requests
private final class SampleTableDataRequestHandler extends TableRequestHandler {
private SampleTableDataRequestHandler() {
super(SAMPLE_TABLE_DATA_REQ, SAMPLE_TABLE_DATA_RESP, SAMPLE_TABLES);
}
// if necessary, override defaultColumnId() -- if it isn't "id"
@Override
protected String[] getColumnIds() {
return COLUMN_IDS;
}
// if required, override createTableModel() to set column formatters / comparators
@Override
protected void populateTable(TableModel tm, ObjectNode payload) {
// === NOTE: the table model supplied here will have been created
// via a call to createTableModel(). To assign non-default
// cell formatters or comparators to the table model, override
// createTableModel() and set them there.
// === retrieve table row items from some service...
// SomeService ss = get(SomeService.class);
// List<Item> items = ss.getItems()
// fake data for demonstration purposes...
List<Item> items = getItems();
for (Item item: items) {
populateRow(tm.addRow(), item);
}
}
private void populateRow(TableModel.Row row, Item item) {
row.cell(ID, item.id())
.cell(LABEL, item.label())
.cell(CODE, item.code());
}
}
// handler for sample item details requests
private final class SampleTableDetailRequestHandler extends RequestHandler {
private SampleTableDetailRequestHandler() {
super(SAMPLE_TABLE_DETAIL_REQ);
}
@Override
public void process(long sid, ObjectNode payload) {
String id = string(payload, ID, "(none)");
// SomeService ss = get(SomeService.class);
// Item item = ss.getItemDetails(id)
// fake data for demonstration purposes...
Item item = getItem(id);
ObjectNode rootNode = objectNode();
ObjectNode data = objectNode();
rootNode.set(DETAILS, data);
if (item == null) {
rootNode.put(RESULT, "Item with id '" + id + "' not found");
log.warn("attempted to get item detail for id '{}'", id);
} else {
rootNode.put(RESULT, "Found item with id '" + id + "'");
data.put(ID, item.id());
data.put(LABEL, item.label());
data.put(CODE, item.code());
data.put(COMMENT, "Some arbitrary comment");
}
sendMessage(SAMPLE_TABLE_DETAIL_RESP, 0, rootNode);
}
}
// ===================================================================
// NOTE: The code below this line is to create fake data for this
// sample code. Normally you would use existing services to
// provide real data.
// Lookup a single item.
private static Item getItem(String id) {
// We realize this code is really inefficient, but
// it suffices for our purposes of demonstration...
for (Item item : getItems()) {
if (item.id().equals(id)) {
return item;
}
}
return null;
}
// Produce a list of items.
private static List<Item> getItems() {
List<Item> items = new ArrayList<>();
items.add(new Item("item-1", "foo", 42));
items.add(new Item("item-2", "bar", 99));
items.add(new Item("item-3", "baz", 65));
return items;
}
// Simple model class to provide sample data
private static class Item {
private final String id;
private final String label;
private final int code;
Item(String id, String label, int code) {
this.id = id;
this.label = label;
this.code = code;
}
String id() { return id; }
String label() { return label; }
int code() { return code; }
}
}
|
