Package org.bedework.calfacade.configs
Interface LdapConfigProperties
- All Superinterfaces:
DirConfigProperties,Serializable
This interface defines the various properties we need to make a connection
and retrieve a group and user information via ldap.
- Author:
- Mike Douglass
-
Method Summary
Modifier and TypeMethodDescriptionIf we need an id to authenticate this is it.If we need an id to authenticate this is it.Dn we search under for groups e.g.Prefix for group principal dnPrefix for group principal dnAttribute we search for to get a groupAttribute we want back identifying a memberIf non-null we treat the group member entry as a value to search for under this context dn.Attribute we want back for a member search giving the group accountIf groupMemberContextDn is not null this is the attribute we search for under that dn, otherwise we don't use this value.Attribute we want back for a member search giving the user accountAn object class which identifies an entry as a userURL of ldap servere.g "ssl"Prefix for user principal dnPrefix for user principal dnAn object class which identifies an entry as a uservoidIf we need an id to authenticate this is it.voidIf we need an id to authenticate this is the pw.voidsetGroupContextDn(String val) Dn we search under for groups e.g.voidsetGroupDnPrefix(String val) Prefix for group principal dnvoidsetGroupDnSuffix(String val) Suffix for group principal dnvoidsetGroupIdAttr(String val) Attribute we search for to get a groupvoidsetGroupMemberAttr(String val) Attribute we want back identifying a membervoidIf non-null we treat the group member entry as a value to search for under this context dn.voidAttribute we want back for a member search giving the group accountvoidIf groupMemberContextDn is not null this is the attribute we search for under that dn, otherwise we don't use this value.voidAttribute we want back for a member search giving the user accountvoidAn object class which identifies an entry as a groupvoidvoidsetProviderUrl(String val) URL of ldap servervoidvoide.g.voidsetUserDnPrefix(String val) Prefix for user principal dnvoidsetUserDnSuffix(String val) Suffix for user principal dnvoidsetUserObjectClass(String val) An object class which identifies an entry as a userMethods inherited from interface org.bedework.calfacade.configs.DirConfigProperties
getCalAddrPrefixes, getDefaultDomain, getDomains, getMbeanClassName, setCalAddrPrefixes, setDefaultDomain, setDomains, setMbeanClassName
-
Method Details
-
setInitialContextFactory
- Parameters:
val-
-
getInitialContextFactory
String getInitialContextFactory()- Returns:
- String
-
setSecurityAuthentication
- Parameters:
val-
-
getSecurityAuthentication
String getSecurityAuthentication()- Returns:
- String
-
setSecurityProtocol
e.g. "ssl"- Parameters:
val-
-
getSecurityProtocol
String getSecurityProtocol()e.g "ssl"- Returns:
- String val
-
setProviderUrl
URL of ldap server- Parameters:
val-
-
getProviderUrl
String getProviderUrl()URL of ldap server- Returns:
- String val
-
setGroupContextDn
Dn we search under for groups e.g. "ou=groups, dc=bedework, dc=org"- Parameters:
val-
-
getGroupContextDn
String getGroupContextDn()Dn we search under for groups e.g. "ou=groups, dc=bedework, dc=org"- Returns:
- String val
-
setGroupIdAttr
Attribute we search for to get a group- Parameters:
val-
-
getGroupIdAttr
String getGroupIdAttr()Attribute we search for to get a group- Returns:
- String val
-
setGroupMemberAttr
Attribute we want back identifying a member- Parameters:
val-
-
getGroupMemberAttr
String getGroupMemberAttr()Attribute we want back identifying a member- Returns:
- String val
-
setGroupMemberContextDn
If non-null we treat the group member entry as a value to search for under this context dn. Otherwise we treat the group member entry as the actual dn.- Parameters:
val-
-
getGroupMemberContextDn
String getGroupMemberContextDn()If non-null we treat the group member entry as a value to search for under this context dn. Otherwise we treat the group member entry as the actual dn.- Returns:
- String val
-
setGroupMemberSearchAttr
If groupMemberContextDn is not null this is the attribute we search for under that dn, otherwise we don't use this value.- Parameters:
val-
-
getGroupMemberSearchAttr
String getGroupMemberSearchAttr()If groupMemberContextDn is not null this is the attribute we search for under that dn, otherwise we don't use this value.- Returns:
- String val
-
setGroupMemberUserIdAttr
Attribute we want back for a member search giving the user account- Parameters:
val-
-
getGroupMemberUserIdAttr
String getGroupMemberUserIdAttr()Attribute we want back for a member search giving the user account- Returns:
- String val
-
setGroupMemberGroupIdAttr
Attribute we want back for a member search giving the group account- Parameters:
val-
-
getGroupMemberGroupIdAttr
String getGroupMemberGroupIdAttr()Attribute we want back for a member search giving the group account- Returns:
- String val
-
setUserDnPrefix
Prefix for user principal dn- Parameters:
val-
-
getUserDnPrefix
String getUserDnPrefix()Prefix for user principal dn- Returns:
- String val
-
setUserDnSuffix
Suffix for user principal dn- Parameters:
val-
-
getUserDnSuffix
String getUserDnSuffix()Prefix for user principal dn- Returns:
- String val
-
setGroupDnPrefix
Prefix for group principal dn- Parameters:
val-
-
getGroupDnPrefix
String getGroupDnPrefix()Prefix for group principal dn- Returns:
- String val
-
setGroupDnSuffix
Suffix for group principal dn- Parameters:
val-
-
getGroupDnSuffix
String getGroupDnSuffix()Prefix for group principal dn- Returns:
- String val
-
setUserObjectClass
An object class which identifies an entry as a user- Parameters:
val-
-
getUserObjectClass
String getUserObjectClass()An object class which identifies an entry as a user- Returns:
- String val
-
setGroupObjectClass
An object class which identifies an entry as a group- Parameters:
val-
-
getGroupObjectClass
String getGroupObjectClass()An object class which identifies an entry as a user- Returns:
- String val
-
setAuthDn
If we need an id to authenticate this is it.- Parameters:
val-
-
getAuthDn
String getAuthDn()If we need an id to authenticate this is it.- Returns:
- String val
-
setAuthPw
If we need an id to authenticate this is the pw.- Parameters:
val-
-
getAuthPw
String getAuthPw()If we need an id to authenticate this is it.- Returns:
- String val
-