Class JDAPSearchResult

java.lang.Object

netscape.ldap.client.opers.JDAPResult

netscape.ldap.client.opers.JDAPSearchResult

All Implemented Interfaces:

JDAPProtocolOp

public class JDAPSearchResult
extends JDAPResult
implements JDAPProtocolOp

This class implements the search result. This object is sent from the ldap server to the interface. Note that search response is separated into search response and search result. The search response contains the result from the server, while the research result indicates the end of the search response sequence.

resultCode [APPLICATION 5] LDAPResult

Version:

1.0

Field Summary

Fields inherited from class JDAPResult

ADMIN_LIMIT_EXCEEDED, AFFECTS_MULTIPLE_DSAS, ALIAS_DEREFERENCING_PROBLEM, ALIAS_PROBLEM, ATTRIBUTE_OR_VALUE_EXISTS, AUTH_METHOD_NOT_SUPPORTED, BUSY, CLIENT_LOOP, COMPARE_FALSE, COMPARE_TRUE, CONFIDENTIALITY_REQUIRED, CONNECT_ERROR, CONSTRAINT_VIOLATION, CONTROL_NOT_FOUND, ENTRY_ALREADY_EXISTS, INAPPROPRIATE_AUTHENTICATION, INAPPROPRIATE_MATCHING, INSUFFICIENT_ACCESS_RIGHTS, INVALID_ATTRIBUTE_SYNTAX, INVALID_CREDENTIALS, INVALID_DN_SYNTAX, IS_LEAF, LDAP_NOT_SUPPORTED, LDAP_PARTIAL_RESULTS, LOOP_DETECT, m_element, m_error_message, m_matched_dn, m_referrals, m_result_code, MORE_RESULTS_TO_RETURN, NAMING_VIOLATION, NO_RESULTS_RETURNED, NO_SUCH_ATTRIBUTE, NO_SUCH_OBJECT, NOT_ALLOWED_ON_NONLEAF, NOT_ALLOWED_ON_RDN, OBJECT_CLASS_MODS_PROHIBITED, OBJECT_CLASS_VIOLATION, OPERATION_ERROR, OTHER, PARAM_ERROR, PROTOCOL_ERROR, REFERRAL, REFERRAL_LIMIT_EXCEEDED, SASL_BIND_IN_PROGRESS, SERVER_DOWN, SIZE_LIMIT_EXCEEDED, STRONG_AUTH_REQUIRED, SUCCESS, TIME_LIMIT_EXCEEDED, UNAVAILABLE, UNAVAILABLE_CRITICAL_EXTENSION, UNDEFINED_ATTRIBUTE_TYPE, UNWILLING_TO_PERFORM

Modifier and Type	Field	Description
static final int	ADMIN_LIMIT_EXCEEDED
static final int	AFFECTS_MULTIPLE_DSAS
static final int	ALIAS_DEREFERENCING_PROBLEM
static final int	ALIAS_PROBLEM
static final int	ATTRIBUTE_OR_VALUE_EXISTS
static final int	AUTH_METHOD_NOT_SUPPORTED
static final int	BUSY
static final int	CLIENT_LOOP
static final int	COMPARE_FALSE
static final int	COMPARE_TRUE
static final int	CONFIDENTIALITY_REQUIRED
static final int	CONNECT_ERROR
static final int	CONSTRAINT_VIOLATION
static final int	CONTROL_NOT_FOUND
static final int	ENTRY_ALREADY_EXISTS
static final int	INAPPROPRIATE_AUTHENTICATION
static final int	INAPPROPRIATE_MATCHING
static final int	INSUFFICIENT_ACCESS_RIGHTS
static final int	INVALID_ATTRIBUTE_SYNTAX
static final int	INVALID_CREDENTIALS
static final int	INVALID_DN_SYNTAX
static final int	IS_LEAF
static final int	LDAP_NOT_SUPPORTED
static final int	LDAP_PARTIAL_RESULTS
static final int	LOOP_DETECT
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
static final int	MORE_RESULTS_TO_RETURN
static final int	NAMING_VIOLATION
static final int	NO_RESULTS_RETURNED
static final int	NO_SUCH_ATTRIBUTE
static final int	NO_SUCH_OBJECT
static final int	NOT_ALLOWED_ON_NONLEAF
static final int	NOT_ALLOWED_ON_RDN
static final int	OBJECT_CLASS_MODS_PROHIBITED
static final int	OBJECT_CLASS_VIOLATION
static final int	OPERATION_ERROR
static final int	OTHER
static final int	PARAM_ERROR
static final int	PROTOCOL_ERROR
static final int	REFERRAL
static final int	REFERRAL_LIMIT_EXCEEDED
static final int	SASL_BIND_IN_PROGRESS
static final int	SERVER_DOWN
static final int	SIZE_LIMIT_EXCEEDED
static final int	STRONG_AUTH_REQUIRED
static final int	SUCCESS	Result code based on RFC1777
static final int	TIME_LIMIT_EXCEEDED
static final int	UNAVAILABLE
static final int	UNAVAILABLE_CRITICAL_EXTENSION
static final int	UNDEFINED_ATTRIBUTE_TYPE
static final int	UNWILLING_TO_PERFORM

Fields inherited from interface JDAPProtocolOp

ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST

Modifier and Type	Field	Description
static final int	ABANDON_REQUEST
static final int	ADD_REQUEST
static final int	ADD_RESPONSE
static final int	BIND_REQUEST	Protocol operation types
static final int	BIND_RESPONSE
static final int	COMPARE_REQUEST
static final int	COMPARE_RESPONSE
static final int	DEL_REQUEST
static final int	DEL_RESPONSE
static final int	EXTENDED_REQUEST
static final int	EXTENDED_RESPONSE
static final int	MODIFY_RDN_REQUEST
static final int	MODIFY_RDN_RESPONSE
static final int	MODIFY_REQUEST
static final int	MODIFY_RESPONSE
static final int	SEARCH_REQUEST
static final int	SEARCH_RESPONSE
static final int	SEARCH_RESULT
static final int	SEARCH_RESULT_REFERENCE
static final int	UNBIND_REQUEST

Constructor Summary

Constructors

Constructor	Description
JDAPSearchResult(BERElement element)	Constructs search result.

Method Summary

Modifier and Type	Method	Description
int	getType()	Retrieves the protocol operation type.
String	toString()	Retrieve the string representation.

Methods inherited from class JDAPResult

getBERElement, getErrorMessage, getMatchedDN, getParamString, getReferrals, getResultCode

Modifier and Type	Method	Description
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface JDAPProtocolOp

getBERElement

Modifier and Type	Method	Description
BERElement	getBERElement()	Retrieves the ber representation of the operation.

Constructor Details

JDAPSearchResult

public JDAPSearchResult(BERElement element)
                 throws IOException

Constructs search result.

Parameters:

element - ber element of search result

Throws:

IOException

Method Details

getType

public int getType()

Retrieves the protocol operation type.

Specified by:

getType in interface JDAPProtocolOp

Returns:

protocol type

toString

public String toString()

Retrieve the string representation.

Specified by:

toString in interface JDAPProtocolOp

Overrides:

toString in class JDAPResult

Returns:

string representation