Class JDAPSearchResponse

java.lang.Object

netscape.ldap.client.opers.JDAPSearchResponse

All Implemented Interfaces:

JDAPProtocolOp

public class JDAPSearchResponse
extends Object
implements JDAPProtocolOp

This class implements the search response. This object is sent from the ldap server to the interface.

entry [APPLICATION 4] SEQUENCE {
  objectName LDAPDN,
  attributes SEQUENCE OF SEQUENCE {
    AttributeType,
    SET OF AttributeValue
  }
}

Note that the following is the LDAPv3 definition:

SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
  objectName LDAPDN,
  attributes PartialAttributeList
}
PartialAttributeList ::= SEQUENCE OF SEQUENCE {
  type AttributeDescription,
  vals SET OF AttributeValue
}

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected LDAPAttribute[]	m_attributes
protected BERElement	m_element
protected String	m_object_name	Internal variables

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
JDAPSearchResponse(BERElement element)	Constructs search response.

Method Summary

Modifier and Type	Method	Description
LDAPAttribute[]	getAttributes()	Retrieves attributes
BERElement	getBERElement()	Retrieves ber representation of the result.
String	getObjectName()	Retrieves object name
int	getType()	Retrieves the protocol operation type.
String	toString()	Retrieve the string representation.

Methods inherited from class Object

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

Field Details

m_object_name

protected String m_object_name

Internal variables

m_element

protected BERElement m_element

m_attributes

protected LDAPAttribute[] m_attributes

Constructor Details

JDAPSearchResponse

public JDAPSearchResponse(BERElement element)
                   throws IOException

Constructs search response.

Parameters:

element - ber element of search response

Throws:

IOException

Method Details

getBERElement

public BERElement getBERElement()

Retrieves ber representation of the result.

Specified by:

getBERElement in interface JDAPProtocolOp

Returns:

ber representation

getObjectName

public String getObjectName()

Retrieves object name

Returns:

object name

getAttributes

public LDAPAttribute[] getAttributes()

Retrieves attributes

Returns:

attributes

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 Object

Returns:

string representation