Interface LdapConfigProperties

All Superinterfaces:
DirConfigProperties, Serializable

public interface LdapConfigProperties extends DirConfigProperties
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 Details

    • setInitialContextFactory

      void setInitialContextFactory(String val)
      Parameters:
      val -
    • getInitialContextFactory

      String getInitialContextFactory()
      Returns:
      String
    • setSecurityAuthentication

      void setSecurityAuthentication(String val)
      Parameters:
      val -
    • getSecurityAuthentication

      String getSecurityAuthentication()
      Returns:
      String
    • setSecurityProtocol

      void setSecurityProtocol(String val)
      e.g. "ssl"
      Parameters:
      val -
    • getSecurityProtocol

      String getSecurityProtocol()
      e.g "ssl"
      Returns:
      String val
    • setProviderUrl

      void setProviderUrl(String val)
      URL of ldap server
      Parameters:
      val -
    • getProviderUrl

      String getProviderUrl()
      URL of ldap server
      Returns:
      String val
    • setGroupContextDn

      void setGroupContextDn(String val)
      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

      void setGroupIdAttr(String val)
      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

      void setGroupMemberAttr(String val)
      Attribute we want back identifying a member
      Parameters:
      val -
    • getGroupMemberAttr

      String getGroupMemberAttr()
      Attribute we want back identifying a member
      Returns:
      String val
    • setGroupMemberContextDn

      void setGroupMemberContextDn(String val)
      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

      void setGroupMemberSearchAttr(String val)
      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

      void setGroupMemberUserIdAttr(String val)
      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

      void setGroupMemberGroupIdAttr(String val)
      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

      void setUserDnPrefix(String val)
      Prefix for user principal dn
      Parameters:
      val -
    • getUserDnPrefix

      String getUserDnPrefix()
      Prefix for user principal dn
      Returns:
      String val
    • setUserDnSuffix

      void setUserDnSuffix(String val)
      Suffix for user principal dn
      Parameters:
      val -
    • getUserDnSuffix

      String getUserDnSuffix()
      Prefix for user principal dn
      Returns:
      String val
    • setGroupDnPrefix

      void setGroupDnPrefix(String val)
      Prefix for group principal dn
      Parameters:
      val -
    • getGroupDnPrefix

      String getGroupDnPrefix()
      Prefix for group principal dn
      Returns:
      String val
    • setGroupDnSuffix

      void setGroupDnSuffix(String val)
      Suffix for group principal dn
      Parameters:
      val -
    • getGroupDnSuffix

      String getGroupDnSuffix()
      Prefix for group principal dn
      Returns:
      String val
    • setUserObjectClass

      void setUserObjectClass(String val)
      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

      void setGroupObjectClass(String val)
      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

      void setAuthDn(String val)
      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

      void setAuthPw(String val)
      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