Class LDAPBasePropertySupport

java.lang.Object
netscape.ldap.beans.LDAPBasePropertySupport
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
LDAPGetEntries, LDAPGetProperty, LDAPIsMember, LDAPSimpleAuth

public class LDAPBasePropertySupport extends Object implements Serializable
This is a base class that is extended by various specialized LDAP Beans. It provides the common properties and accessors used by them.
See Also:
  • Field Details

  • Constructor Details

    • LDAPBasePropertySupport

      public LDAPBasePropertySupport()
      Constructor with no parameters
  • Method Details

    • getHost

      public String getHost()
      Returns the host to search at.
      Returns:
      DNS name or dotted IP name of host to search at
    • setHost

      public void setHost(String theHost)
      Sets host string.
      Parameters:
      theHost - host name
    • getPort

      public int getPort()
      Returns the port to search at.
      Returns:
      Port to search at
    • setPort

      public void setPort(int thePort)
      Sets port number.
      Parameters:
      thePort - port
    • getBase

      public String getBase()
      Returns the directory base to search at.
      Returns:
      directory base to search
    • setBase

      public void setBase(String theBase)
      Sets the starting base
      Parameters:
      theBase - starting base
    • getAuthDN

      public String getAuthDN()
      Returns the DN to authenticate as; null or empty for anonymous.
      Returns:
      DN to authenticate as
    • setAuthDN

      public void setAuthDN(String authDN)
      Sets the DN to authenticate as; null or empty for anonymous.
      Parameters:
      authDN - the DN to authenticate as
    • getAuthPassword

      public String getAuthPassword()
      Returns the password for the DN to authenticate as
      Returns:
      Password of DN to authenticate as
    • setAuthPassword

      public void setAuthPassword(String authPassword)
      Sets the password for the DN to authenticate as
      Parameters:
      authPassword - the password to use in authentication
    • getUserName

      public String getUserName()
      Returns the user name
      Returns:
      The user name
    • setUserName

      public void setUserName(String name)
      Set the user name. The name should be of the form "Polly Plum".
      Parameters:
      name - The user name
    • getUserID

      public String getUserID()
      Return the user ID.
      Returns:
      name the user id
    • setUserID

      public void setUserID(String name)
      Set the user ID.
      Parameters:
      name - the value of the user id
    • getScope

      public int getScope()
      Get the current search scope
      Returns:
      the current search scope as integer
    • setScope

      public void setScope(int scope)
      Set the search scope using an integer
      Parameters:
      scope - one of LDAPConnection.SCOPE_BASE, LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE
    • getFilter

      public String getFilter()
      Returns the search filter
      Returns:
      search filter
    • setFilter

      public void setFilter(String filter)
      Sets the search filter
      Parameters:
      filter - search filter
    • getDebug

      public boolean getDebug()
      Returns true if debug output is on
      Returns:
      true if debug output is on
    • setDebug

      public void setDebug(boolean on)
      Turns debug output on or off
      Parameters:
      on - true for debug output
    • getErrorCode

      public int getErrorCode()
      Returns the latest error code
      Returns:
      The latest error code
    • setErrorCode

      public void setErrorCode(int code)
      Sets an error code for retrieval by a client
      Parameters:
      code - An error code
    • addPropertyChangeListener

      public void addPropertyChangeListener(PropertyChangeListener listener)
      Add a client to be notified when an authentication result is in
      Parameters:
      listener - a client to be notified of changes
    • removePropertyChangeListener

      public void removePropertyChangeListener(PropertyChangeListener listener)
      Remove a client which had requested notification on authentication
      Parameters:
      listener - a client to not be notified of changes
    • firePropertyChange

      public void firePropertyChange(String propName, Object oldValue, Object newValue)
      Support for bound property notification
      Parameters:
      propName - Name of changed property
      oldValue - Previous value of property
      newValue - New value of property
    • printDebug

      protected void printDebug(String s)
    • connect

      protected void connect(LDAPConnection conn, String host, int port) throws LDAPException
      Sets up basic connection privileges for Communicator if necessary, and connects
      Parameters:
      host - Host to connect to.
      port - Port number.
      Throws:
      LDAPException - from connect()
    • setDefaultReferralCredentials

      protected void setDefaultReferralCredentials(LDAPConnection conn)
    • convertToString

      public String convertToString(String[] aResult)
      Utility method to convert an array of Strings to a single String with line feeds between elements.
      Parameters:
      aResult - The array of Strings to convert
      Returns:
      A String with the elements separated by line feeds