com.novell.nds.dirxml.ldap
Class CloseChunkedResultRequest

java.lang.Object
  com.novell.ldap.LDAPExtendedOperation
      com.novell.nds.dirxml.ldap.DirXMLRequest
          com.novell.nds.dirxml.ldap.CloseChunkedResultRequest

All Implemented Interfaces:

Cloneable, ExtendedRequest, Externalizable, Serializable

public class CloseChunkedResultRequest

extends com.novell.nds.dirxml.ldap.DirXMLRequest

implements ExtendedRequest

Clean up any resources associated with a large result that is created in response to another data request.

To use this class with the Novell Java LDAP SDK create an instance and call LDAPConnection.extendedOperation with the instance as the LDAPExtendedOperation parameter.

To use this class with Java LDAP JNDI create an instance and call LdapContext.extendedOperation with the instance as the ExtendedRequest parameter.

Rights needed:

The same rights that were needed for the request that generated the results.

OID:

2.16.840.1.113719.1.14.100.35

Request data:

 ASN1Integer     data handle
 

Notes:

The "data handle" is that returned by the request that generated the results.

See Also:

SubmitCommandRequest, SubmitEventRequest, GetChunkedResultRequest, DiscoverJobsRequest, LDAPConnection.extendedOperation(com.novell.ldap.LDAPExtendedOperation), Serialized Form

Constructor Summary

CloseChunkedResultRequest(int dataHandle)
Construct an LDAP extended operation to clean up server resources associated with a large set of data that results from another request.

Method Summary

ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length) Create the ExtendedResponse-implementing object that corresponds to this request.
byte[]	getEncodedValue() Return the LBER-encoded data for this request.

Methods inherited from class com.novell.ldap.LDAPExtendedOperation

clone, getID, getValue, readDSML, readExternal, setID, setValue, toString, writeDSML, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.naming.ldap.ExtendedRequest

createExtendedResponse, getEncodedValue, getID

Constructor Detail

CloseChunkedResultRequest

public CloseChunkedResultRequest(int dataHandle)
                          throws LDAPException

Construct an LDAP extended operation to clean up server resources associated with a large set of data that results from another request.

Parameters:

dataHandle - handle returned from DirXML LDAP extended operation that returns large results

Method Detail

getEncodedValue

public byte[] getEncodedValue()

Return the LBER-encoded data for this request. This is an implementation method for the JNDI ExtendedRequest interface.

Specified by:

getEncodedValue in interface ExtendedRequest

Returns:

LBER-encoded data or null, if there is no request data.

createExtendedResponse

public ExtendedResponse createExtendedResponse(String id,
                                               byte[] berValue,
                                               int offset,
                                               int length)
                                        throws NamingException

Create the ExtendedResponse-implementing object that corresponds to this request. This is an implementation method for the JNDI ExtendedRequest interface.

Specified by:

createExtendedResponse in interface ExtendedRequest

Parameters:

id - (ignored)

berValue - contains LBER-encoded response data

offset - offset into berValue

length - length (in bytes) of reponse data

Throws:

NamingException