com.novell.nds.dirxml.ldap

Class CheckJobConfigRequest

java.lang.Object

com.novell.ldap.LDAPExtendedOperation

com.novell.nds.dirxml.ldap.CheckJobConfigRequest

All Implemented Interfaces:

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

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

LDAP request to get a report on the configuration of a DirXML job.

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 DirXML-Job object.

OID:

2.16.840.1.113719.1.14.100.61

Request data:

 ASN1OctetString     job object DN
 ASN1OctetString     two-character language code (may be empty)
 ASN1OctetString     two-character country code (may be empty)
 ASN1Integer         timeout for server-hosted result data
 

Notes:

The language and country codes are used to localize messages in the data returned via GetChunkedResultRequest. If the country code appears then the language code must appear; otherwise it is an error.

See Also:

CheckJobConfigResponse, LDAPConnection.extendedOperation(com.novell.ldap.LDAPExtendedOperation), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CheckJobConfigRequest(java.lang.String jobDN, java.lang.String lang, java.lang.String country, int timeout) Construct an LDAP extended operation to check the configuration of a DirXML job.

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

CheckJobConfigRequest

public CheckJobConfigRequest(java.lang.String jobDN,
                             java.lang.String lang,
                             java.lang.String country,
                             int timeout)
                      throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to check the configuration of a DirXML job.

Parameters:

jobDN - the DN of the DirXML-Job object

lang - two-character language code (e.g., "en") or null

country - two-character country code (e.g., "us") or null

timeout - timeout value in minutes for server-hosted result 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