/
Group.java
executable file
·567 lines (495 loc) · 14.9 KB
/
Group.java
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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* https://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 org.apache.directory.fortress.core.model;
import org.apache.directory.fortress.core.util.PropUtil;
import javax.xml.bind.annotation.*;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
import java.util.StringTokenizer;
/**
* All entities (User, Role, Permission, Policy, SDSet, etc...) are used to carry data between Fortress's
* layers starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into
* (3) DAO layer where persistence with the LDAP server occurs. The clients must instantiate an Fortress entity before use
* and must provide enough information to uniquely identity target record for reads.
* <p>
* <h4>Group Schema</h4>
* <p>
* The Fortress Group entity is a composite of 2 different LDAP Schema object classes:
* <p>
* 1. groupOfNames Structural Object Class is used to manage groups within LDAP.
* <pre>
* ------------------------------------------
* objectClasses: ( 2.5.6.9 NAME 'groupOfNames'
* DESC 'RFC2256: a group of names (DNs)' SUP top STRUCTURAL
* MUST (
* member $ cn )
* MAY
* ( businessCategory $ seeAlso $ owner $ ou $ o $ description
* )
* )
* ------------------------------------------
* </pre>
* <p>
* 2. configGroup STRUCTURAL Object Class is used to store groups and their relationships to users or roles.
* <pre>
* ------------------------------------------
* LDAP Configuration Group Structural Object Class
* objectClass ( ftObId:8
* NAME 'configGroup'
* DESC 'LDAP Configuration Group'
* S
* SUP groupOfNames
* MUST (
* configProtocol $
* ftType
* )
* MAY configParameter
* )
* ------------------------------------------
* </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@XmlRootElement(name = "fortGroup")
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "group", propOrder =
{
"name",
"description",
"protocol",
"members",
"props",
"type",
"roles"
})
public class Group extends FortEntity implements Serializable
{
private static final long serialVersionUID = 1L;
private String name;
private String description;
private String protocol;
private List<String> members;
private Props props = new Props();
@XmlTransient
private boolean memberDn;
private Type type;
/**
* Auxiliary field used to store roles in UserRole format.
*/
@XmlElement( nillable = true )
private List<UserRole> roles = new ArrayList<>();
/**
* enum for User or Role data sets. Both nodes may be stored in the same LDAP container.
*/
@XmlType(name = "groupType")
@XmlEnum
public enum Type
{
/**
* Entry contains a set of Users.
*/
USER,
/**
* Entry contains a set of Roles.
*/
ROLE
}
/**
* Get the required type of Group - 'USER' Or 'ROLE'.
*
* @return type that determines what node maps to.
*/
public Type getType()
{
return type;
}
/**
* Set the required type of Group - 'USER' Or 'ROLE'.
*
* @param type determines what set the node contains.
*/
public void setType( Type type )
{
this.type = type;
}
/**
* Default constructor used by {@link org.apache.directory.fortress.core.ant.FortressAntTask} defaults to type USER.
*/
public Group()
{
type = Type.USER;
}
/**
* Constructor for base type.
*/
public Group( Type type )
{
this.type = type;
}
/**
* Generate instance of group to be loaded as ldap object.
*
* @param name maps to 'cn' attribute in group object class.
*/
public Group( String name )
{
this.name = name;
type = Type.USER;
}
/**
* Generate instance of group to be loaded as ldap object with node type.
*
* @param name maps to 'cn' attribute in group object class.
*/
public Group( String name, Type type )
{
this.name = name;
this.type = type;
}
/**
* Generate instance of group to be loaded as ldap object.
*
* @param name maps to 'cn' attribute in group object class.
* @param description maps to 'description' attribute in group object class.
*/
public Group( String name, String description )
{
this.name = name;
this.description = description;
type = Type.USER;
}
/**
* Generate instance of group to be loaded as ldap object with node type.
*
* @param name maps to 'cn' attribute in group object class.
* @param description maps to 'description' attribute in group object class.
*/
public Group( String name, String description, Type type )
{
this.name = name;
this.description = description;
this.type = type;
}
/**
* Get the second level qualifier on the domain component. This attribute is required.
*
* @return name maps to 'dcObject' object class.
*/
public String getName()
{
return name;
}
/**
* Set the second level qualifier on the domain component. This attribute is required.
*
* @param name maps to 'dcObject' object class.
*/
public void setName( String name )
{
this.name = name;
}
/**
* Get the description for the domain component. This value is not required or constrained
* but is validated on reasonability.
*
* @return field maps to 'o' attribute on 'dcObject'.
*/
public String getDescription()
{
return description;
}
/**
* Set the description for the domain component. This value is not required or constrained
* but is validated on reasonability.
*
* @param description maps to 'o' attribute on 'dcObject'.
*/
public void setDescription( String description )
{
this.description = description;
}
/**
* Get protocol qualifier for this entity.
*
* @return protocol.
*/
public String getProtocol()
{
return protocol;
}
/**
* Set the protocol qualifier for this entity.
*
* @param protocol contains protocol qualifier for this entity.
*/
public void setProtocol( String protocol )
{
this.protocol = protocol;
}
/**
* Add a single userId as member of this entity.
*
* @param userId
*/
public void setMember( String userId )
{
if ( members == null )
{
members = new ArrayList<>();
}
members.add( userId );
}
/**
* Return the members
*
* @return List of type String containing userIds.
*/
public List<String> getMembers()
{
return members;
}
/**
* Set a member on this entity using a comma delimited String.
*
* @param members String contains one or more userids in comma delimited format.
*/
public void setMembersWithCsv( String members )
{
if ( members != null )
{
StringTokenizer tkn = new StringTokenizer( members, "," );
if ( tkn.countTokens() > 0 )
{
while ( tkn.hasMoreTokens() )
{
String member = tkn.nextToken();
setMember( member );
}
}
}
}
/**
* Set members onto this entity using a List of userIds.
*
* @param members List of type String contains userIds to be associated as members of this group.
*/
public void setMembers( List<String> members )
{
this.members = members;
}
/**
* Add name/value pair to list of properties associated with PermObj. These values are not constrained by Fortress.
* Properties are optional.
*
* @param key contains property name and maps to 'ftProps' attribute in 'ftProperties' aux object class.
* @param value
*/
public void addProperty( String key, String value )
{
Props.Entry entry = new Props.Entry();
entry.setKey( key );
entry.setValue( value );
this.props.getEntry().add( entry );
}
/**
* Get a name/value pair attribute from list of properties associated with PermObj. These values are not constrained by Fortress.
* Properties are optional.
*
* @param key contains property name and maps to 'ftProps' attribute in 'ftProperties' aux object class.
* @return value containing name/value pair that maps to 'ftProps' attribute in 'ftProperties' aux object class.
*/
public String getProperty( String key )
{
List<Props.Entry> props = this.props.getEntry();
Props.Entry keyObj = new Props.Entry();
keyObj.setKey( key );
String value = null;
int indx = props.indexOf( keyObj );
if ( indx != -1 )
{
Props.Entry entry = props.get( props.indexOf( keyObj ) );
value = entry.getValue();
}
return value;
}
/**
* Replace teh collection of name/value pairs to attributes associated with Group entity. These values are not constrained by Fortress.
* Properties are optional.
*
* @param properties contains collection of name/value pairs and maps to 'ftProps' attribute in 'ftProperties' aux object class.
*/
public void setProperties( Properties properties )
{
if ( properties != null )
{
// reset the existing properties stored in this entity.
props = new Props();
for ( Enumeration<?> e = properties.propertyNames(); e.hasMoreElements(); )
{
// This LDAP attr is stored as a name-value pair separated by a ':'.
String key = ( String ) e.nextElement();
String val = properties.getProperty( key );
addProperty( key, val );
}
}
}
/**
* Add new collection of name=value pairs to attributes associated with Group. These values are not constrained by Fortress.
* Properties are optional.
*
* @param properties contains name=value pairs that are comma delmited.
*/
public void setPropertiesWithCsv( String properties )
{
setProperties( PropUtil.getProperties( properties, '=', "," ) );
}
/**
* Return the collection of name/value pairs to attributes associated with PermObj. These values are not constrained by Fortress.
* Properties are optional.
*
* @return Properties contains collection of name/value pairs and maps to 'ftProps' attribute in 'ftProperties' aux object class.
*/
public Properties getProperties()
{
Properties properties = null;
List<Props.Entry> props = this.props.getEntry();
if ( props.size() > 0 )
{
properties = new Properties();
for ( Props.Entry entry : props )
{
String key = entry.getKey();
String val = entry.getValue();
properties.setProperty( key, val );
}
}
return properties;
}
public List<String> getPropList()
{
List<Props.Entry> props = this.props.getEntry();
List<String> propList = null;
if ( props.size() > 0 )
{
propList = new ArrayList<>();
for ( Props.Entry entry : props )
{
String key = entry.getKey();
String val = entry.getValue();
String prop = key + "=" + val;
propList.add( prop );
}
}
return propList;
}
/**
* Gets the value of the Props property. This method is used by Fortress Core and Rest and should not be called by external programs.
*
* @return {@link Props }
*
*/
public Props getProps()
{
return props;
}
/**
* Sets the value of the Props property. This method is used by Fortress Core and Rest and should not be called by external programs.
*
* @param props
* allowed object is
* {@link Props }
*
*/
public void setProps( Props props )
{
this.props = props;
}
/**
* Set if userDn's are loaded in dn format.
*
* @return true indicates members are in dn format.
*/
public boolean isMemberDn()
{
return memberDn;
}
/**
* Set to 'true' if members are in dn format.
*
* @param memberDn boolean value, set to 'true' if distinguished name (dn) format, 'false' if relative distinguished name (rdn) format.
*/
public void setMemberDn( boolean memberDn )
{
this.memberDn = memberDn;
}
/**
* List of roles for given groups if they were populated. Empty list otherwise.
* @return
*/
public List<UserRole> getRoles() {
return roles;
}
/**
* Setter for auxiliary 'roles' field.
* @param roles list of roles to be set
*/
public void setRoles(List<UserRole> roles) {
this.roles = roles;
}
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
Group group = ( Group ) o;
if ( name == null )
{
return false;
}
return name.equals( group.name );
}
@Override
public int hashCode()
{
int result = name.hashCode();
result = 31 * result + ( description != null ? description.hashCode() : 0 );
result = 31 * result + ( protocol != null ? protocol.hashCode() : 0 );
result = 31 * result + ( members != null ? members.hashCode() : 0 );
result = 31 * result + ( props != null ? props.hashCode() : 0 );
return result;
}
@Override
public String toString()
{
return "Group{" +
"name='" + name + '\'' +
", description='" + description + '\'' +
'}';
}
}