%line	%branch
org.apache.jetspeed.security.spi.impl.ldap.LdapBindingConfig	0%	0%

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		package org.apache.jetspeed.security.spi.impl.ldap;
18
19		import javax.naming.ldap.LdapContext;
20
21		import org.apache.commons.configuration.ConfigurationException;
22		import org.apache.commons.configuration.PropertiesConfiguration;
23		import org.apache.commons.lang.StringUtils;
24		import org.apache.commons.logging.Log;
25		import org.apache.commons.logging.LogFactory;
26
27		/**
28		* <p>
29		* Holds the configuration for ldap binding.
30		* </p>
31		*
32		* @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
33		*/
34		public class LdapBindingConfig
35		{
36		/** The logger. */
37	0	private static final Log logger = LogFactory.getLog(LdapBindingConfig.class);
38
39		private LdapContext context;
40
41		private String initialContextFactory;
42		private String ldapSocketFactory;
43	0	private String ldapScheme = "ldap";
44		private String ldapServerName;
45		private String ldapServerPort;
46	0	private String ldapSecurityLevel = "simple";
47		private String ldapSecurityProtocol;
48		private String rootDn;
49		private String rootPassword;
50		private String rootContext;
51
52	0	private PropertiesConfiguration props = null;
53
54		private String groupFilter;
55		private String userFilter;
56
57		private String userRoleMembershipAttributes;
58
59		private String groupMembershipAttributes;
60		private String userGroupMembershipAttributes;
61
62		private String defaultSearchBase;
63
64		private String groupFilterBase;
65		private String userFilterBase;
66
67		private String groupIdAttribute;
68		private String userIdAttribute;
69
70		private String uidAttribute;
71		private String memberShipSearchScope;
72
73		private String[] groupObjectClasses;
74
75		private String[] userObjectClasses;
76
77		private String groupMembershipForRoleAttributes;
78
79		private String groupUidAttribute;
80		private String userUidAttribute;
81
82		private String[] groupAttributes;
83		private String[] userAttributes;
84
85		private String groupObjectRequiredAttributeClasses;
86
87		private String[] roleObjectClasses;
88		private String roleGroupMembershipForRoleAttributes;
89		private String[] roleAttributes;
90		private String roleObjectRequiredAttributeClasses;
91		private String roleFilter;
92		private String roleFilterBase;
93		private String roleIdAttribute;
94		private String roleUidAttribute;
95		private String roleMembershipAttributes;
96
97		private String userPasswordAttribute;
98
99		private String[] knownAttributes;
100
101		public LdapBindingConfig()
102	0	{
103		// allow for properties setting configuration instead of through one big ugly constructor call or external properties file
104	0	}
105
106		public LdapBindingConfig(String factory,
107		String name,
108		String port,
109		String context,
110		String dn,
111		String password,
112		String roleFilter,
113		String groupFilter,
114		String userFilter,
115		String roleMembershipAttributes,
116		String userRoleMembershipAttributes,
117		String groupMembershipAttributes,
118		String userGroupMembershipAttributes,
119		String groupMembershipForRoleAttributes,
120		String roleGroupMembershipForRoleAttributes,
121		String defaultSearchBase,
122		String roleFilterBase,
123		String groupFilterBase,
124		String userFilterBase,
125		String roleObjectClasses,
126		String groupObjectClasses,
127		String userObjectClasses,
128		String roleIdAttribute,
129		String groupIdAttribute,
130		String userIdAttribute,
131		String uidAttribute,
132		String memberShipSearchScope,
133		String roleUidAttribute,
134		String groupUidAttribute,
135		String userUidAttribute,
136		String roleObjectRequiredAttributeClasses,
137		String groupObjectRequiredAttributeClasses,
138		String userAttributes,
139		String roleAttributes,
140		String groupAttributes,
141		String userPasswordAttribute,
142		String knownAttributes)
143	0	{
144	0	initialContextFactory = factory;
145	0	ldapServerName = name;
146	0	ldapServerPort = port;
147	0	rootContext = context;
148	0	rootDn = dn;
149	0	rootPassword = password;
150
151	0	this.roleFilter=roleFilter;
152	0	this.groupFilter=groupFilter;
153	0	this.userFilter=userFilter;
154
155	0	this.roleMembershipAttributes=roleMembershipAttributes;
156	0	this.userRoleMembershipAttributes=userRoleMembershipAttributes;
157
158	0	this.groupMembershipAttributes=groupMembershipAttributes;
159	0	this.userGroupMembershipAttributes=userGroupMembershipAttributes;
160
161	0	this.groupMembershipForRoleAttributes=groupMembershipForRoleAttributes;
162	0	this.roleGroupMembershipForRoleAttributes=roleGroupMembershipForRoleAttributes;
163	0	this.defaultSearchBase=defaultSearchBase;
164
165	0	this.roleFilterBase=roleFilterBase;
166	0	this.groupFilterBase=groupFilterBase;
167	0	this.userFilterBase=userFilterBase;
168
169
170	0	this.roleObjectClasses=StringUtils.split(roleObjectClasses,",");
171	0	this.groupObjectClasses=StringUtils.split(groupObjectClasses,",");
172	0	this.userObjectClasses=StringUtils.split(userObjectClasses,",");
173
174	0	this.roleIdAttribute=roleIdAttribute;
175	0	this.groupIdAttribute=groupIdAttribute;
176	0	this.userIdAttribute=userIdAttribute;
177
178	0	this.uidAttribute = uidAttribute;
179	0	this.memberShipSearchScope=memberShipSearchScope;
180
181
182	0	this.roleUidAttribute=roleUidAttribute;
183	0	this.groupUidAttribute=groupUidAttribute;
184	0	this.userUidAttribute=userUidAttribute;
185
186	0	this.roleObjectRequiredAttributeClasses=roleObjectRequiredAttributeClasses;
187	0	this.groupObjectRequiredAttributeClasses=groupObjectRequiredAttributeClasses;
188
189	0	this.roleAttributes=StringUtils.split(roleAttributes,",");
190	0	this.groupAttributes = StringUtils.split(groupAttributes,",");
191	0	this.userAttributes = StringUtils.split(userAttributes,",");
192
193	0	this.userPasswordAttribute = userPasswordAttribute;
194
195	0	this.knownAttributes = StringUtils.split(knownAttributes,",");
196	0	}
197
198		/**
199		* <p>
200		* Default constructor. By default instantiates LdapBindingConfig from
201		* JETSPEED-INF/ldap/ldap.properties in the classpath.
202		* </p>
203		*/
204		public LdapBindingConfig(String ldapType)
205	0	{
206		try
207		{
208	0	props = new PropertiesConfiguration("JETSPEED-INF/directory/config/" + ldapType + "/ldap.properties");
209	0	initialContextFactory = props.getString("org.apache.jetspeed.ldap.initialContextFactory");
210	0	ldapServerName = props.getString("org.apache.jetspeed.ldap.ldapServerName");
211	0	ldapServerPort = props.getString("org.apache.jetspeed.ldap.ldapServerPort");
212	0	rootContext = props.getString("org.apache.jetspeed.ldap.rootContext");
213	0	rootDn = props.getString("org.apache.jetspeed.ldap.rootDn");
214	0	rootPassword = props.getString("org.apache.jetspeed.ldap.rootPassword");
215
216	0	roleFilter=props.getString("org.apache.jetspeed.ldap.RoleFilter");
217	0	groupFilter=props.getString("org.apache.jetspeed.ldap.GroupFilter");
218	0	userFilter=props.getString("org.apache.jetspeed.ldap.UserFilter");
219
220	0	roleMembershipAttributes=props.getString("org.apache.jetspeed.ldap.RoleMembershipAttributes");
221	0	userRoleMembershipAttributes=props.getString("org.apache.jetspeed.ldap.UserRoleMembershipAttributes");
222
223	0	groupMembershipAttributes=props.getString("org.apache.jetspeed.ldap.GroupMembershipAttributes");
224	0	userGroupMembershipAttributes=props.getString("org.apache.jetspeed.ldap.UserGroupMembershipAttributes");
225
226	0	groupMembershipForRoleAttributes=props.getString("org.apache.jetspeed.ldap.GroupMembershipForRoleAttributes");
227	0	roleGroupMembershipForRoleAttributes=props.getString("org.apache.jetspeed.ldap.RoleGroupMembershipForRoleAttributes");
228
229
230	0	defaultSearchBase=props.getString("org.apache.jetspeed.ldap.DefaultSearchBase");
231
232	0	roleFilterBase=props.getString("org.apache.jetspeed.ldap.RoleFilterBase");
233	0	groupFilterBase=props.getString("org.apache.jetspeed.ldap.GroupFilterBase");
234	0	userFilterBase=props.getString("org.apache.jetspeed.ldap.UserFilterBase");
235
236	0	this.roleObjectClasses=StringUtils.split(props.getString("org.apache.jetspeed.ldap.RoleObjectClasses"),",");
237	0	this.groupObjectClasses=StringUtils.split(props.getString("org.apache.jetspeed.ldap.GroupObjectClasses"),",");
238	0	this.userObjectClasses=StringUtils.split(props.getString("org.apache.jetspeed.ldap.UserObjectClasses"),",");
239
240	0	roleIdAttribute=props.getString("org.apache.jetspeed.ldap.RoleIdAttribute");
241	0	groupIdAttribute=props.getString("org.apache.jetspeed.ldap.GroupIdAttribute");
242	0	userIdAttribute=props.getString("org.apache.jetspeed.ldap.UserIdAttribute");
243
244	0	uidAttribute =props.getString("org.apache.jetspeed.ldap.UidAttribute");
245	0	memberShipSearchScope = props.getString("org.apache.jetspeed.ldap.MemberShipSearchScope");
246
247	0	this.roleUidAttribute=props.getString("org.apache.jetspeed.ldap.roleUidAttribute");
248	0	this.groupUidAttribute=props.getString("org.apache.jetspeed.ldap.groupUidAttribute");
249	0	this.userUidAttribute=props.getString("org.apache.jetspeed.ldap.userUidAttribute");
250
251	0	this.roleObjectRequiredAttributeClasses=props.getString("org.apache.jetspeed.ldap.roleObjectRequiredAttributeClasses");
252	0	this.groupObjectRequiredAttributeClasses=props.getString("org.apache.jetspeed.ldap.groupObjectRequiredAttributeClasses");
253
254	0	this.roleAttributes=StringUtils.split(props.getString("org.apache.jetspeed.ldap.roleAttributes"),",");
255	0	this.groupAttributes=StringUtils.split(props.getString("org.apache.jetspeed.ldap.groupAttributes"),",");
256	0	this.userAttributes=StringUtils.split(props.getString("org.apache.jetspeed.ldap.userAttributes"),",");
257	0	this.userPasswordAttribute=props.getString("org.apache.jetspeed.ldap.userPasswordAttribute");
258
259	0	this.knownAttributes=StringUtils.split(props.getString("org.apache.jetspeed.ldap.knownAttributes"),",");
260		}
261	0	catch (ConfigurationException ce)
262		{
263	0	logger.error("Could not configure LdapBindingConfig: " + ce);
264	0	}
265	0	}
266
267		LdapContext getContext()
268		{
269	0	return context;
270		}
271
272		void setContext(LdapContext context)
273		{
274	0	this.context = context;
275	0	}
276
277		/**
278		* @return Returns the initialContextFactory.
279		*/
280		public String getInitialContextFactory()
281		{
282	0	return initialContextFactory;
283		}
284
285		/**
286		* @param initialContextFactory The initialContextFactory to set.
287		*/
288		public void setInitialContextFactory(String initialContextFactory)
289		{
290	0	this.initialContextFactory = initialContextFactory;
291	0	}
292
293		/**
294		* @return the ldapScheme
295		*/
296		public String getLdapScheme()
297		{
298	0	return ldapScheme;
299		}
300
301		/**
302		* @param ldapScheme the ldapScheme to set
303		*/
304		public void setLdapScheme(String ldapScheme)
305		{
306	0	this.ldapScheme = ldapScheme;
307	0	}
308
309		/**
310		* @return the ldapSocketFactory
311		*/
312		public String getLdapSocketFactory()
313		{
314	0	return ldapSocketFactory;
315		}
316
317		/**
318		* @param ldapSocketFactory the ldapSocketFactory to set
319		*/
320		public void setLdapSocketFactory(String ldapSocketFactory)
321		{
322	0	this.ldapSocketFactory = ldapSocketFactory;
323	0	}
324
325		/**
326		* @return Returns the ldapServerName.
327		*/
328		public String getLdapServerName()
329		{
330	0	return ldapServerName;
331		}
332
333		/**
334		* @param ldapServerName The ldapServerName to set.
335		*/
336		public void setLdapServerName(String ldapServerName)
337		{
338	0	this.ldapServerName = ldapServerName;
339	0	}
340
341		/**
342		* @return Returns the ldapServerPort.
343		*/
344		public String getLdapServerPort()
345		{
346	0	return ldapServerPort;
347		}
348
349		/**
350		* @param ldapServerPort The ldapServerPort to set.
351		*/
352		public void setLdapServerPort(String ldapServerPort)
353		{
354	0	this.ldapServerPort = ldapServerPort;
355	0	}
356
357		/**
358		* @return the ldapSecurityLevel
359		*/
360		public String getLdapSecurityLevel()
361		{
362	0	return ldapSecurityLevel;
363		}
364
365		/**
366		* @param ldapSecurityLevel the ldapSecurityLevel to set
367		*/
368		public void setLdapSecurityLevel(String ldapSecurityLevel)
369		{
370	0	this.ldapSecurityLevel = ldapSecurityLevel;
371	0	}
372
373		/**
374		* @return the ldapSecurityProtocol
375		*/
376		public String getLdapSecurityProtocol()
377		{
378	0	return ldapSecurityProtocol;
379		}
380
381		/**
382		* @param ldapSecurityProtocol the ldapSecurityProtocol to set
383		*/
384		public void setLdapSecurityProtocol(String ldapSecurityProtocol)
385		{
386	0	this.ldapSecurityProtocol = ldapSecurityProtocol;
387	0	}
388
389		/**
390		* @return Returns the rootContext.
391		*/
392		public String getRootContext()
393		{
394	0	return rootContext;
395		}
396
397		/**
398		* @param rootContext The rootContext to set.
399		*/
400		public void setRootContext(String rootContext)
401		{
402	0	this.rootContext = rootContext;
403	0	}
404
405		/**
406		* @return Returns the rootDn.
407		*/
408		public String getRootDn()
409		{
410	0	return rootDn;
411		}
412
413		/**
414		* @param rootDn The rootDn to set.
415		*/
416		public void setRootDn(String rootDn)
417		{
418	0	this.rootDn = rootDn;
419	0	}
420
421		/**
422		* @return Returns the rootPassword.
423		*/
424		public String getRootPassword()
425		{
426	0	return rootPassword;
427		}
428
429		/**
430		* @param rootPassword The rootPassword to set.
431		*/
432		public void setRootPassword(String rootPassword)
433		{
434	0	this.rootPassword = rootPassword;
435	0	}
436
437		public String getUserFilter() {
438	0	return userFilter;
439		}
440
441		public void setUserFilter(String userFilter) {
442	0	this.userFilter = userFilter;
443	0	}
444
445		public String getUserFilterBase() {
446	0	return userFilterBase;
447		}
448
449		public void setUserFilterBase(String userFilterBase) {
450	0	this.userFilterBase = userFilterBase;
451	0	}
452
453		public String getUserGroupMembershipAttributes() {
454	0	return userGroupMembershipAttributes;
455		}
456
457		public void setUserGroupMembershipAttributes(
458		String userGroupMembershipAttributes) {
459	0	this.userGroupMembershipAttributes = userGroupMembershipAttributes;
460	0	}
461
462		public String getUserRoleMembershipAttributes() {
463	0	return userRoleMembershipAttributes;
464		}
465
466		public void setUserRoleMembershipAttributes(String userRoleMembershipAttributes) {
467	0	this.userRoleMembershipAttributes = userRoleMembershipAttributes;
468	0	}
469
470		public String getDefaultSearchBase() {
471	0	return defaultSearchBase;
472		}
473
474		public void setDefaultSearchBase(String defaultSearchBase) {
475	0	this.defaultSearchBase = defaultSearchBase;
476	0	}
477
478		public String getGroupFilter() {
479	0	return groupFilter;
480		}
481
482		public void setGroupFilter(String groupFilter) {
483	0	this.groupFilter = groupFilter;
484	0	}
485
486		public String getGroupFilterBase() {
487	0	return groupFilterBase;
488		}
489
490		public void setGroupFilterBase(String groupFilterBase) {
491	0	this.groupFilterBase = groupFilterBase;
492	0	}
493
494		public String getGroupMembershipAttributes() {
495	0	return groupMembershipAttributes;
496		}
497
498		public void setGroupMembershipAttributes(String groupMembershipAttributes) {
499	0	this.groupMembershipAttributes = groupMembershipAttributes;
500	0	}
501
502		public String getGroupIdAttribute() {
503	0	return groupIdAttribute;
504		}
505
506		public void setGroupIdAttribute(String groupIdAttribute) {
507	0	this.groupIdAttribute = groupIdAttribute;
508	0	}
509
510
511		public String getUserIdAttribute() {
512	0	return userIdAttribute;
513		}
514
515		public void setUserIdAttribute(String userIdAttribute) {
516	0	this.userIdAttribute = userIdAttribute;
517	0	}
518
519		public String[] getGroupObjectClasses() {
520	0	return groupObjectClasses;
521		}
522
523		public void setGroupObjectClasses(String[] groupObjectClasses) {
524	0	this.groupObjectClasses = groupObjectClasses;
525	0	}
526
527
528
529		public String[] getUserObjectClasses() {
530	0	return userObjectClasses;
531		}
532
533		public void setUserObjectClasses(String[] userObjectClasses) {
534	0	this.userObjectClasses = userObjectClasses;
535	0	}
536
537
538		public String getGroupMembershipForRoleAttributes() {
539	0	return this.groupMembershipForRoleAttributes;
540		}
541
542
543
544		public void setGroupMembershipForRoleAttributes(String groupMembershipForRoleAttributes) {
545	0	this.groupMembershipForRoleAttributes=groupMembershipForRoleAttributes;
546	0	}
547
548		public String getUidAttribute() {
549	0	return uidAttribute;
550		}
551
552		public void setUidAttribute(String uidAttribute) {
553	0	this.uidAttribute = uidAttribute;
554	0	}
555
556		public String getMemberShipSearchScope() {
557	0	return memberShipSearchScope;
558		}
559
560		public void setMemberShipSearchScope(String memberShipSearchScope) {
561	0	this.memberShipSearchScope = memberShipSearchScope;
562	0	}
563
564		public String getGroupUidAttribute() {
565	0	return this.groupUidAttribute;
566		}
567
568		public void setGroupUidAttribute(String groupUidAttribute) {
569	0	this.groupUidAttribute = groupUidAttribute;
570	0	}
571
572		public String getUserUidAttribute() {
573	0	return this.userUidAttribute;
574		}
575
576		public void setUserUidAttribute(String userUidAttribute) {
577	0	this.userUidAttribute = userUidAttribute;
578	0	}
579
580		public String getGroupObjectRequiredAttributeClasses() {
581	0	return groupObjectRequiredAttributeClasses;
582		}
583
584		public void setGroupObjectRequiredAttributeClasses(
585		String groupObjectRequiredAttributeClasses) {
586	0	this.groupObjectRequiredAttributeClasses = groupObjectRequiredAttributeClasses;
587	0	}
588
589
590
591		public String[] getGroupAttributes() {
592	0	return groupAttributes;
593		}
594
595		public void setGroupAttributes(String[] groupAttributes) {
596	0	this.groupAttributes = groupAttributes;
597	0	}
598
599		public String[] getUserAttributes() {
600	0	return userAttributes;
601		}
602
603		public void setUserAttributes(String[] userAttributes) {
604	0	this.userAttributes = userAttributes;
605	0	}
606
607		public String getRoleObjectRequiredAttributeClasses() {
608	0	return roleObjectRequiredAttributeClasses;
609		}
610
611		public void setRoleObjectRequiredAttributeClasses(
612		String roleObjectRequiredAttributeClasses) {
613	0	this.roleObjectRequiredAttributeClasses = roleObjectRequiredAttributeClasses;
614	0	}
615
616		public String[] getRoleAttributes() {
617	0	return roleAttributes;
618		}
619
620		public void setRoleAttributes(String[] roleAttributes) {
621	0	this.roleAttributes = roleAttributes;
622	0	}
623
624		public String[] getRoleObjectClasses() {
625	0	return roleObjectClasses;
626		}
627
628		public void setRoleObjectClasses(String[] roleObjectClasses) {
629	0	this.roleObjectClasses = roleObjectClasses;
630	0	}
631
632
633		public String getRoleGroupMembershipForRoleAttributes() {
634	0	return this.roleGroupMembershipForRoleAttributes;
635		}
636
637		public void setRoleGroupMembershipForRoleAttributes(String roleGroupMembershipForRoleAttributes) {
638	0	this.roleGroupMembershipForRoleAttributes=roleGroupMembershipForRoleAttributes;
639	0	}
640
641		public String getRoleFilter() {
642	0	return roleFilter;
643		}
644
645		public void setRoleFilter(String roleFilter) {
646	0	this.roleFilter = roleFilter;
647	0	}
648
649		public String getRoleFilterBase() {
650	0	return roleFilterBase;
651		}
652
653		public void setRoleFilterBase(String roleFilterBase) {
654	0	this.roleFilterBase = roleFilterBase;
655	0	}
656
657		public String getRoleMembershipAttributes() {
658	0	return roleMembershipAttributes;
659		}
660
661		public void setRoleMembershipAttributes(String roleMembershipAttributes) {
662	0	this.roleMembershipAttributes = roleMembershipAttributes;
663	0	}
664
665		public String getRoleUidAttribute() {
666	0	return this.roleUidAttribute;
667		}
668
669		public void setRoleUidAttribute(String roleUidAttribute) {
670	0	this.roleUidAttribute = roleUidAttribute;
671	0	}
672
673
674		public String getRoleIdAttribute() {
675	0	return roleIdAttribute;
676		}
677
678		public void setRoleIdAttribute(String roleIdAttribute) {
679	0	this.roleIdAttribute = roleIdAttribute;
680	0	}
681
682		public String getUserPasswordAttribute() {
683	0	return userPasswordAttribute;
684		}
685
686		public void setUserPasswordAttribute(String userPasswordAttribute) {
687	0	this.userPasswordAttribute = userPasswordAttribute;
688	0	}
689
690		public String[] getKnownAttributes() {
691	0	return this.knownAttributes;
692		}
693
694		public void setKnownAttributes(String[] knownAttributes) {
695	0	this.knownAttributes = knownAttributes;
696	0	}
697
698		}

This report is generated by jcoverage, Maven and Maven JCoverage Plugin.