netscape.ldap.client.opers

Class JDAPResult

Known Direct 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

static int
ADMIN_LIMIT_EXCEEDED
static int
AFFECTS_MULTIPLE_DSAS
static int
ALIAS_DEREFERENCING_PROBLEM
static int
ALIAS_PROBLEM
static int
ATTRIBUTE_OR_VALUE_EXISTS
static int
AUTH_METHOD_NOT_SUPPORTED
static int
BUSY
static int
CLIENT_LOOP
static int
COMPARE_FALSE
static int
COMPARE_TRUE
static int
CONFIDENTIALITY_REQUIRED
static int
CONNECT_ERROR
static int
CONSTRAINT_VIOLATION
static int
CONTROL_NOT_FOUND
static int
ENTRY_ALREADY_EXISTS
static int
INAPPROPRIATE_AUTHENTICATION
static int
INAPPROPRIATE_MATCHING
static int
INSUFFICIENT_ACCESS_RIGHTS
static int
INVALID_ATTRIBUTE_SYNTAX
static int
INVALID_CREDENTIALS
static int
INVALID_DN_SYNTAX
static int
IS_LEAF
static int
LDAP_NOT_SUPPORTED
static int
LDAP_PARTIAL_RESULTS
static int
LOOP_DETECT
static int
MORE_RESULTS_TO_RETURN
static int
NAMING_VIOLATION
static int
NOT_ALLOWED_ON_NONLEAF
static int
NOT_ALLOWED_ON_RDN
static int
NO_RESULTS_RETURNED
static int
NO_SUCH_ATTRIBUTE
static int
NO_SUCH_OBJECT
static int
OBJECT_CLASS_MODS_PROHIBITED
static int
OBJECT_CLASS_VIOLATION
static int
OPERATION_ERROR
static int
OTHER
static int
PARAM_ERROR
static int
PROTOCOL_ERROR
static int
REFERRAL
static int
REFERRAL_LIMIT_EXCEEDED
static int
SASL_BIND_IN_PROGRESS
static int
SERVER_DOWN
static int
SIZE_LIMIT_EXCEEDED
static int
STRONG_AUTH_REQUIRED
static int
SUCCESS
Result code based on RFC1777
static int
TIME_LIMIT_EXCEEDED
static int
UNAVAILABLE
static int
UNAVAILABLE_CRITICAL_EXTENSION
static int
UNDEFINED_ATTRIBUTE_TYPE
static int
UNWILLING_TO_PERFORM
protected BERElement
m_element
Private variable
protected String
m_error_message
protected String
m_matched_dn
protected String[]
m_referrals
protected int
m_result_code

Constructor Summary

JDAPResult(BERElement element)
Constructs ldap result.

Method Summary

BERElement
getBERElement()
Retrieves the ber representation of the result.
String
getErrorMessage()
Gets the error message.
String
getMatchedDN()
Gets the matched dn.
String
getParamString()
Retrieves string representation of the result.
String[]
getReferrals()
Retrieves referrals from the LDAP Result.
int
getResultCode()
Gets the result code.
String
toString()
Retrieves string representation of the result.

Field Details

ADMIN_LIMIT_EXCEEDED

public static final int ADMIN_LIMIT_EXCEEDED
Field Value:
11

AFFECTS_MULTIPLE_DSAS

public static final int AFFECTS_MULTIPLE_DSAS
Field Value:
71

ALIAS_DEREFERENCING_PROBLEM

public static final int ALIAS_DEREFERENCING_PROBLEM
Field Value:
36

ALIAS_PROBLEM

public static final int ALIAS_PROBLEM
Field Value:
33

ATTRIBUTE_OR_VALUE_EXISTS

public static final int ATTRIBUTE_OR_VALUE_EXISTS
Field Value:
20

AUTH_METHOD_NOT_SUPPORTED

public static final int AUTH_METHOD_NOT_SUPPORTED
Field Value:
7

BUSY

public static final int BUSY
Field Value:
51

CLIENT_LOOP

public static final int CLIENT_LOOP
Field Value:
96

COMPARE_FALSE

public static final int COMPARE_FALSE
Field Value:
5

COMPARE_TRUE

public static final int COMPARE_TRUE
Field Value:
6

CONFIDENTIALITY_REQUIRED

public static final int CONFIDENTIALITY_REQUIRED
Field Value:
13

CONNECT_ERROR

public static final int CONNECT_ERROR
Field Value:
91

CONSTRAINT_VIOLATION

public static final int CONSTRAINT_VIOLATION
Field Value:
19

CONTROL_NOT_FOUND

public static final int CONTROL_NOT_FOUND
Field Value:
93

ENTRY_ALREADY_EXISTS

public static final int ENTRY_ALREADY_EXISTS
Field Value:
68

INAPPROPRIATE_AUTHENTICATION

public static final int INAPPROPRIATE_AUTHENTICATION
Field Value:
48

