Package com.iplanet.services.ldap

Class ServerInstance

  • public class ServerInstance
extends Object
    The server instance object represents a tuple of . This Server object provides information regarding the server name, port number. The user object provides the information regarding the authentication type, authentication dn, and password. The baseDN is the search base, which must be honored by the application and restrict its domain under this baseDN.

    • Method Detail

      • setActiveStatus

        public void setActiveStatus​(boolean serverStatus)
        Set the active status. Set the status of the server instance. This method must be called if there was some problems with this server instance. e.g While using this server instance, an application gets LDAP_SERVER_DOWN error code, then, the application can set the status to false, so that the next call to getServerInstance(String serviceID) would exclude this particular server instance.
        Parameters:
        serverStatus - Status of the server.

      • getActiveStatus

        public boolean getActiveStatus()
        Get the status of server instance.
        Returns:
        boolean the status of the server.

      • getServerName

        public String getServerName()
        Get the name of the server.
        Returns:
        String Get the name of the server

      • getPort

        public int getPort()
        Get the port number.
        Returns:
        int The port number of the server instance.

      • getServerID

        public String getServerID()
        The serverID of the server to which this server instance is associated with.
        Returns:
        String The server ID of the server.

      • getAuthID

        public String getAuthID()
        Get the Authentication ID i.e. The LDAP Bind DN.
        Returns:
        String The LDAP bind DN.

      • getConnectionType

        public Server.Type getConnectionType()
        Get the connection type to the server.
        Returns:
        Server.Type The server type to the server.

      • getPasswd

        public String getPasswd()
        Get the password to get authenticated.
        Returns:
        String The password corresponding to the authentication ID.

      • getAuthType

        public LDAPUser.Type getAuthType()
        Get the authentication type of this server.
        Returns:
        int the Authentication code.

      • getMinConnections

        public int getMinConnections()
        Get the minimum connections that the connection pool is supposed to open.
        Returns:
        int the Minimum # of connections

      • getMaxConnections

        public int getMaxConnections()
        Get the maximum connections that the connection pool is supposed to open.
        Returns:
        int the Maximum # of connections

      • getBaseDN

        public String getBaseDN()
        The base DN that this server instance has defined. While using this server instance, this base DN must be honored.
        Returns:
        String The base dn value.

      • getIntValue

        public int getIntValue​(String key,
                       int defVal)

      • getBooleanValue

        public boolean getBooleanValue​(String key,
                               boolean defVal)

      • getLdapHeatbeat

        public int getLdapHeatbeat()