-
Notifications
You must be signed in to change notification settings - Fork 121
Expand file tree
/
Copy pathEntity.java
More file actions
493 lines (443 loc) · 15.6 KB
/
Entity.java
File metadata and controls
493 lines (443 loc) · 15.6 KB
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/*
* Copyright 2012 Splunk, Inc.
*
* 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 com.splunk;
import java.util.*;
/**
* The {@code Entity} class represents a Splunk entity.
*/
public class Entity extends Resource implements Map<String, Object> {
protected Record content;
protected HashMap<String, Object> toUpdate = new LinkedHashMap<String, Object>();
/**
* Class constructor.
*
* @param service The connected {@code Service} instance.
* @param path The entity's endpoint.
*/
public Entity(Service service, String path) {
super(service, path);
}
/**
* Returns the path that corresponds to the requested action.
*
* @param action The requested action.
* @return The return path.
*/
protected String actionPath(String action) {
if (action.equals("disable"))
return path + "/disable";
if (action.equals("edit"))
return path;
if (action.equals("enable"))
return path + "/enable";
if (action.equals("remove"))
return path;
if (action.equals("acl"))
return path + "/acl";
throw new IllegalArgumentException("Invalid action: " + action);
}
/** {@inheritDoc} */
public void clear() {
throw new UnsupportedOperationException();
}
/** {@inheritDoc} */
public boolean containsKey(Object key) {
return getContent().containsKey(key);
}
/** {@inheritDoc} */
public boolean containsValue(Object value) {
return getContent().containsValue(value);
}
/**
* Disables the entity that is named by this endpoint. This method is
* available on almost every endpoint.
*/
public void disable() {
service.post(actionPath("disable"));
invalidate();
}
/**
* Enables the entity that is named by this endpoint. This method is
* available on almost every endpoint.
*/
public void enable() {
service.post(actionPath("enable"));
invalidate();
}
/** {@inheritDoc} */
public Set<Map.Entry<String, Object>> entrySet() {
return getContent().entrySet();
}
/** {@inheritDoc} */
public Object get(Object key) {
if (toUpdate.containsKey(key)) return toUpdate.get(key);
return getContent().get(key);
}
/**
* Returns the Boolean value associated with the specified key. Values
* can be converted from: 0, 1, true, false.
*
* @param key The key to look up.
* @return The Boolean value associated with the specified key.
*/
boolean getBoolean(String key) {
if (toUpdate.containsKey(key))
return Value.toBoolean(toUpdate.get(key).toString());
return getContent().getBoolean(key);
}
/**
* Returns the Boolean value associated with the specified key, or the
* default value if the key does not exist. Boolean values can be converted
* from: 0, 1, true, false.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The Boolean value associated with the specified key.
*/
boolean getBoolean(String key, boolean defaultValue) {
if (toUpdate.containsKey(key))
return Value.toBoolean(toUpdate.get(key).toString());
return getContent().getBoolean(key, defaultValue);
}
/**
* Returns the long value associated with the specified key. Long values
* can be converted from: number, numberMB, numberGB.
*
* @param key The key to look up.
* @return The long value associated with the specified key.
*/
long getByteCount(String key) {
if (toUpdate.containsKey(key))
return Value.toByteCount(toUpdate.get(key).toString());
return getContent().getByteCount(key);
}
/**
* Returns the long value associated with the specified key, or the default
* value if the key does not exist. Long values can be converted from:
* number, numberMB, numberGB.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The long value associated with the specified key.
*/
long getByteCount(String key, long defaultValue) {
if (toUpdate.containsKey(key))
return Value.toByteCount(toUpdate.get(key).toString());
return getContent().getByteCount(key, defaultValue);
}
protected Record getContent() {
return validate().content;
}
/**
* Returns a date value associated with the specified key. Date values can
* be converted from standard UTC time formats.
*
* @param key The key to look up.
* @return The date value associated with the specified key.
*/
Date getDate(String key) {
if (toUpdate.containsKey(key))
return Value.toDate(toUpdate.get(key).toString());
if (getContent().containsKey(key)) {
return getContent().getDate(key);
} else {
return null;
}
}
/**
* Returns a date value associated with the specified key, or the default
* value if the key does not exist. Date values can be converted from
* standard UTC time formats.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The date value associated with the specified key.
*/
Date getDate(String key, Date defaultValue) {
if (toUpdate.containsKey(key))
return Value.toDate(toUpdate.get(key).toString());
return getContent().getDate(key, defaultValue);
}
/**
* Returns the floating point value associated with the specified key.
*
* @param key The key to look up.
* @return The floating point value associated with the specified key.
*/
float getFloat(String key) {
if (toUpdate.containsKey(key))
return Value.toFloat(toUpdate.get(key).toString());
return getContent().getFloat(key);
}
/**
* Returns the integer point value associated with the specified key.
*
* @param key The key to look up.
* @return The integer point value associated with the specified key.
*/
int getInteger(String key) {
if (toUpdate.containsKey(key))
return Value.toInteger(toUpdate.get(key).toString());
return getContent().getInteger(key);
}
/**
* Returns the integer value associated with the specified key.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The integer value associated with the specified key.
*/
int getInteger(String key, int defaultValue) {
if (toUpdate.containsKey(key))
return Value.toInteger(toUpdate.get(key).toString());
return getContent().getInteger(key, defaultValue);
}
/**
* Returns the long value associated with the specified key.
*
* @param key The key to look up.
* @return The long value associated with the specified key.
*/
long getLong(String key) {
if (toUpdate.containsKey(key))
return Value.toLong(toUpdate.get(key).toString());
return getContent().getLong(key);
}
/**
* Returns the long value associated with the specified key.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The long value associated with the specified key.
*/
long getLong(String key, int defaultValue) {
if (toUpdate.containsKey(key))
return Value.toLong(toUpdate.get(key).toString());
return getContent().getLong(key, defaultValue);
}
/**
* Returns the metadata (eai:acl) of this entity. This data includes
* permissions for accessing the resource, and values that indicate
* which resource fields are wildcards, required, and optional.
*
* @return The metadata of this entity, or {@code null} if none exist.
*/
public EntityMetadata getMetadata() {
// CONSIDER: For entities that don't have an eai:acl field, which is
// uncommon but does happen at least in the case of a DeploymentClient
// that is not enabled, we return null. A slightly friendlier option
// would be to return a metadata instance that defaults all values?
if (!containsKey("eai:acl")) return null;
return new EntityMetadata(this);
}
/**
* Returns the string value associated with the specified key.
*
* @param key The key to look up.
* @return The string value associated with the specified key.
*/
String getString(String key) {
if (toUpdate.containsKey(key))
return toUpdate.get(key).toString();
return getContent().getString(key);
}
/**
* Returns the string value associated with the specified key, or the
* default value if the key does not exist.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The string value associated with the specified key.
*/
String getString(String key, String defaultValue) {
if (toUpdate.containsKey(key))
return toUpdate.get(key).toString();
return getContent().getString(key, defaultValue);
}
/**
* Returns the string array value associated with the specified key.
*
* @param key The key to look up.
* @return The string array value associated with the specified key.
*/
String[] getStringArray(String key) {
if (toUpdate.containsKey(key)) {
return ((String)toUpdate.get(key)).split("\\|");
}
return getContent().getStringArray(key);
}
/**
* Returns the string array value associated with the specified key, or the
* default value if the key does not exist.
*
* @param key The key to look up.
* @param defaultValue The default value.
* @return The string array value associated with the specified key.
*/
String[] getStringArray(String key, String[] defaultValue) {
if (toUpdate.containsKey(key))
return getStringArray(key);
return getContent().getStringArray(key, defaultValue);
}
/** {@inheritDoc} */
public boolean isEmpty() {
return getContent().isEmpty();
}
/**
* Indicates whether this entity is disabled. This method is
* available on almost every endpoint.
*
* @return {@code true} if this entity is disabled, {@code false} if
* enabled.
*/
public boolean isDisabled() {
return getBoolean("disabled", false);
}
/**
* Returns whether this entity's name can be changed via {@link #update}.
*
* Most entity names cannot be changed in this way.
* @return false.
*/
protected boolean isNameChangeAllowed() {
return false;
}
/** {@inheritDoc} */
public Set<String> keySet() {
return getContent().keySet();
}
@Override
Entity load(AtomObject value) {
super.load(value);
AtomEntry entry = (AtomEntry)value;
if (entry == null) {
content = new Record();
}
else {
content = entry.content;
}
return this;
}
/** {@inheritDoc} */
public Object put(String key, Object value) {
throw new UnsupportedOperationException();
}
/** {@inheritDoc} */
public void putAll(Map<? extends String, ? extends Object> map) {
throw new UnsupportedOperationException();
}
/** {@inheritDoc} */
@Override public Entity refresh() {
// Update any attribute values set by a setter method that has not
// yet been written to the object.
ResponseMessage response = service.get(path);
assert(response.getStatus() == 200);
AtomFeed feed;
try {
feed = AtomFeed.parseStream(response.getContent());
} catch (Exception e) {
throw new RuntimeException(e);
}
int count = feed.entries.size();
if (count > 1) {
throw new IllegalStateException("Expected 0 or 1 Atom entries; found " + feed.entries.size());
}
AtomEntry entry = count == 0 ? null : feed.entries.get(0);
load(entry);
return this;
}
/** {@inheritDoc} */
public Object remove(Object key) {
throw new UnsupportedOperationException();
}
/**
* Sets the local cache update value. Writing is deferred until
* {@code update} has been called.
*
* @param key The key to set.
* @param value The default value.
*/
void setCacheValue(String key, Object value) {
toUpdate.put(key, value);
}
/** {@inheritDoc} */
public int size() {
return getContent().size();
}
/**
* Updates the entity with the values you previously set using the setter
* methods, and any additional specified arguments. The specified arguments
* take precedent over the values that were set using the setter methods.
*
* @param args The arguments to update.
*/
public void update(Map<String, Object> args) {
if (!toUpdate.isEmpty() || !args.isEmpty()) {
// Merge cached setters and live args together before updating.
Map<String, Object> mergedArgs =
new LinkedHashMap<String, Object>();
mergedArgs.putAll(toUpdate);
mergedArgs.putAll(args);
if (mergedArgs.containsKey("name") && !isNameChangeAllowed()) {
throw new IllegalStateException("Cannot set 'name' on an existing entity.");
}
service.post(actionPath("edit"), mergedArgs);
toUpdate.clear();
invalidate();
}
}
/**
* Updates the entity with the accumulated arguments, established by the
* individual setter methods for each specific entity class.
*/
@SuppressWarnings("unchecked")
public void update() {
update(Collections.EMPTY_MAP);
}
/**
* Update the access control list (ACL) properties for this entity,
*
* @param args: Properties to update for this entity.
* Required Properties in 'args'
* - `owner`: The Splunk username, such as "admin". A value of "nobody" means no specific user.
* - `sharing`: A mode that indicates how the resource is shared. The sharing mode can be "user", "app", "global", or "system".
*/
public void aclUpdate(Map<String, Object> args){
if(!args.containsKey("sharing")){
throw new IllegalArgumentException("Required argument 'sharing' is missing.");
}
if(!args.containsKey("owner")){
throw new IllegalArgumentException("Required argument 'owner' is missing.");
}
service.post(actionPath("acl"), args);
invalidate();
}
/**
* Removes this entity from its corresponding collection.
*/
public void remove() {
service.delete(actionPath("remove"));
}
/** {@inheritDoc} */
@Override public Entity validate() {
super.validate();
return this;
}
/** {@inheritDoc} */
public Collection<Object> values() {
return getContent().values();
}
}