com.unboundid.ldap.sdk

Interface DecodeableControl

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AccountUsableResponseControl, ActiveDirectoryDirSyncControl, AssuredReplicationResponseControl, AuthorizationIdentityResponseControl, ChangeSequenceNumberResponseControl, ContentSyncDoneControl, ContentSyncStateControl, DraftBeheraLDAPPasswordPolicy10ResponseControl, EntryChangeNotificationControl, GenerateAccessTokenResponseControl, GeneratePasswordResponseControl, GetAuthorizationEntryResponseControl, GetBackendSetIDResponseControl, GetPasswordPolicyStateIssuesResponseControl, GetRecentLoginHistoryResponseControl, GetServerIDResponseControl, GetUserResourceLimitsResponseControl, IntermediateClientResponseControl, JoinResultControl, JSONFormattedResponseControl, MatchingEntryCountResponseControl, PasswordExpiredControl, PasswordExpiringControl, PasswordPolicyResponseControl, PasswordValidationDetailsResponseControl, PostReadResponseControl, PreReadResponseControl, ServerSideSortResponseControl, SimplePagedResultsControl, SoftDeleteResponseControl, TransactionSettingsResponseControl, UniquenessResponseControl, UnsolicitedCancelResponseControl, VirtualListViewResponseControl

@Extensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface DecodeableControl
extends java.io.Serializable

This interface defines a method that may be implemented by controls that may be included in the response from a directory server. The LDAP SDK will maintain a mapping between response control OIDs and the decodeable control classes that may be used to attempt to decode them. If a control cannot be decoded using this interface and an exception is thrown, then it will be treated as a generic control.

Method Summary

Modifier and Type	Method and Description
Control	decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) Creates a new instance of this decodeable control from the provided information.

Method Detail

decodeControl

@NotNull
Control decodeControl(@NotNull
                               java.lang.String oid,
                               boolean isCritical,
                               @Nullable
                               ASN1OctetString value)
                        throws LDAPException

Creates a new instance of this decodeable control from the provided information.

Parameters:

oid - The OID for the control.

isCritical - Indicates whether the control should be marked critical.

value - The encoded value for the control. This may be null if no value was provided.

Returns:

The decoded representation of this control.

Throws:

LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.