com.novell.nds.dirxml.ldap
Class DiscoverJobsRequest

java.lang.Object
  com.novell.ldap.LDAPExtendedOperation
      com.novell.nds.dirxml.ldap.DiscoverJobsRequest

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, ExtendedRequest

public class DiscoverJobsRequest
extends LDAPExtendedOperation
implements ExtendedRequest

Discover available job definitions on a DirXML 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:

Create rights in the container object specified.

OID:

2.16.840.1.113719.1.14.100.51

Request data:

 ASN1OctetString     UTF-encoded DN of DirXML-Driver or DirXML-DriverSet object
 ASN1Integer         filter flag (1 = filter jobs by containment type, 0 = don't filter)
 ASN1Integer         timeout value in minutes for result data (0-10 are legal values)
 

Notes:

Returned job definitions may be filtered by containment type (e.g., if a DirXML-Driver object is specified then only definitions for jobs that can be contained by a DirXML-Driver object are returned).

See Also:

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

Constructor Summary

DiscoverJobsRequest(String dn, boolean filter, int timeout)
Construct an LDAP extended operation to discover available job definitions on a DirXML server.

Method Summary

ExtendedResponse	createExtendedResponse(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

DiscoverJobsRequest

public DiscoverJobsRequest(String dn,
                           boolean filter,
                           int timeout)
                    throws LDAPException

Construct an LDAP extended operation to discover available job definitions on a DirXML server.

Parameters:

dn - DN of a DirXML-Driver or DirXML-DriverSet object

filter - true if results should be filtered by containment type

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

Throws:

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 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 data

offset - offset into berValue

length - length (in bytes) of reponse data

Throws:

NamingException