com.novell.nds.dirxml.ldap

Class GetCPRSDataRequest

java.lang.Object

com.novell.ldap.LDAPExtendedOperation

com.novell.nds.dirxml.ldap.GetCPRSDataRequest

All Implemented Interfaces:

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

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

Get the CPRS Data from the IDM 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-AccessConfigure attribute on the target NCP-Server object.

OID:

2.16.840.1.113719.1.14.100.111

Request data:

 ASN1OctetString     Request ID
 ASN1OctetString     Filter
 ASN1Integer         Start Index
 ASN1Integer         Size
 ASN1OctetString     Sort by
 ASN1Integer         version
 ASN1Integer         timeout value in minutes for result data (0-10 are legal values)
 

Notes:

Returns CPRS data.

See Also:

GetCPRSDataResponse, GetChunkedResultRequest, CloseChunkedResultRequest, LDAPConnection.extendedOperation(com.novell.ldap.LDAPExtendedOperation), Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetCPRSDataRequest(int version, java.lang.String requestID, int timeout)
GetCPRSDataRequest(int version, java.lang.String requestID, java.lang.String UUIDSequence, int timeout)
GetCPRSDataRequest(int version, java.lang.String requestID, java.lang.String filter, int startIndex, int size, java.lang.String sortBy, java.lang.String sortOrder, int timeout) Construct an LDAP extended operation to get the JVM statistics from the server.

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

GetCPRSDataRequest

public GetCPRSDataRequest(int version,
                          java.lang.String requestID,
                          java.lang.String filter,
                          int startIndex,
                          int size,
                          java.lang.String sortBy,
                          java.lang.String sortOrder,
                          int timeout)
                   throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to get the JVM statistics from the server.

Parameters:

version - the java option with which the request should be invoked

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

Throws:

com.novell.ldap.LDAPException

GetCPRSDataRequest

public GetCPRSDataRequest(int version,
                          java.lang.String requestID,
                          int timeout)
                   throws com.novell.ldap.LDAPException

Throws:

com.novell.ldap.LDAPException

GetCPRSDataRequest

public GetCPRSDataRequest(int version,
                          java.lang.String requestID,
                          java.lang.String UUIDSequence,
                          int timeout)
                   throws com.novell.ldap.LDAPException

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