Class LDAPTool


  • public class LDAPTool
    extends java.lang.Object
    LDAP toolbox
    • Constructor Summary

      Constructors 
      Constructor Description
      LDAPTool​(java.lang.String url)
      Constructor (default anonymous access)
      LDAPTool​(java.lang.String url, java.lang.String userdn, java.lang.String password)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean bind​(boolean silent)
      Bind to LDAP with default user
      boolean bind​(java.lang.String userdn, java.lang.String password, boolean silent)
      Bind to LDAP with specified user
      org.json.JSONObject get​(java.lang.String dn, boolean silent)
      Get DN from LDAP with default
      org.json.JSONObject get​(java.lang.String userdn, java.lang.String password, java.lang.String dn, boolean silent)
      Get DN from LDAP with specified user
      java.lang.String getURI()
      Get LDAP URL
      java.lang.String getUsername()
      Get default LDAP user DN
      org.json.JSONArray search​(java.lang.String searchBase, java.lang.String searchFilter, boolean subtree, java.lang.String[] returnAttrs, java.lang.String[] sortAttrs, long limit, boolean silent)
      Search in LDAP with default user
      org.json.JSONArray search​(java.lang.String userdn, java.lang.String password, java.lang.String searchBase, java.lang.String searchFilter, boolean subtree, java.lang.String[] returnAttrs, java.lang.String[] sortAttrs, long limit, boolean silent)
      Search in LDAP with specified user
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LDAPTool

        public LDAPTool​(java.lang.String url)
        Constructor (default anonymous access)
        Parameters:
        url - LDAP URL
      • LDAPTool

        public LDAPTool​(java.lang.String url,
                        java.lang.String userdn,
                        java.lang.String password)
        Constructor
        Parameters:
        url - LDAP URL
        userdn - Optional default user DN (use null for default anonymous access)
        password - Optional default user password (use null for default anonymous access)
    • Method Detail

      • getURI

        public java.lang.String getURI()
        Get LDAP URL
      • getUsername

        public java.lang.String getUsername()
        Get default LDAP user DN
      • bind

        public boolean bind​(boolean silent)
        Bind to LDAP with default user
        Parameters:
        silent - Do not display error if bind fails
      • bind

        public boolean bind​(java.lang.String userdn,
                            java.lang.String password,
                            boolean silent)
        Bind to LDAP with specified user
        Parameters:
        userdn - User DN (use null for anonymous access)
        password - User password (use null for anonymous access)
        silent - Do not display error if bind fails
      • search

        public org.json.JSONArray search​(java.lang.String searchBase,
                                         java.lang.String searchFilter,
                                         boolean subtree,
                                         java.lang.String[] returnAttrs,
                                         java.lang.String[] sortAttrs,
                                         long limit,
                                         boolean silent)
        Search in LDAP with default user
        Parameters:
        searchBase - Search base
        searchFilter - Optional search filter (defaults to objectClass=*)
        subtree - Search in subtree?
        returnAttrs - Optional array of attribute names to return (defaults to all attributes)
        sortAttrs - Optional array of attribute names to sort on (defaults to none, may not work depending on LDAP server)
        silent - Do not display error if bind fails
      • search

        public org.json.JSONArray search​(java.lang.String userdn,
                                         java.lang.String password,
                                         java.lang.String searchBase,
                                         java.lang.String searchFilter,
                                         boolean subtree,
                                         java.lang.String[] returnAttrs,
                                         java.lang.String[] sortAttrs,
                                         long limit,
                                         boolean silent)
        Search in LDAP with specified user
        Parameters:
        userdn - User DN (use null for anonymous access)
        password - User password (use null for anonymous access)
        searchBase - Search base
        searchFilter - Optional search filter (defaults to objectClass=*)
        subtree - Search in subtree?
        returnAttrs - Optional array of attribute names to return (defaults to all attributes)
        sortAttrs - Optional array of attribute names to sort on (defaults to none, may not work depending on LDAP server)
        silent - Do not display error if bind fails
      • get

        public org.json.JSONObject get​(java.lang.String dn,
                                       boolean silent)
        Get DN from LDAP with default
        Parameters:
        dn - DN to get
        silent - Do not display error if bind fails
      • get

        public org.json.JSONObject get​(java.lang.String userdn,
                                       java.lang.String password,
                                       java.lang.String dn,
                                       boolean silent)
        Get DN from LDAP with specified user
        Parameters:
        userdn - User DN (use null for anonymous access)
        password - User password (use null for anonymous access)
        dn - DN to get
        silent - Do not display error if bind fails