netscape.ldap.client.opers
Class JDAPSearchResponse

java.lang.Object
  extended bynetscape.ldap.client.opers.JDAPSearchResponse
All Implemented Interfaces:
JDAPProtocolOp

public class JDAPSearchResponse
extends java.lang.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
protected  LDAPAttribute[] m_attributes
           
protected  BERElement m_element
           
protected  java.lang.String m_object_name
          Internal variables
 
Fields inherited from interface netscape.ldap.client.opers.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
 
Constructor Summary
JDAPSearchResponse(BERElement element)
          Constructs search response.
 
Method Summary
 LDAPAttribute[] getAttributes()
          Retrieves attributes
 BERElement getBERElement()
          Retrieves ber representation of the result.
 java.lang.String getObjectName()
          Retrieves object name
 int getType()
          Retrieves the protocol operation type.
 java.lang.String toString()
          Retrieve the string representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_object_name

protected java.lang.String m_object_name
Internal variables


m_element

protected BERElement m_element

m_attributes

protected LDAPAttribute[] m_attributes
Constructor Detail

JDAPSearchResponse

public JDAPSearchResponse(BERElement element)
                   throws java.io.IOException
Constructs search response.

Parameters:
element - ber element of search response
Method Detail

getBERElement

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

Specified by:
getBERElement in interface JDAPProtocolOp
Returns:
ber representation

getObjectName

public java.lang.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 java.lang.String toString()
Retrieve the string representation.

Specified by:
toString in interface JDAPProtocolOp
Returns:
string representation