Package com.iplanet.services.ldap
Class LDAPServiceException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- com.iplanet.services.ldap.LDAPServiceException
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
EventException
public class LDAPServiceException extends Exception
This exception class captures exceptions that occur in the com.iplanet.services.ldap package.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intCACHE_OP_NOT_SUPPORTEDCACHE_OP_NOT_PERMITTED(18) If the particular server does not support entry change notifications, the setupCache will return this exception.static intFILE_NOT_FOUNDFILE_NOT_FOUND(19) This exception is thrown if ADAL tries to open a file and get a java.io.FileNotFoundExceptionstatic intFILTER_IS_REQDFILTER_IS_REQUIRED(11) For a search operation, filter is required.static intINCOMPATIBLE_DB_TYPEINCOMPATIBLE_DB_TYPE(17) E.g.static intINCORRECT_CP_PARAMSINCORRECT_CP_PARAMS(8) One or more connection pool parameters incorrect.static intINCORRECT_LDAP_PARAMSINCORRECT_LDAP_PARAMS(7) If the server_type is given as LDAP, then one or more of the ldap parameters are not correct.static intINCORRECT_LDAP_REBIND_PARAMSINCORRECT_LDAP_REBIND_PARAMS(9) The rebind parameters specified are not correct.static intINCORRECT_SERVER_PARAMSINCORRECT_SERVER_PARAMS(6) Incorrect server parameters passed in the configuration file.static intINVALID_ENTRY_IDINVALID_ENTRY_ID(16) Typically, if an invalid ID is passed to Entry's constructor, this error is thrown.static intINVALID_OPERATIONINVALID_OPERATION(5) Reported an invalid operation.static intINVALID_SEARCH_CONSTRAINTSINVALID_SEARCH_CONSTRAINTS(12) If the constraints specified are not comprehendable, then this error is returned.static intMUST_HAVE_SERVICE_NAMEMUST_HAVE_SERVICE_NAME(10) Simple, the any ips_core:service specified in the xml must have a name.static intNO_COMMON_SERVICE_SPECIFIEDNO_DEFAULT_SERVICE_SPECIFIED(14) It could happen if you call DataAccessProvider.getConnection() and there was no "common" service defined in the serverconfig.xml.static intSERVER_DOWNSERVER_DOWN(4) Indicates that the server was reported down.static intSERVER_NOT_PRESENTSERVER_NOT_PRESENT(15) If you call getConnection, with or without the service name and there is no Server specified for that service, this exception gets thrown.static intSERVICE_NOT_PRESENTSERVICE_NOT_FOUND(13) When called DataAccessProvider.getConnection(String), it tries to look for the type of service it is given to provide.static intUNKNOWN_ERRORUNKNOWN_ERROR(20) This error is thrown when ADAL does not know what on earth happened. e.g.
-
Constructor Summary
Constructors Constructor Description LDAPServiceException(int code)ConstructorLDAPServiceException(int code, String errormsg)The constructor.LDAPServiceException(int code, Throwable t)LDAPServiceException(String errormsg)The constructor.LDAPServiceException(String errormsg, Throwable t)The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetMessage()-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Field Detail
-
SERVER_DOWN
public static final int SERVER_DOWN
SERVER_DOWN(4) Indicates that the server was reported down.- See Also:
- Constant Field Values
-
INVALID_OPERATION
public static final int INVALID_OPERATION
INVALID_OPERATION(5) Reported an invalid operation. Doesn't say much. does it? Well, it means that something really bad is going on and I for one, do not know what it is.- See Also:
- Constant Field Values
-
INCORRECT_SERVER_PARAMS
public static final int INCORRECT_SERVER_PARAMS
INCORRECT_SERVER_PARAMS(6) Incorrect server parameters passed in the configuration file. Typically, each server specified must have a server_id, server_name and server_type. If either of these values are null, an instance of LDAPServiceException is thrown with this error code set.- See Also:
- Constant Field Values
-
INCORRECT_LDAP_PARAMS
public static final int INCORRECT_LDAP_PARAMS
INCORRECT_LDAP_PARAMS(7) If the server_type is given as LDAP, then one or more of the ldap parameters are not correct. The possibilities are: 1. The sever_port, auth_id or auth_passwd any one of them are null. 2. Port number is not an integer value or it is not in the range of 0 and 65535.- See Also:
- Constant Field Values
-
INCORRECT_CP_PARAMS
public static final int INCORRECT_CP_PARAMS
INCORRECT_CP_PARAMS(8) One or more connection pool parameters incorrect. The possibilities are: 1. The init_conn_pool_length or max_conn_pool_length or conn_pool_load_factor are not integers or are less than or equal to zero. 2. The max_conn_pool_length is less than init_conn_pool_length.- See Also:
- Constant Field Values
-
INCORRECT_LDAP_REBIND_PARAMS
public static final int INCORRECT_LDAP_REBIND_PARAMS
INCORRECT_LDAP_REBIND_PARAMS(9) The rebind parameters specified are not correct. That is the rebind_id is specified, but rebind_passwd is not specified. The rebind_passwd, if rebind_id is specified, at the least must be "".- See Also:
- Constant Field Values
-
MUST_HAVE_SERVICE_NAME
public static final int MUST_HAVE_SERVICE_NAME
MUST_HAVE_SERVICE_NAME(10) Simple, the any ips_core:service specified in the xml must have a name.- See Also:
- Constant Field Values
-
FILTER_IS_REQD
public static final int FILTER_IS_REQD
FILTER_IS_REQUIRED(11) For a search operation, filter is required.- See Also:
- Constant Field Values
-
INVALID_SEARCH_CONSTRAINTS
public static final int INVALID_SEARCH_CONSTRAINTS
INVALID_SEARCH_CONSTRAINTS(12) If the constraints specified are not comprehendable, then this error is returned. I'll try to keep this list updated. The possibilities are: 1. The attribute list is not specified in a String[].- See Also:
- Constant Field Values
-
SERVICE_NOT_PRESENT
public static final int SERVICE_NOT_PRESENT
SERVICE_NOT_FOUND(13) When called DataAccessProvider.getConnection(String), it tries to look for the type of service it is given to provide. If no such service exits, the server returns with this exception code.- See Also:
- Constant Field Values
-
NO_COMMON_SERVICE_SPECIFIED
public static final int NO_COMMON_SERVICE_SPECIFIED
NO_DEFAULT_SERVICE_SPECIFIED(14) It could happen if you call DataAccessProvider.getConnection() and there was no "common" service defined in the serverconfig.xml. That's when this exception code gets returned.- See Also:
- Constant Field Values
-
SERVER_NOT_PRESENT
public static final int SERVER_NOT_PRESENT
SERVER_NOT_PRESENT(15) If you call getConnection, with or without the service name and there is no Server specified for that service, this exception gets thrown.- See Also:
- Constant Field Values
-
INVALID_ENTRY_ID
public static final int INVALID_ENTRY_ID
INVALID_ENTRY_ID(16) Typically, if an invalid ID is passed to Entry's constructor, this error is thrown.- See Also:
- Constant Field Values
-
INCOMPATIBLE_DB_TYPE
public static final int INCOMPATIBLE_DB_TYPE
INCOMPATIBLE_DB_TYPE(17) E.g. If a function takes Connector as a parameter, it may implicitly expect LDAPConnector, if the current scope of the object is LDAP specific. In such case, if another derivation of Connector is passed, this exception will be thrown.- See Also:
- Constant Field Values
-
CACHE_OP_NOT_SUPPORTED
public static final int CACHE_OP_NOT_SUPPORTED
CACHE_OP_NOT_PERMITTED(18) If the particular server does not support entry change notifications, the setupCache will return this exception.- See Also:
- Constant Field Values
-
FILE_NOT_FOUND
public static final int FILE_NOT_FOUND
FILE_NOT_FOUND(19) This exception is thrown if ADAL tries to open a file and get a java.io.FileNotFoundException- See Also:
- Constant Field Values
-
UNKNOWN_ERROR
public static final int UNKNOWN_ERROR
UNKNOWN_ERROR(20) This error is thrown when ADAL does not know what on earth happened. e.g. WebTopParser throws and Exception object, which is so generic that we don't know what to do with it.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LDAPServiceException
public LDAPServiceException(int code)
Constructor- Parameters:
code- The error code that represents the error that occurred while performing an operation.
-
LDAPServiceException
public LDAPServiceException(int code, String errormsg)The constructor.- Parameters:
code- The error code that represents the error that occurred while performing an operation.errormsg- A string description of the error that occurred.
-
LDAPServiceException
public LDAPServiceException(String errormsg)
The constructor.- Parameters:
errormsg- A string description of the error that occurred.
-
LDAPServiceException
public LDAPServiceException(int code, Throwable t)- Parameters:
code- The type of error that occurredt- The original exception that triggered the error
-
-
Method Detail
-
getMessage
public String getMessage()
- Overrides:
getMessagein classThrowable
-
-