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 pathEntityCollection.cs
169 lines (160 loc) · 6.16 KB
/
EntityCollection.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
166
167
168
169
/*
* 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
{
using System;
using System.Collections.Generic;
/// <summary>
/// Represents the Entity Collection class.
/// </summary>
/// <typeparam name="T">The Generic parameter that matches The Entity class,
/// or any class derived from Entity.</typeparam>
public class EntityCollection<T> : ResourceCollection<T> where T : Entity
{
/// <summary>
/// Initializes a new instance of the <see cref="EntityCollection"/>
/// class.
/// </summary>
/// <param name="service">The service</param>
/// <param name="path">The endpoint for this collection</param>
public EntityCollection(Service service, string path)
: base(service, path, typeof(Entity))
{
}
/// <summary>
/// Initializes a new instance of the <see cref="EntityCollection"/>
/// class.
/// </summary>
/// <param name="service">The service</param>
/// <param name="path">The endpoint for this collection</param>
/// <param name="args">The variable argument list</param>
public EntityCollection(Service service, string path, Args args)
: base(service, path, args, typeof(Entity))
{
}
/// <summary>
/// Initializes a new instance of the <see cref="EntityCollection"/>
/// class.
/// </summary>
/// <param name="service">The service</param>
/// <param name="path">The endpoint for this collection</param>
/// <param name="itemClass">The type of this Entity</param>
public EntityCollection(Service service, string path, Type itemClass)
: base(service, path, itemClass)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="EntityCollection"/>
/// class.
/// </summary>
/// <param name="service">The service</param>
/// <param name="path">The endpoint for this collection</param>
/// <param name="args">The variable argument list</param>
/// <param name="itemClass">The type of this Entity</param>
public EntityCollection(
Service service, string path, Args args, Type itemClass)
: base(service, path, args, itemClass)
{
}
/// <summary>
/// Creates an Entity in this collection.
/// </summary>
/// <param name="name">The name of this Entity</param>
/// <returns>The Entity</returns>
public virtual T Create(string name)
{
return this.Create(name, (Args)null);
}
/// <summary>
/// Creates an Entity in this collection.
/// </summary>
/// <param name="name">The name of this Entity</param>
/// <param name="args">The variable argument list</param>
/// <returns>The Entity</returns>
public virtual T Create(string name, Args args)
{
args = Args.Create(args);
args.Add("name", name);
this.Service.Post(this.Path, args);
this.Invalidate();
return this.Get(name);
}
/// <summary>
/// Removes an entity from this collection. Note that this method can
/// throw the SplunkException "AMBIGUOUS" if the collection contains
/// more than one entity with the specified key. Disambiguation is done
/// through the similar method Remove(object key, Dictionary namespace)
/// which uses the namespace to perform the disambiguation.
/// </summary>
/// <param name="key">The name of this Entity</param>
/// <returns>The removed Entity</returns>
public virtual T Remove(string key)
{
this.Validate();
if (!this.ContainsKey(key))
{
return default(T);
}
List<T> entities = this.Items[key];
if (entities != null && entities.Count > 1)
{
throw new SplunkException(
SplunkException.AMBIGUOUS,
"Key has multiple values, specify a namespace");
}
if (entities == null)
{
return default(T);
}
T entity = entities[0];
entity.Remove();
this.Invalidate();
return entity;
}
/// <summary>
/// Removes an entity from this collection, with a namespace
/// restriction.
/// </summary>
/// <param name="key">The name of this Entity</param>
/// <param name="splunkNamespace">The namespace</param>
/// <returns>The removed Entity</returns>
public virtual T Remove(string key, Args splunkNamespace)
{
this.Validate();
if (!this.ContainsKey(key))
{
return default(T);
}
List<T> entities = Items[key];
string pathMatcher =
Service.Fullpath(string.Empty, splunkNamespace);
if (entities.Count == 0)
{
return default(T);
}
foreach (T entity in entities)
{
if (entity.Path.StartsWith(pathMatcher))
{
entity.Remove();
this.Invalidate();
return entity;
}
}
return default(T);
}
}
}