Package netscape.ldap.client.opers
Class JDAPResult
- java.lang.Object
-
- netscape.ldap.client.opers.JDAPResult
-
- Direct Known Subclasses:
JDAPAddResponse
,JDAPBindResponse
,JDAPCompareResponse
,JDAPDeleteResponse
,JDAPExtendedResponse
,JDAPModifyRDNResponse
,JDAPModifyResponse
,JDAPSearchResult
public class JDAPResult extends java.lang.Object
This class implements the ldap result where stores the request status. It is the base class for all the response except search response. This object is sent from the server to the client interface.LDAPResult ::= SEQUENCE { resultCode ENUMERATED { success (0), ... }, matchedDN LDAPDN, errorMessage LDAPString }
Note that LDAPv3 supports referral within the LDAP Result. The added component is:LDAPResult ::= SEQUENCE { ... errorMessage LDAPString, referral [3] Referral OPTIONAL }
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description JDAPResult(BERElement element)
Constructs ldap result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BERElement
getBERElement()
Retrieves the ber representation of the result.java.lang.String
getErrorMessage()
Gets the error message.java.lang.String
getMatchedDN()
Gets the matched dn.java.lang.String
getParamString()
Retrieves string representation of the result.java.lang.String[]
getReferrals()
Retrieves referrals from the LDAP Result.int
getResultCode()
Gets the result code.java.lang.String
toString()
Retrieves string representation of the result.
-
-
-
Field Detail
-
SUCCESS
public static final int SUCCESS
Result code based on RFC1777- See Also:
- Constant Field Values
-
OPERATION_ERROR
public static final int OPERATION_ERROR
- See Also:
- Constant Field Values
-
PROTOCOL_ERROR
public static final int PROTOCOL_ERROR
- See Also:
- Constant Field Values
-
TIME_LIMIT_EXCEEDED
public static final int TIME_LIMIT_EXCEEDED
- See Also:
- Constant Field Values
-
SIZE_LIMIT_EXCEEDED
public static final int SIZE_LIMIT_EXCEEDED
- See Also:
- Constant Field Values
-
COMPARE_FALSE
public static final int COMPARE_FALSE
- See Also:
- Constant Field Values
-
COMPARE_TRUE
public static final int COMPARE_TRUE
- See Also:
- Constant Field Values
-
AUTH_METHOD_NOT_SUPPORTED
public static final int AUTH_METHOD_NOT_SUPPORTED
- See Also:
- Constant Field Values
-
STRONG_AUTH_REQUIRED
public static final int STRONG_AUTH_REQUIRED
- See Also:
- Constant Field Values
-
LDAP_PARTIAL_RESULTS
public static final int LDAP_PARTIAL_RESULTS
- See Also:
- Constant Field Values
-
REFERRAL
public static final int REFERRAL
- See Also:
- Constant Field Values
-
ADMIN_LIMIT_EXCEEDED
public static final int ADMIN_LIMIT_EXCEEDED
- See Also:
- Constant Field Values
-
UNAVAILABLE_CRITICAL_EXTENSION
public static final int UNAVAILABLE_CRITICAL_EXTENSION
- See Also:
- Constant Field Values
-
CONFIDENTIALITY_REQUIRED
public static final int CONFIDENTIALITY_REQUIRED
- See Also:
- Constant Field Values
-
SASL_BIND_IN_PROGRESS
public static final int SASL_BIND_IN_PROGRESS
- See Also:
- Constant Field Values
-
NO_SUCH_ATTRIBUTE
public static final int NO_SUCH_ATTRIBUTE
- See Also:
- Constant Field Values
-
UNDEFINED_ATTRIBUTE_TYPE
public static final int UNDEFINED_ATTRIBUTE_TYPE
- See Also:
- Constant Field Values
-
INAPPROPRIATE_MATCHING
public static final int INAPPROPRIATE_MATCHING
- See Also:
- Constant Field Values
-
CONSTRAINT_VIOLATION
public static final int CONSTRAINT_VIOLATION
- See Also:
- Constant Field Values
-
ATTRIBUTE_OR_VALUE_EXISTS
public static final int ATTRIBUTE_OR_VALUE_EXISTS
- See Also:
- Constant Field Values
-
INVALID_ATTRIBUTE_SYNTAX
public static final int INVALID_ATTRIBUTE_SYNTAX
- See Also:
- Constant Field Values
-
NO_SUCH_OBJECT
public static final int NO_SUCH_OBJECT
- See Also:
- Constant Field Values
-
ALIAS_PROBLEM
public static final int ALIAS_PROBLEM
- See Also:
- Constant Field Values
-
INVALID_DN_SYNTAX
public static final int INVALID_DN_SYNTAX
- See Also:
- Constant Field Values
-
IS_LEAF
public static final int IS_LEAF
- See Also:
- Constant Field Values
-
ALIAS_DEREFERENCING_PROBLEM
public static final int ALIAS_DEREFERENCING_PROBLEM
- See Also:
- Constant Field Values
-
INAPPROPRIATE_AUTHENTICATION
public static final int INAPPROPRIATE_AUTHENTICATION
- See Also:
- Constant Field Values
-
INVALID_CREDENTIALS
public static final int INVALID_CREDENTIALS
- See Also:
- Constant Field Values
-
INSUFFICIENT_ACCESS_RIGHTS
public static final int INSUFFICIENT_ACCESS_RIGHTS
- See Also:
- Constant Field Values
-
BUSY
public static final int BUSY
- See Also:
- Constant Field Values
-
UNAVAILABLE
public static final int UNAVAILABLE
- See Also:
- Constant Field Values
-
UNWILLING_TO_PERFORM
public static final int UNWILLING_TO_PERFORM
- See Also:
- Constant Field Values
-
LOOP_DETECT
public static final int LOOP_DETECT
- See Also:
- Constant Field Values
-
NAMING_VIOLATION
public static final int NAMING_VIOLATION
- See Also:
- Constant Field Values
-
OBJECT_CLASS_VIOLATION
public static final int OBJECT_CLASS_VIOLATION
- See Also:
- Constant Field Values
-
NOT_ALLOWED_ON_NONLEAF
public static final int NOT_ALLOWED_ON_NONLEAF
- See Also:
- Constant Field Values
-
NOT_ALLOWED_ON_RDN
public static final int NOT_ALLOWED_ON_RDN
- See Also:
- Constant Field Values
-
ENTRY_ALREADY_EXISTS
public static final int ENTRY_ALREADY_EXISTS
- See Also:
- Constant Field Values
-
OBJECT_CLASS_MODS_PROHIBITED
public static final int OBJECT_CLASS_MODS_PROHIBITED
- See Also:
- Constant Field Values
-
AFFECTS_MULTIPLE_DSAS
public static final int AFFECTS_MULTIPLE_DSAS
- See Also:
- Constant Field Values
-
OTHER
public static final int OTHER
- See Also:
- Constant Field Values
-
SERVER_DOWN
public static final int SERVER_DOWN
- See Also:
- Constant Field Values
-
PARAM_ERROR
public static final int PARAM_ERROR
- See Also:
- Constant Field Values
-
CONNECT_ERROR
public static final int CONNECT_ERROR
- See Also:
- Constant Field Values
-
LDAP_NOT_SUPPORTED
public static final int LDAP_NOT_SUPPORTED
- See Also:
- Constant Field Values
-
CONTROL_NOT_FOUND
public static final int CONTROL_NOT_FOUND
- See Also:
- Constant Field Values
-
NO_RESULTS_RETURNED
public static final int NO_RESULTS_RETURNED
- See Also:
- Constant Field Values
-
MORE_RESULTS_TO_RETURN
public static final int MORE_RESULTS_TO_RETURN
- See Also:
- Constant Field Values
-
CLIENT_LOOP
public static final int CLIENT_LOOP
- See Also:
- Constant Field Values
-
REFERRAL_LIMIT_EXCEEDED
public static final int REFERRAL_LIMIT_EXCEEDED
- See Also:
- Constant Field Values
-
m_element
protected BERElement m_element
Private variable
-
m_result_code
protected int m_result_code
-
m_matched_dn
protected java.lang.String m_matched_dn
-
m_error_message
protected java.lang.String m_error_message
-
m_referrals
protected java.lang.String[] m_referrals
-
-
Constructor Detail
-
JDAPResult
public JDAPResult(BERElement element) throws java.io.IOException
Constructs ldap result.- Parameters:
element
- ber element- Throws:
java.io.IOException
-
-
Method Detail
-
getResultCode
public int getResultCode()
Gets the result code.- Returns:
- result code
-
getMatchedDN
public java.lang.String getMatchedDN()
Gets the matched dn.- Returns:
- matched dn
-
getErrorMessage
public java.lang.String getErrorMessage()
Gets the error message.- Returns:
- error message
-
getReferrals
public java.lang.String[] getReferrals()
Retrieves referrals from the LDAP Result.- Returns:
- list of referrals in URL format
-
getBERElement
public BERElement getBERElement()
Retrieves the ber representation of the result.- Returns:
- ber representation of the result
-
getParamString
public java.lang.String getParamString()
Retrieves string representation of the result. Usually, the inherited class calls this to retrieve the parameter string.- Returns:
- string representation
-
toString
public java.lang.String toString()
Retrieves string representation of the result.- Overrides:
toString
in classjava.lang.Object
- Returns:
- string representation
-
-