com.novell.nds.dirxml.ldap

Class GetDriverStatsRequest

java.lang.Object

com.novell.ldap.LDAPExtendedOperation

com.novell.nds.dirxml.ldap.GetDriverStatsRequest

All Implemented Interfaces:

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

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

Get an XML document describing the current cache statistics of a DirXML driver 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 rights to the DirXML-AccessConfigure attribute on the target DirXML-Driver object.

OID:

2.16.840.1.113719.1.14.100.19

Request data:

 ASN1OctetString     UTF-encoded DN of DirXML-Driver object
 ASN1Integer         timeout value in minutes for result data (0-10 are legal values)
 ASN1Integer         (Optional)Type of Cache(DxConst.TYPE_NORMAL_CACHE or DxConst.TYPE_PRIORITY_CACHE)
 

Notes:

Returned data is an XML document.

Cache type is an optional parameter for normal cache. To get the statistics of priority cache, it should be set to DxConst.TYPE_PRIORITY_CACHE.

See Also:

GetDriverStatsResponse, GetChunkedResultRequest, CloseChunkedResultRequest, LDAPConnection.extendedOperation(com.novell.ldap.LDAPExtendedOperation), DxConst.TYPE_NORMAL_CACHE, DxConst.TYPE_PRIORITY_CACHE, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDriverStatsRequest(java.lang.String dn, int timeout) Construct an LDAP extended operation to get the current statistics document for a DirXML driver on a server.
GetDriverStatsRequest(java.lang.String dn, int timeout, int cacheType) Construct an LDAP extended operation to get the current statistics document for a DirXML driver on a server based in cache type.

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

GetDriverStatsRequest

public GetDriverStatsRequest(java.lang.String dn,
                             int timeout)
                      throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to get the current statistics document for a DirXML driver on a server.

Parameters:

dn - DN of a DirXML-Driver object

timeout - result data timeout in minutes (0-10, not range checked)

Throws:

com.novell.ldap.LDAPException

GetDriverStatsRequest

public GetDriverStatsRequest(java.lang.String dn,
                             int timeout,
                             int cacheType)
                      throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to get the current statistics document for a DirXML driver on a server based in cache type.

Parameters:

dn - DN of a DirXML-Driver object

timeout - result data timeout in minutes (0-10, not range checked)

cacheType - Cache type value (DxConst.TYPE_NORMAL_CACHE, DxConst.TYPE_PRIORITY_CACHE)

Throws:

com.novell.ldap.LDAPException

See Also:

DxConst.TYPE_NORMAL_CACHE, DxConst.TYPE_PRIORITY_CACHE

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