This repository was archived by the owner on Sep 14, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathEntityMetadata.cs
165 lines (152 loc) · 4.61 KB
/
EntityMetadata.cs
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
/*
* 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.
*/
namespace Splunk
{
/// <summary>
/// The EntityMetadata class provides access to the metadata properties
/// of a corresponding entity. Use Entity.getMetadata to obtain an
/// instance of this class.
/// </summary>
public class EntityMetadata
{
/// <summary>
/// The entity
/// </summary>
private Entity entity;
/// <summary>
/// Initializes a new instance of the <see cref="EntityMetadata"/>
/// class.
/// </summary>
/// <param name="entity">The entity</param>
public EntityMetadata(Entity entity)
{
this.entity = entity;
}
/// <summary>
/// Gets a value indicating whether this entity's permission can be
/// changed.
/// </summary>
public bool CanChangePermissions
{
get
{
return this.GetEaiAcl().GetBoolean("can_change_perms", false);
}
}
/// <summary>
/// Gets a value indicating whether this resource can be shared via an
/// app.
/// </summary>
public bool CanShareApp
{
get
{
return this.GetEaiAcl().GetBoolean("can_share_app", false);
}
}
/// <summary>
/// Gets a value indicating whether the resource can be shared globally.
/// </summary>
public bool CanShareGlobal
{
get
{
return this.GetEaiAcl().GetBoolean("can_share_global", false);
}
}
/// <summary>
/// Gets a value indicating whether the resource can be shared to a
/// specific user.
/// </summary>
public bool CanShareUser
{
get
{
return this.GetEaiAcl().GetBoolean("can_share_user", false);
}
}
/// <summary>
/// Gets a value indicating whether his entity can be modified.
/// </summary>
public bool CanWrite
{
get
{
return this.GetEaiAcl().GetBoolean("can_write", false);
}
}
/// <summary>
/// Gets the app context of this resource.
/// </summary>
public string App
{
get
{
return this.GetEaiAcl().GetString("app", "system");
}
}
/// <summary>
/// Gets the username of the resource owner.
/// </summary>
public string Owner
{
get
{
return this.GetEaiAcl().GetString("owner");
}
}
/// <summary>
/// Gets this entity's permissions, which represent an
/// allowable inclusive action:list-of-roles map.
/// </summary>
public Record Permissions
{
get
{
return (Record)this.GetEaiAcl().GetValue("perms", null);
}
}
/// <summary>
/// Gets how this resource is shared (app, global, and/or user).
/// </summary>
public string Sharing
{
get
{
return this.GetEaiAcl().GetString("sharing");
}
}
/// <summary>
/// Gets a value indicating whether this entity can be modified.
/// </summary>
public bool IsModifiable
{
get
{
return this.GetEaiAcl().GetBoolean("modifiable", false);
}
}
/// <summary>
/// Returns a record containing all of the metadata information
/// for this resource.
/// </summary>
/// <returns>The metadata record</returns>
public Record GetEaiAcl()
{
return (Record)this.entity.Validate().Get("eai:acl");
}
}
}