This repository was archived by the owner on Jul 20, 2024. It is now read-only.
forked from splunk/splunk-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEntityMetadata.java
More file actions
142 lines (128 loc) · 3.85 KB
/
EntityMetadata.java
File metadata and controls
142 lines (128 loc) · 3.85 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
/*
* 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;
/**
* The {@code EntityMetadata} class provides access to the metadata properties
* of a corresponding entity. Use {@code Entity.getMetadata} to obtain an
* instance of this class.
*/
public class EntityMetadata {
private Entity entity;
/**
* Class constructor.
*
* @param entity This entity.
*/
EntityMetadata(Entity entity) {
this.entity = entity;
}
/**
* Indicates whether this entity's permission can be changed.
*
* @return {@code true} if this entity's permission can be changed,
* {@code false} if not.
*/
public boolean canChangePermissions() {
return getEaiAcl().getBoolean("can_change_perms", false);
}
/**
* Indicates whether this entity can be shared via an app.
*
* @return {@code true} if this entity can be shared via an app,
* {@code false} if not.
*/
public boolean canShareApp() {
return getEaiAcl().getBoolean("can_share_app", false);
}
/**
* Indicates whether the entity can be shared globally.
*
* @return {@code true} if this entity can be shared globally,
* {@code false} if not.
*/
public boolean canShareGlobal() {
return getEaiAcl().getBoolean("can_share_global", false);
}
/**
* Indicates whether the entity can be shared to a specific user.
*
* @return {@code true} if this entity can be shared to a specific user,
* {@code false} if not.
*/
public boolean canShareUser() {
return getEaiAcl().getBoolean("can_share_user", false);
}
/**
* Indicates whether this entity can be modified.
*
* @return {@code true} if this entity can be modified,
* {@code false} if not.
*/
public boolean canWrite() {
return getEaiAcl().getBoolean("can_write", false);
}
/**
* Returns the app context of this entity.
*
* @return The app context of this entity.
*/
public String getApp() {
return getEaiAcl().getString("app", "system");
}
/**
* Returns a record containing all of the metadata information
* for this entity.
*
* @return The record containing the metadata information.
*/
Record getEaiAcl() {
return (Record)entity.validate().get("eai:acl");
}
/**
* Returns the username of the entity owner.
*
* @return The entity owner's username.
*/
public String getOwner() {
return getEaiAcl().getString("owner");
}
/**
* Returns this entity's permissions, which represent an
* allowable inclusive action:list-of-roles map.
*
* @return This entity's permissions map.
*/
public Record getPermissions() {
return getEaiAcl().getValue("perms", null);
}
/**
* Returns how this entity is shared (app, global, and/or user).
*
* @return Values that indicate how this entity is shared.
*/
public String getSharing() {
return getEaiAcl().getString("sharing");
}
/**
* Indicates whether this entity can be modified.
*
* @return {@code true} if this entity can be modified,
* {@code false} if not.
*/
public boolean isModifiable() {
return getEaiAcl().getBoolean("modifiable", false);
}
}