com.novell.nds.dirxml.ldap

Class SetDriverStartOptionRequest

java.lang.Object

com.novell.ldap.LDAPExtendedOperation

com.novell.nds.dirxml.ldap.SetDriverStartOptionRequest

All Implemented Interfaces:

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

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

Set the start option value 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:

Write access to the DirXML-AccessConfigure attribute on the target DirXML-Driver object.

OID:

2.16.840.1.113719.1.14.100.9

Request data:

 ASN1OctetString     UTF-8 encoded DN of DirXML-Driver object
 ASN1Integer         start option value (0, 1, 2)
 ASN1Integer         suppress automatic resync flag (1 == suppress)
 

Notes:

A driver's start option may not be changed while the driver is running.

There is no specific response data or response class.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
SetDriverStartOptionRequest(java.lang.String driverDN, int startOption, boolean suppressResync) Construct an LDAP extended operation to set the start option of a DirXML driver on a 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

SetDriverStartOptionRequest

public SetDriverStartOptionRequest(java.lang.String driverDN,
                                   int startOption,
                                   boolean suppressResync)
                            throws com.novell.ldap.LDAPException

Construct an LDAP extended operation to set the start option of a DirXML driver on a server.

Parameters:

driverDN - the DN of the DirXML-Driver object

startOption - start option value (DxConst.VR_DRIVER_DISABLED, DxConst.VR_DRIVER_MANUAL_START, DxConst.VR_DRIVER_AUTO_START)

suppressResync - true if the automatic resync that normally results from setting a disabled driver to manual or auto start should be suppressed.

Throws:

com.novell.ldap.LDAPException

See Also:

DxConst

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