com.novell.nds.dirxml.ldap
Class ViewCacheEntriesRequest
java.lang.Object
com.novell.ldap.LDAPExtendedOperation
com.novell.nds.dirxml.ldap.DirXMLRequest
com.novell.nds.dirxml.ldap.ViewCacheEntriesRequest
- All Implemented Interfaces:
- Cloneable, ExtendedRequest, Externalizable, Serializable
- public class ViewCacheEntriesRequest
- extends com.novell.nds.dirxml.ldap.DirXMLRequest
- implements ExtendedRequest
View event records in the cache of a DirXML-Driver object on a server.
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:
- Read access to the DirXML-AccessManage attribute on the target DirXML-Driver object.
- OID:
- 2.16.840.1.113719.1.14.100.41
- Request data:
-
ASN1OctetString UTF-8 encoded DN of DirXML-Driver object
ASN1Integer timeout value for server-hosted result data (0-10 minutes)
ASN1Integer starting position token (0, or the result from a previous request)
ASN1Integer maximum count of events to retrieve (1 to 0xffffffff)
- Notes:
- The position token must be either zero, or a value returned from a previous request.
The position token represents the starting position in the cache from which to read event records.
- The driver must not be disabled, and driver must not be running.
- See Also:
ViewCacheEntriesResponse
,
GetChunkedResultRequest
,
CloseChunkedResultRequest
,
LDAPConnection.extendedOperation(com.novell.ldap.LDAPExtendedOperation)
,
Serialized Form
Constructor Summary |
ViewCacheEntriesRequest(String driverDN,
int timeout,
int position,
int count)
Construct an LDAP extended operation to view entries in a DirXML driver's cache. |
ViewCacheEntriesRequest
public ViewCacheEntriesRequest(String driverDN,
int timeout,
int position,
int count)
throws LDAPException
- Construct an LDAP extended operation to view entries in a DirXML driver's cache.
- Parameters:
driverDN
- the DN of the DirXML-Driver objecttimeout
- (0-10 minutes, not range checked)position
- starting position token (0, or result from a previous request)count
- maximum count of events to retrieve (1 to 0xffffffff, not range checked)
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 dataoffset
- offset into berValue
length
- length (in bytes) of reponse data
- Throws:
NamingException