com.novell.nds.dirxml.ldap
Class ViewCacheEntriesResponse

java.lang.Object
  com.novell.ldap.LDAPMessage
      com.novell.ldap.LDAPResponse
          com.novell.ldap.LDAPExtendedResponse
              com.novell.nds.dirxml.ldap.ChunkedResultResponseBase
                  com.novell.nds.dirxml.ldap.ViewCacheEntriesResponse

All Implemented Interfaces:

Externalizable, Serializable, ExtendedResponse

public class ViewCacheEntriesResponse
extends ChunkedResultResponseBase

The response class for the ViewCacheEntriesRequest operation.

If this class is registered via LDAPExtendedResponse.register then the return from the LDAPConnection.extendedOperation call will be an instance of this class. Call this class's register method or call DirXMLExtensions.initialize to register all DirXML LDAP extension response classes.

OID:

2.16.840.1.113719.1.14.100.42

Response data:

 ASN1Sequence
      ASN1Integer     data handle
      ASN1Integer     data total size
      ASN1Integer     new position token
 

See Also:

ViewCacheEntriesRequest, GetChunkedResultRequest, CloseChunkedResultRequest, DirXMLExtensions.initialize(), Serialized Form

Field Summary

Fields inherited from class com.novell.ldap.LDAPMessage

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

Constructor Summary

ViewCacheEntriesResponse(byte[] berData, int offset, int length)
Constructor used to create the JNDI ExtendedResponse implementation.

ViewCacheEntriesResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
Constructor used by response factory to create an instance of this class based on a response message.

Method Summary

byte[]	getEncodedValue()
int	getPositionToken() Return the position token that results from a ViewCacheEntriesRequest LDAP extended operation.
static void	register() Register this class with LDAPExtendedResponse.register for automatic construction of this class as a result of LDAPConnection.extendedOperation.

Methods inherited from class com.novell.nds.dirxml.ldap.ChunkedResultResponseBase

getDataHandle, getDataSize

Methods inherited from class com.novell.ldap.LDAPExtendedResponse

getID, getRegisteredResponses, getValue, register, setDeserializedValues

Methods inherited from class com.novell.ldap.LDAPResponse

chkResultCode, getControls, getErrorMessage, getMatchedDN, getMessageID, getReferrals, getResultCode, getType

Methods inherited from class com.novell.ldap.LDAPMessage

getTag, isRequest, readDSML, readExternal, setTag, toString, writeDSML, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.naming.ldap.ExtendedResponse

getID

Constructor Detail

ViewCacheEntriesResponse

public ViewCacheEntriesResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)

Constructor used by response factory to create an instance of this class based on a response message.

Parameters:

rfcMessage - message containing response data

ViewCacheEntriesResponse

public ViewCacheEntriesResponse(byte[] berData,
                                int offset,
                                int length)

Constructor used to create the JNDI ExtendedResponse implementation.

Parameters:

berData - LBER-encoded response data

offset - offset of start of response data in berData parameter

length - length of response data

Method Detail

getPositionToken

public int getPositionToken()

Return the position token that results from a ViewCacheEntriesRequest LDAP extended operation.

The position token can be used in subsequent ViewCacheEntriesRequest operations or DeleteCacheEntriesRequest operations.

Returns:

position token

register

public static void register()
                     throws ClassNotFoundException

Register this class with LDAPExtendedResponse.register for automatic construction of this class as a result of LDAPConnection.extendedOperation.

Throws:

ClassNotFoundException - thrown if the java.lang.Class object for this class cannot be obtained.

getEncodedValue

public byte[] getEncodedValue()

Specified by:

getEncodedValue in interface ExtendedResponse