com.novell.nds.dirxml.ldap

Class GetChunkedResultRequest

java.lang.Object

com.novell.ldap.LDAPExtendedOperation

com.novell.nds.dirxml.ldap.GetChunkedResultRequest

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, javax.naming.ldap.ExtendedRequest

public class GetChunkedResultRequest
extends com.novell.ldap.LDAPExtendedOperation
implements javax.naming.ldap.ExtendedRequest

Get part of 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.

If the corresponding response class has been registered then the return from LDAPConnection.extendedOperation will be an instance of the response class.

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

The return from LdapContext.extendedOperation will be an instance of the response class.

Rights needed:

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

OID:

2.16.840.1.113719.1.14.100.33

Request data:

 ASN1Integer     data handle
 ASN1Integer     maximum data amount to return (64K is approximate maximum)
 ASN1Integer     additional timeout value in minutes for result data (0-10 are legal values)
 

Notes:

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

See Also:

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

Constructor Summary

Constructors

Constructor and Description
GetChunkedResultRequest(int dataHandle, int maxReturnSize, int additionalTimeout) Construct an LDAP extended operation to get part or all of a large set of data that results from another request.

Method Summary

Modifier and Type	Method and Description
javax.naming.ldap.ExtendedResponse	createExtendedResponse(java.lang.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

GetChunkedResultRequest

public GetChunkedResultRequest(int dataHandle,
                               int maxReturnSize,
                               int additionalTimeout)
                        throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to get part or all of a large set of data that results from another request.

Parameters:

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

maxReturnSize - maximum size of data chunk to return

additionalTimeout - additional timeout in minutes for server-hosted data (0-10, not range checked)

Throws:

com.novell.ldap.LDAPException

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 javax.naming.ldap.ExtendedRequest

Returns:

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

createExtendedResponse

public javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id,
                                                                 byte[] berValue,
                                                                 int offset,
                                                                 int length)
                                                          throws javax.naming.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 javax.naming.ldap.ExtendedRequest

Parameters:

id - (ignored)

berValue - contains LBER-encoded response data

offset - offset into berValue

length - length (in bytes) of reponse data

Throws:

javax.naming.NamingException