com.unboundid.ldap.sdk.migrate.ldapjdk

Class LDAPExtendedOperation

java.lang.Object

com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPExtendedOperation

All Implemented Interfaces:

java.io.Serializable

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class LDAPExtendedOperation
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure that represents an LDAP extended request.

This class is primarily intended to be used in the process of updating applications which use the Netscape Directory SDK for Java to switch to or coexist with the UnboundID LDAP SDK for Java. For applications not written using the Netscape Directory SDK for Java, the ExtendedRequest class should be used instead.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LDAPExtendedOperation(ExtendedRequest extendedRequest) Creates a new LDAP extended operation from the provided extended request.
LDAPExtendedOperation(java.lang.String id, byte[] vals) Creates a new LDAP extended operation with the provided OID and value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getID() Retrieves the OID for this LDAP extended operation.
byte[]	getValue() Retrieves the encoded value for this LDAP extended operation, if available.
ExtendedRequest	toExtendedRequest() Converts this LDAP extended operation to an ExtendedRequest.
java.lang.String	toString() Retrieves a string representation of this extended operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LDAPExtendedOperation

public LDAPExtendedOperation(@NotNull
                             java.lang.String id,
                             @Nullable
                             byte[] vals)

Creates a new LDAP extended operation with the provided OID and value.

Parameters:

id - The OID for this extended request.

vals - The encoded value for this extended request, or null if there is none.

LDAPExtendedOperation

public LDAPExtendedOperation(@NotNull
                             ExtendedRequest extendedRequest)

Creates a new LDAP extended operation from the provided extended request.

Parameters:

extendedRequest - The extended request to use to create this LDAP extended operation.

Method Detail

getID

@NotNull
public java.lang.String getID()

Retrieves the OID for this LDAP extended operation.

Returns:

The OID for this LDaP extended operation.

getValue

@Nullable
public byte[] getValue()

Retrieves the encoded value for this LDAP extended operation, if available.

Returns:

The encoded value for this LDAP extended operation, or null if there is none.

toExtendedRequest

@NotNull
public final ExtendedRequest toExtendedRequest()

Converts this LDAP extended operation to an ExtendedRequest.

Returns:

The ExtendedRequest object that is the equivalent of this LDAP extended response.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this extended operation.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this extended operation.