INAPPROPRIATE_MATCHING

public static final int INAPPROPRIATE_MATCHING
Field Value:
18

INSUFFICIENT_ACCESS_RIGHTS

public static final int INSUFFICIENT_ACCESS_RIGHTS
Field Value:
50

INVALID_ATTRIBUTE_SYNTAX

public static final int INVALID_ATTRIBUTE_SYNTAX
Field Value:
21

INVALID_CREDENTIALS

public static final int INVALID_CREDENTIALS
Field Value:
49

INVALID_DN_SYNTAX

public static final int INVALID_DN_SYNTAX
Field Value:
34

IS_LEAF

public static final int IS_LEAF
Field Value:
35

LDAP_NOT_SUPPORTED

public static final int LDAP_NOT_SUPPORTED
Field Value:
92

LDAP_PARTIAL_RESULTS

public static final int LDAP_PARTIAL_RESULTS
Field Value:
9

LOOP_DETECT

public static final int LOOP_DETECT
Field Value:
54

MORE_RESULTS_TO_RETURN

public static final int MORE_RESULTS_TO_RETURN
Field Value:
95

NAMING_VIOLATION

public static final int NAMING_VIOLATION
Field Value:
64

NOT_ALLOWED_ON_NONLEAF

public static final int NOT_ALLOWED_ON_NONLEAF
Field Value:
66

NOT_ALLOWED_ON_RDN

public static final int NOT_ALLOWED_ON_RDN
Field Value:
67

NO_RESULTS_RETURNED

public static final int NO_RESULTS_RETURNED
Field Value:
94

NO_SUCH_ATTRIBUTE

public static final int NO_SUCH_ATTRIBUTE
Field Value:
16

NO_SUCH_OBJECT

public static final int NO_SUCH_OBJECT
Field Value:
32

OBJECT_CLASS_MODS_PROHIBITED

public static final int OBJECT_CLASS_MODS_PROHIBITED
Field Value:
69

OBJECT_CLASS_VIOLATION

public static final int OBJECT_CLASS_VIOLATION
Field Value:
65

OPERATION_ERROR

public static final int OPERATION_ERROR
Field Value:
1

OTHER

public static final int OTHER
Field Value:
80

PARAM_ERROR

public static final int PARAM_ERROR
Field Value:
89

PROTOCOL_ERROR

public static final int PROTOCOL_ERROR
Field Value:
2

REFERRAL

public static final int REFERRAL
Field Value:
10

REFERRAL_LIMIT_EXCEEDED

public static final int REFERRAL_LIMIT_EXCEEDED
Field Value:
97

SASL_BIND_IN_PROGRESS

public static final int SASL_BIND_IN_PROGRESS
Field Value:
14

SERVER_DOWN

public static final int SERVER_DOWN
Field Value:
81

SIZE_LIMIT_EXCEEDED

public static final int SIZE_LIMIT_EXCEEDED
Field Value:
4

STRONG_AUTH_REQUIRED

public static final int STRONG_AUTH_REQUIRED
Field Value:
8

SUCCESS

public static final int SUCCESS
Result code based on RFC1777
Field Value:
0

TIME_LIMIT_EXCEEDED

public static final int TIME_LIMIT_EXCEEDED
Field Value:
3

UNAVAILABLE

public static final int UNAVAILABLE
Field Value:
52

UNAVAILABLE_CRITICAL_EXTENSION

public static final int UNAVAILABLE_CRITICAL_EXTENSION
Field Value:
12

UNDEFINED_ATTRIBUTE_TYPE

public static final int UNDEFINED_ATTRIBUTE_TYPE
Field Value:
17

UNWILLING_TO_PERFORM

public static final int UNWILLING_TO_PERFORM
Field Value:
53

m_element

protected BERElement m_element
Private variable

m_error_message

protected String m_error_message

m_matched_dn

protected String m_matched_dn

m_referrals

protected String[] m_referrals

m_result_code

protected int m_result_code

Constructor Details

JDAPResult

public JDAPResult(BERElement element)
            throws IOException
Constructs ldap result.
Parameters:
element - ber element

Method Details

getBERElement

public BERElement getBERElement()
Retrieves the ber representation of the result.
Returns:
ber representation of the result

getErrorMessage

public String getErrorMessage()
Gets the error message.
Returns:
error message

getMatchedDN

public String getMatchedDN()
Gets the matched dn.
Returns:
matched dn

getParamString

public String getParamString()
Retrieves string representation of the result. Usually, the inherited class calls this to retrieve the parameter string.
Returns:
string representation

getReferrals

public String[] getReferrals()
Retrieves referrals from the LDAP Result.
Returns:
list of referrals in URL format

getResultCode

public int getResultCode()
Gets the result code.
Returns:
result code

toString

public String toString()
Retrieves string representation of the result.
Returns:
string representation