A B C D E F G H I J K L M N O P R S T U V W

A

AbandonRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with an abandon request.

abortModifyDNOperation() - Method in class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

Indicates whether to abort the modify DN operation and revert any changes that may have already been applied for it.

AccessLogger - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which record information about interaction with clients, including connections established and received and operations requested and completed.

AccessLogger() - Constructor for class com.unboundid.directory.sdk.common.api.AccessLogger

Creates a new instance of this access logger.

AccessLoggerConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an access logger.

acknowledgeCompletedOps(TransactionContext, LinkedList<SyncOperation>) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Provides a way for the Synchronization Server to acknowledge back to the script which sync operations it has processed.

acknowledgeCompletedOps(TransactionContext, LinkedList<SyncOperation>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Provides a way for the Synchronization Server to acknowledge back to the script which sync operations it has processed.

ActiveOperationContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about an operation that is actively being processed and for which the final response has not yet been sent.

ActiveSearchOperationContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about a search operation that is actively being processed and for which the final response has not yet been sent.

addAttribute(Attribute) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Adds the provided attribute to the entry.

addBinaryAttribute(Entry, String, Blob, int) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Adds an Attribute with the given attribute name and Blob value to the given entry if the underlying byte array is not null or empty.

addBooleanAttribute(Entry, String, Boolean) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Adds an Attribute with the given attribute name and boolean value to the given entry if the value is not null.

addDateAttribute(Entry, String, Date, boolean) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Adds an Attribute with the given attribute name and Date value to the given entry if the value is not null.

addModifiedDestinationAttribute(String) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Add the name of a destination attribute that should be synchronized.

addModifiedSourceAttribute(String) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Add an additional source attribute that should be synchronized to the destination.

addNumericAttribute(Entry, String, Number) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Adds an Attribute with the given attribute name and numeric value to the given entry if the value is not null.

addOperationProcessed(CompletedOperationContext, AddRequest, AddResult, Entry) - Method in interface com.unboundid.directory.sdk.ds.api.ChangeListener

Indicates that an add operation has been processed within the server.

addOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, AddRequest, AddResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Performs any processing necessary for an add operation matching the subscription criteria.

addOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, AddRequest, AddResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Performs any processing necessary for an add operation matching the subscription criteria.

addProperty(Object, Object) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Add an arbitrary attachment or property to the DatabaseChangeRecord being built.

AddRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with an add request.

addRequestControl(Control) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableRequest

Adds the provided control to the set of request controls for this request.

AddResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with add results.

addResultControl(Control) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableResult

Adds the provided control to the set of result controls for this result.

addStringAttribute(Entry, String, String) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Adds an Attribute with the given attribute name and string value to the given entry if the value is not null.

addUnaltered(AddRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided add request to the backend server without altering the request or result in any way.

aggregate(List<HealthCheckResult>) - Method in interface com.unboundid.directory.sdk.proxy.types.ProxyServerContext

Aggregates the information contained in the provided list of health check results into a single result.

AlertHandler - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which will be invoked whenever an administrative alert is generated within the server.

AlertHandler() - Constructor for class com.unboundid.directory.sdk.common.api.AlertHandler

Creates a new instance of this alert handler.

AlertHandlerConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an alert handler.

AlertNotification - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to interact with an alert notification.

AlertSeverity - Enum in com.unboundid.directory.sdk.common.types

This enumeration defines the severities that may be used for alert types.

appliesToAttribute(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Indicates whether this matching rule use applies to the provided attribute type.

applyBalancingConfigurationChange(String, List<BackendSet>) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Adapts to a change in the backend sets configured for use with the associated entry-balancing request processor.

applyConfiguration(AccessLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(AlertHandlerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ErrorLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(FileBasedAccessLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(FileBasedErrorLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(KeyManagerProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(MonitorProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(TrustManagerProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(T, ArgumentParser, List<String>, List<String>) - Method in interface com.unboundid.directory.sdk.common.internal.Reconfigurable

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(AccessLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(AlertHandlerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ErrorLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(FileBasedAccessLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(FileBasedErrorLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(CertificateMapperConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ChangeSubscriptionHandlerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(CipherStreamProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ExtendedOperationHandlerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(IdentityMapperConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PasswordGeneratorConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PasswordStorageSchemeConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PasswordValidatorConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(VirtualAttributeProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(CertificateMapperConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ChangeSubscriptionHandlerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(IdentityMapperConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PasswordGeneratorConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PasswordValidatorConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(VirtualAttributeProviderConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(HTTPOperationLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(HTTPServletExtensionConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(HTTPOperationLoggerConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(HTTPServletExtensionConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPHealthCheckConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(PlacementAlgorithmConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ProxyTransformationConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPHealthCheckConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(ProxyTransformationConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPSyncDestinationPluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPSyncSourcePluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(SyncPipePluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPSyncDestinationPluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(LDAPSyncSourcePluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Attempts to apply the configuration from the provided argument parser to this extension.

applyConfiguration(SyncPipePluginConfig, ArgumentParser, List<String>, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Attempts to apply the configuration from the provided argument parser to this extension.

approximatelyMatch(ByteString, ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.ApproximateMatchingRule

Indicates whether the provided values are approximately equal to each other.

ApproximateMatchingRule - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with approximate matching rules, which can be used to determine whether one value is approximately equal to another.

areEqual(ByteString, ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.EqualityMatchingRule

Indicates whether the provided values are logically equal to each other.

AttributeSyntax - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with attribute syntaxes, which can be used to constrain the kinds of data that may be stored in associated attributes.

AttributeType - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about an attribute type defined in the server schema.

AuthInfo - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about the authentication and/or authorization identity of a client connection.

authPasswordMatches(ByteString, String, String) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether the provided plaintext password may be used to generate an encoded password with the given authInfo and authValue elements when using the authentication password syntax as defined in RFC 3112.

AuthType - Enum in com.unboundid.directory.sdk.common.types

This enum defines the set of authentication types that may be used for a client connection.

B

BackendContext - Interface in com.unboundid.directory.sdk.ds.types

This interface defines a set of methods that may be used to interact with a backend that has been defined in the server.

backendFinalized(BackendContext) - Method in class com.unboundid.directory.sdk.ds.api.BackendInitializationListener

Performs any processing that may be required whenever a backend is de-registered from the Directory Server.

BackendInitializationListener - Class in com.unboundid.directory.sdk.ds.api

This interface defines a set of methods that may be used by extensions to perform any processing that they might find necessary whenever a backend is initialized and/or finalized.

BackendInitializationListener() - Constructor for class com.unboundid.directory.sdk.ds.api.BackendInitializationListener

backendInitialized(BackendContext) - Method in class com.unboundid.directory.sdk.ds.api.BackendInitializationListener

Performs any processing that may be required whenever a backend has been registered for use in the Directory Server.

BackendServer - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used to interact with an LDAP external server which acts as a backend server accessed through the Directory Proxy Server.

BackendSet - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used to interact with a set of backend servers to be accessed through an entry-balancing request processor.

betterThan(HealthCheckResult) - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Indicates whether this health check result is considered better than the provided result.

bind(String, String) - Method in interface com.unboundid.directory.sdk.common.types.InternalConnection

Processes a simple bind request with the provided DN and password.

bind(SimpleBindRequest) - Method in interface com.unboundid.directory.sdk.common.types.InternalConnection

Processes the provided bind request.

BindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a bind request.

BindResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with bind results.

build() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Construct the DatabaseChangeRecord.

BUILD_TIMESTAMP - Static variable in class com.unboundid.directory.sdk.common.types.Version

A timestamp indicating when the Server SDK was built as a GMT time.

C

CertificateMapper - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which attempt to map a certificate presented by a client (e.g., via SSL or StartTLS) to a user defined in the server.

CertificateMapper() - Constructor for class com.unboundid.directory.sdk.ds.api.CertificateMapper

Creates a new instance of this certificate mapper.

CertificateMapperConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a certificate mapper.

changedColumns(String[]) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the set of changed columns for this change entry.

ChangeListener - Interface in com.unboundid.directory.sdk.ds.api

This interface defines a set of methods that may be implemented by an extension which should be used to receive information about changes processed within the server as the result of add, delete, modify, or modify DN operations.

changeNumber(long) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the change number that identifies this particular change (if applicable).

ChangeRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a request used to alter server contents.

ChangeSubscription - Interface in com.unboundid.directory.sdk.ds.types

This interface defines a set of methods that may be used to interact with a change subscription that has been defined in the server.

ChangeSubscriptionHandler - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which receive notification of changes of interest processed within the server.

ChangeSubscriptionHandler() - Constructor for class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Creates a new instance of this change subscription handler.

ChangeSubscriptionHandlerConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a change subscription handler.

changeTime(long) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the time at which the change occurred.

checkAvailableServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of AVAILABLE.

checkAvailableServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of AVAILABLE.

checkCompatibility(String) - Static method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Checks to make sure the SDK version specified in the extension JAR file is compatible with this server instance.

checkDegradedServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of DEGRADED.

checkDegradedServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of DEGRADED.

checkFailedOperation(CompletedProxyOperationContext, LDAPException, BackendServer) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Attempts to determine the health of the provided LDAP external server in which an attempted operation did not complete successfully.

checkFailedOperation(CompletedProxyOperationContext, LDAPException, BackendServer) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Attempts to determine the health of the provided LDAP external server in which an attempted operation did not complete successfully.

checkUnavailableServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of UNAVAILABLE.

checkUnavailableServer(BackendServer, LDAPConnection) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Attempts to determine the health of the provided LDAP external server whose last health check result indicated that the server had a state of UNAVAILABLE.

CipherStreamProvider - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which provide access to cipher input streams and cipher output streams to be used by the server in order to read and write encrypted data.

CipherStreamProvider() - Constructor for class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Creates a new instance of this cipher stream provider.

CipherStreamProviderConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a cipher stream provider.

cleanupChangelog(TransactionContext, long) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Performs a cleanup of the changelog table (if desired).

cleanupChangelog(TransactionContext, long) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Performs a cleanup of the changelog table (if desired).

ClientContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about a client connection that has been established to the server.

close() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Releases the internal connection back the pool and invalidates this context object.

com.unboundid.directory.sdk.common.api - package com.unboundid.directory.sdk.common.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions intended for use in various UnboundID server products, including the Directory Server, Directory Proxy Server, and/or Synchronization Server.

com.unboundid.directory.sdk.common.config - package com.unboundid.directory.sdk.common.config

This package defines a number of interfaces that may be used to obtain server-side configuration information for third-party extensions common to multiple UnboundID server products, including the Directory Server, Directory Proxy Server, and/or Synchronization Server.

com.unboundid.directory.sdk.common.internal - package com.unboundid.directory.sdk.common.internal

This package defines a number of classes intended for internal use only within the server SDK itself.

com.unboundid.directory.sdk.common.operation - package com.unboundid.directory.sdk.common.operation

This package defines a number of classes which represent various types of operation requests and results.

com.unboundid.directory.sdk.common.schema - package com.unboundid.directory.sdk.common.schema

This package defines a number of data types that may be used to obtain information about the server schema.

com.unboundid.directory.sdk.common.scripting - package com.unboundid.directory.sdk.common.scripting

This package defines a number of abstract classes which may be used to implement scripted versions of extensions for use in various UnboundID server products, including the Directory Server, Directory Proxy Server, and/or Synchronization Server.

com.unboundid.directory.sdk.common.types - package com.unboundid.directory.sdk.common.types

This package defines a number of data types for use in extensions intended for use in UnboundID server products, including the Directory Server, Directory Proxy Server, and Synchronization Server.

com.unboundid.directory.sdk.ds.api - package com.unboundid.directory.sdk.ds.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions primarily intended for use in the UnboundID Directory Server, although some of the APIs defined in this package may apply to other UnboundID products in certain contexts.

com.unboundid.directory.sdk.ds.config - package com.unboundid.directory.sdk.ds.config

This package defines a number of interfaces that may be used to obtain server-side configuration information for third-party extensions primarily intended for use in the UnboundID Directory Server, although they may be applicable to other UnboundID server products in certain contexts.

com.unboundid.directory.sdk.ds.internal - package com.unboundid.directory.sdk.ds.internal

This package defines a number of classes intended for internal use only within the server SDK itself.

com.unboundid.directory.sdk.ds.scripting - package com.unboundid.directory.sdk.ds.scripting

This package defines a number of abstract classes which may be used to implement scripted versions of extensions primarily for use in the UnboundID Directory Server, although they may be applicable for use in other UnboundID server products in certain contexts.

com.unboundid.directory.sdk.ds.types - package com.unboundid.directory.sdk.ds.types

This package defines a number of data types for use in extensions primarily intended for use in the UnboundID Directory Server, although they may also be applicable to other UnboundID server products in certain contexts.

com.unboundid.directory.sdk.http.api - package com.unboundid.directory.sdk.http.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create HTTP-based extensions intended for use in UnboundID server products.

com.unboundid.directory.sdk.http.config - package com.unboundid.directory.sdk.http.config

This package defines a number of interfaces that may be used to obtain server-side configuration information for HTTP-based third-party extensions intended for use in the UnboundID server products.

com.unboundid.directory.sdk.http.scripting - package com.unboundid.directory.sdk.http.scripting

This package defines a number of abstract classes which may be used to implement scripted versions of HTTP-based extensions intended for use in UnboundID server products.

com.unboundid.directory.sdk.http.types - package com.unboundid.directory.sdk.http.types

This package defines a number of data types for use in HTTP-based extensions intended for use in UnboundID server products.

com.unboundid.directory.sdk.proxy.api - package com.unboundid.directory.sdk.proxy.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions primarily intended for use in the UnboundID Directory Proxy Server.

com.unboundid.directory.sdk.proxy.config - package com.unboundid.directory.sdk.proxy.config

This package defines a number of interfaces that may be used to obtain server-side configuration information for third-party extensions intended for use in the UnboundID Directory Proxy Server.

com.unboundid.directory.sdk.proxy.internal - package com.unboundid.directory.sdk.proxy.internal

This package defines a number of classes intended for internal use only within the server SDK itself.

com.unboundid.directory.sdk.proxy.scripting - package com.unboundid.directory.sdk.proxy.scripting

This package defines a number of abstract classes which may be used to implement scripted versions of extensions primarily for use in the UnboundID Directory Proxy Server.

com.unboundid.directory.sdk.proxy.types - package com.unboundid.directory.sdk.proxy.types

This package defines a number of data types for use in extensions intended for use in the UnboundID Directory Proxy Server.

com.unboundid.directory.sdk.sync.api - package com.unboundid.directory.sdk.sync.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions primarily intended for use in the UnboundID Synchronization Server.

com.unboundid.directory.sdk.sync.config - package com.unboundid.directory.sdk.sync.config

This package defines a number of interfaces that may be used to obtain server-side configuration information for third-party extensions intended for use in the UnboundID Synchronization Server.

com.unboundid.directory.sdk.sync.internal - package com.unboundid.directory.sdk.sync.internal

This package defines a number of classes intended for internal use only within the server SDK itself.

com.unboundid.directory.sdk.sync.scripting - package com.unboundid.directory.sdk.sync.scripting

This package defines a number of abstract classes which may be used to implement scripted versions of extensions primarily for use in the UnboundID Synchronization Server.

com.unboundid.directory.sdk.sync.types - package com.unboundid.directory.sdk.sync.types

This package defines a number of data types for use in extensions intended for use in the UnboundID Synchronization Server.

com.unboundid.directory.sdk.sync.util - package com.unboundid.directory.sdk.sync.util

commit() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Commits the internal Connection if the transaction has not timed out and is still valid.

COMPACT_VERSION_STRING - Static variable in class com.unboundid.directory.sdk.common.types.Version

The compact version string for the Server SDK, without any spaces.

compare(HealthCheckResult, HealthCheckResult) - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Compares the provided health check results to determine their relative order in a sorted list.

CompareRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a compare request.

CompareResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with compare results.

compareTo(HealthCheckResult) - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Compares the provided health check result with this health check result to determine their relative order in a sorted list.

compareUnaltered(CompareRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided compare request to the backend server without altering the request or result in any way.

compareValues(ByteString, ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.OrderingMatchingRule

Compares the provided values to determine their logical order in a sorted list.

CompletedOperationContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about an operation for which processing has been completed.

CompletedProxyOperationContext - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used to obtain information about an operation that has been processed by the Directory Proxy Server.

CompletedSearchOperationContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about a search operation for which processing has been completed.

completedSuccessfully() - Method in class com.unboundid.directory.sdk.ds.types.StartupPluginResult

Indicates whether the plugin successfully completed its processing.

CompletionStatus - Enum in com.unboundid.directory.sdk.sync.types

This class contains the possible completion reasons for a synchronization operation.

ConditionResult - Enum in com.unboundid.directory.sdk.common.types

This enum defines a set of values which may be used to represent the result of a Boolean evaluation in which the result may be undefined.

CONFIG_PATH_RELATIVE - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The relative path where the config files are.

Configurable - Interface in com.unboundid.directory.sdk.common.internal

This interface is used to mark extensions which may obtain configuration information using an LDAP SDK argument parser.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

Indicates whether the connection has been terminated.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.PostOperationPluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Indicates whether the client connection was terminated by the plugin.

connectionTerminated() - Method in class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

Indicates whether the client connection was terminated by the plugin.

containsAnyValue(Attribute, String...) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Returns true if the given attribute is not null and contains any one or more of the given string values; returns false otherwise.

continueInstallation() - Method in class com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

Indicates whether the manage-extension tool should continue with the installation.

continueOperationProcessing() - Method in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Indicates whether to continue processing for the associated operation.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Indicates whether to continue processing other intermediate response plugins for the associated response.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

Indicates whether to continue processing other LDIF import or export plugins for the entry.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

Indicates whether to continue processing other post-connect plugins for the connection.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PostDisconnectPluginResult

Indicates whether to continue processing other post-disconnect plugins for the connection.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PostOperationPluginResult

Indicates whether to continue processing other post-operation plugins for the operation.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

Indicates whether to continue processing other post-response plugins for the operation.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Indicates whether to continue processing other pre-operation plugins for the connection.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Indicates whether to continue processing other pre-parse plugins for the operation.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Indicates whether to continue processing other search entry plugins for the associated entry.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Indicates whether to continue processing other search reference plugins for the associated search reference.

continuePluginProcessing() - Method in class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

Indicates whether to continue processing other subordinate modify DN plugins for the associated entry.

continueSearchProcessing() - Method in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Indicates whether to continue processing for the associated search operation.

continueSearchProcessing() - Method in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Indicates whether to continue processing for the associated search operation.

continueStartup() - Method in class com.unboundid.directory.sdk.ds.types.StartupPluginResult

Indicates whether the server startup process should continue.

createBeginningOfChangelogOptions() - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the BEGINNING_OF_CHANGELOG startpoint type.

createCipherInputStream(InputStream) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Wraps the provided input stream in a cipher input stream that can be used to decrypt data read from the given stream.

createCipherOutputStream(OutputStream) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Wraps the provided output stream in a cipher output stream that can be used to encrypt data written to the given stream.

createEndOfChangelogOptions() - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the END_OF_CHANGELOG startpoint type.

createEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Creates a full database "entry", corresponding to the the LDAP Entry that is passed in.

createEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Creates a full destination "entry", corresponding to the the LDAP Entry that is passed in.

createEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

Creates a full database "entry", corresponding to the the LDAP Entry that is passed in.

createEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Creates a full destination "entry", corresponding to the the LDAP Entry that is passed in.

createHealthCheckResult(HealthCheckState, int, String...) - Method in interface com.unboundid.directory.sdk.proxy.types.ProxyServerContext

Creates a health check result with the provided information.

createHealthCheckResult(HealthCheckState, int, List<String>) - Method in interface com.unboundid.directory.sdk.proxy.types.ProxyServerContext

Creates a health check result with the provided information.

createNewConnection(LDAPConnectionOptions, String) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Creates a new connection to the associated directory server which is authenticated and/or secured in accordance with the LDAP external server configuration.

createResumeAtChangeNumberOptions(long, String) - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the RESUME_AT_CHANGE_NUMBER startpoint type.

createResumeAtChangeTimeOptions(Date, String) - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the RESUME_AT_CHANGE_TIME startpoint type.

createResumeAtCSNOptions(String) - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the RESUME_AT_CSN startpoint type.

createResumeAtSerializableOptions(Serializable) - Static method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Creates a SetStartpointOptions instance with the RESUME_AT_SERIALIZABLE startpoint type.

createServlet(HTTPServerContext, HTTPServletExtensionConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Creates an HTTP servlet extension using the provided information.

createServlet(HTTPServerContext, HTTPServletExtensionConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Creates an HTTP servlet using the provided information.

createStatement() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Creates a Statement object for sending SQL statements to the database.

createThread(ServerThread, String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Creates a new thread to run within the server.

D

DatabaseChangeRecord - Class in com.unboundid.directory.sdk.sync.types

This class represents the basis for a single database change record.

DatabaseChangeRecord.Builder - Class in com.unboundid.directory.sdk.sync.types

This class is used to construct DatabaseChangeRecord instances.

DatabaseChangeRecord.Builder(DatabaseChangeRecord.ChangeType, DN) - Constructor for class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Creates a Builder which can be used to construct a DatabaseChangeRecord.

DatabaseChangeRecord.Builder(DatabaseChangeRecord.ChangeType, String) - Constructor for class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Creates a Builder which can be used to construct a DatabaseChangeRecord.

DatabaseChangeRecord.Builder(DatabaseChangeRecord.ChangeType, String, String) - Constructor for class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Creates a Builder which can be used to construct a DatabaseChangeRecord.

DatabaseChangeRecord.ChangeType - Enum in com.unboundid.directory.sdk.sync.types

Potential types of database changes.

debugCaught(Throwable) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message indicating that the provided exception has been caught.

debugEnabled() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether debugging is enabled in the server.

debugError(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message with an error severity.

debugInfo(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message with an informational severity.

debugThrown(Throwable) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message indicating that the provided exception will be thrown.

debugVerbose(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message with a verbose severity.

debugWarning(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a debug message with a warning severity.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in interface com.unboundid.directory.sdk.common.internal.Configurable

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.Task

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedTask

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

defineConfigArguments(ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Updates the provided argument parser to define any configuration arguments which may be used by this extension.

deleteEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Delete a full "entry" from the database, corresponding to the the LDAP Entry that is passed in.

deleteEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Delete a full "entry" from the destination, corresponding to the the LDAP Entry that is passed in.

deleteEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

Delete a full "entry" from the database, corresponding to the the LDAP Entry that is passed in.

deleteEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Delete a full "entry" from the destination, corresponding to the the LDAP Entry that is passed in.

deleteOldRDN() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Indicates whether to remove the old RDN values from the entry.

deleteOperationProcessed(CompletedOperationContext, DeleteRequest, DeleteResult, Entry) - Method in interface com.unboundid.directory.sdk.ds.api.ChangeListener

Indicates that a delete operation has been processed within the server.

deleteOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, DeleteRequest, DeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Performs any processing necessary for a delete operation matching the subscription criteria.

deleteOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, DeleteRequest, DeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Performs any processing necessary for a delete operation matching the subscription criteria.

DeleteRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a delete request.

DeleteResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with delete results.

deleteUnaltered(DeleteRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided delete request to the backend server without altering the request or result in any way.

deregisterAllMonitorProviders() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters all the monitor providers that were registered with the server by this instance of ServerContext.

deregisterBackendInitializationListener(RegisteredBackendInitializationListener) - Method in interface com.unboundid.directory.sdk.ds.types.DirectoryServerContext

Deregisters the provided backend initialization listener with the server.

deregisterChangeListener(RegisteredChangeListener) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters the provided change listener with the server.

deregisterDiskSpaceConsumer(RegisteredDiskSpaceConsumer) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters the provided disk space consumer with the server.

deregisterMonitorProvider(RegisteredMonitorProvider) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters the given monitor provider with the server.

deregisterShutdownListener(RegisteredServerShutdownListener) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters the provided server shutdown listener with the server.

deregisterSupportedControlOID(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Deregisters the provided OID with the server so that it will no longer appear in the supportedControl attribute of the server's root DSE.

DirectoryProxyServerExtension - Annotation Type in com.unboundid.directory.sdk.proxy.internal

This annotation type may be used to indicate that the marked class represents an API that can be used to create an extension for use in the Directory Proxy Server.

DirectoryServerContext - Interface in com.unboundid.directory.sdk.ds.types

This interface may be used to obtain information about the Directory Server (or related product) in which an extension is running.

DirectoryServerExtension - Annotation Type in com.unboundid.directory.sdk.ds.internal

This annotation type may be used to indicate that the marked class represents an API that can be used to create an extension for use in the Directory Server.

disconnect(DisconnectReason, boolean, String) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Terminates the connection to the client and interrupts any operations that may be in progress on that connection.

DisconnectReason - Enum in com.unboundid.directory.sdk.common.types

This enumeration defines the set of possible reasons for the closure of a connection between a client and the server.

DiskSpaceConsumer - Interface in com.unboundid.directory.sdk.common.api

This interface defines a set of methods that should be implemented by classes which may consume a significant amount of disk space on the server filesystem.

DITContentRule - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about a DIT content rule defined in the server schema.

DITStructureRule - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about a DIT structure rule defined in the server schema.

dnToMap(DN) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Takes an identifier DN (such as the output from ScriptUtils.idStringToDN(String,String) and creates a hash map of the components (RDN attributes) to their respective values.

DOCUMENTATION_PATH_RELATIVE - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The relative path where all the documentation files are.

doIntermediateResponse(ActiveOperationContext, UpdatableGenericResult, IntermediateResponse) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends an intermediate response to the client.

doIntermediateResponse(ActiveOperationContext, UpdatableGenericResult, IntermediateResponse) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends an intermediate response to the client.

doLDIFExport(UpdatableEntry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary for the provided entry to be exported from the server.

doLDIFExport(UpdatableEntry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary for the provided entry to be exported from the server.

doLDIFImport(UpdatableEntry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary for the provided entry to be imported into the server.

doLDIFImport(UpdatableEntry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary for the provided entry to be imported into the server.

doPostConnect(ClientContext) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary when the server has accepted a new client connection.

doPostConnect(ClientContext) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary when the server has accepted a new client connection.

doPostDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary when the server has terminated a client connection.

doPostDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary when the server has terminated a client connection.

doPostOperation(ActiveOperationContext, AddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for an add operation.

doPostOperation(ActiveOperationContext, SimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a simple bind operation.

doPostOperation(ActiveOperationContext, SASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a SASL bind operation.

doPostOperation(ActiveOperationContext, CompareRequest, UpdatableCompareResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a compare operation.

doPostOperation(ActiveOperationContext, DeleteRequest, UpdatableDeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a delete operation.

doPostOperation(ActiveOperationContext, ExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for an extended operation.

doPostOperation(ActiveOperationContext, ModifyRequest, UpdatableModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a modify operation.

doPostOperation(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a modify DN operation.

doPostOperation(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a response for a search operation.

doPostOperation(ActiveOperationContext, AddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for an add operation.

doPostOperation(ActiveOperationContext, SimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a simple bind operation.

doPostOperation(ActiveOperationContext, SASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a SASL bind operation.

doPostOperation(ActiveOperationContext, CompareRequest, UpdatableCompareResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a compare operation.

doPostOperation(ActiveOperationContext, DeleteRequest, UpdatableDeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a delete operation.

doPostOperation(ActiveOperationContext, ExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for an extended operation.

doPostOperation(ActiveOperationContext, ModifyRequest, UpdatableModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a modify operation.

doPostOperation(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a modify DN operation.

doPostOperation(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a response for a search operation.

doPostRegistrationProcessing() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Performs any processing that may be needed after the servlet has been registered with the servlet engine.

doPostRegistrationProcessing() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Performs any processing that may be needed after the servlet has been registered with the servlet engine.

doPostReplication(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for an add operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a delete operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a modify operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a modify DN operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for an add operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a delete operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a modify operation which has been received from another server via replication.

doPostReplication(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a modify DN operation which has been received from another server via replication.

doPostResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for an add operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a simple bind operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a SASL bind operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a compare operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a delete operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for an extended operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a modify operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a modify DN operation and the response has been sent to the client.

doPostResponse(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary after all other processing has been completed for a search operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for an add operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a simple bind operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a SASL bind operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a compare operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a delete operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for an extended operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a modify operation and the response has been sent to the client.

doPostResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a modify DN operation and the response has been sent to the client.

doPostResponse(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary after all other processing has been completed for a search operation and the response has been sent to the client.

doPostShutdownProcessing() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Performs any processing that may be needed after the servlet has been taken out of service and the associated servlet engine has been shut down.

doPostShutdownProcessing() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Performs any processing that may be needed after the servlet has been taken out of service and the associated servlet engine has been shut down.

doPreOperation(ActiveOperationContext, AddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to add an entry to the appropriate backend.

doPreOperation(ActiveOperationContext, SimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to perform the authentication for a simple bind request.

doPreOperation(ActiveOperationContext, SASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to perform the authentication for a SASL bind request.

doPreOperation(ActiveOperationContext, CompareRequest, UpdatableCompareResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to perform the core processing for the compare.

doPreOperation(ActiveOperationContext, DeleteRequest, UpdatableDeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to remove the entry from the server.

doPreOperation(ActiveOperationContext, ExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to perform the core processing for the extended operation.

doPreOperation(ActiveOperationContext, ModifyRequest, UpdatableModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to update the entry in the backend.

doPreOperation(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to update the entry in the backend.

doPreOperation(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server actually attempts to process the search in the backend.

doPreOperation(ActiveOperationContext, AddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to add an entry to the appropriate backend.

doPreOperation(ActiveOperationContext, SimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to perform the authentication for a simple bind request.

doPreOperation(ActiveOperationContext, SASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to perform the authentication for a SASL bind request.

doPreOperation(ActiveOperationContext, CompareRequest, UpdatableCompareResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to perform the core processing for the compare.

doPreOperation(ActiveOperationContext, DeleteRequest, UpdatableDeleteResult, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to remove the entry from the server.

doPreOperation(ActiveOperationContext, ExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to perform the core processing for the extended operation.

doPreOperation(ActiveOperationContext, ModifyRequest, UpdatableModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to update the entry in the backend.

doPreOperation(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to update the entry in the backend.

doPreOperation(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server actually attempts to process the search in the backend.

doPreParse(ActiveOperationContext, UpdatableAbandonRequest) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for an abandon request.

doPreParse(ActiveOperationContext, UpdatableAddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for an add request.

doPreParse(ActiveOperationContext, UpdatableSimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a simple bind request.

doPreParse(ActiveOperationContext, UpdatableSASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a SASL bind request.

doPreParse(ActiveOperationContext, UpdatableCompareRequest, UpdatableCompareResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a compare request.

doPreParse(ActiveOperationContext, UpdatableDeleteRequest, UpdatableDeleteResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a delete request.

doPreParse(ActiveOperationContext, UpdatableExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for an extended request.

doPreParse(ActiveOperationContext, UpdatableModifyRequest, UpdatableModifyResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a modify request.

doPreParse(ActiveOperationContext, UpdatableModifyDNRequest, UpdatableModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a modify DN request.

doPreParse(ActiveSearchOperationContext, UpdatableSearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for a search request.

doPreParse(ActiveOperationContext, UpdatableUnbindRequest) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server starts processing for an unbind request.

doPreParse(ActiveOperationContext, UpdatableAbandonRequest) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for an abandon request.

doPreParse(ActiveOperationContext, UpdatableAddRequest, UpdatableAddResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for an add request.

doPreParse(ActiveOperationContext, UpdatableSimpleBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a simple bind request.

doPreParse(ActiveOperationContext, UpdatableSASLBindRequest, UpdatableBindResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a SASL bind request.

doPreParse(ActiveOperationContext, UpdatableCompareRequest, UpdatableCompareResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a compare request.

doPreParse(ActiveOperationContext, UpdatableDeleteRequest, UpdatableDeleteResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a delete request.

doPreParse(ActiveOperationContext, UpdatableExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for an extended request.

doPreParse(ActiveOperationContext, UpdatableModifyRequest, UpdatableModifyResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a modify request.

doPreParse(ActiveOperationContext, UpdatableModifyDNRequest, UpdatableModifyDNResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a modify DN request.

doPreParse(ActiveSearchOperationContext, UpdatableSearchRequest, UpdatableSearchResult) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for a search request.

doPreParse(ActiveOperationContext, UpdatableUnbindRequest) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server starts processing for an unbind request.

doSearchEntry(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult, UpdatableEntry, List<Control>) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a search result entry to the client.

doSearchEntry(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult, UpdatableEntry, List<Control>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a search result entry to the client.

doSearchReference(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary before the server sends a search result reference to the client.

doSearchReference(ActiveSearchOperationContext, SearchRequest, UpdatableSearchResult, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary before the server sends a search result reference to the client.

doShutdown(String) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary when the server is shutting down.

doShutdown(String) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary when the server is shutting down.

doStartup() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary when the server is starting.

doStartup() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary when the server is starting.

doSubordinateModifyDN(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry, List<Modification>) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any processing which may be necessary during the course of renaming an entry which is subordinate to an entry targeted by a modify DN operation.

doSubordinateModifyDN(ActiveOperationContext, ModifyDNRequest, UpdatableModifyDNResult, Entry, Entry, List<Modification>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any processing which may be necessary during the course of renaming an entry which is subordinate to an entry targeted by a modify DN operation.

E

encodeAuthPassword(ByteString) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Encodes the provided plaintext password using the authentication password syntax as defined in RFC 3112.

encodePassword(ByteString) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Encodes the provided plaintext password.

encodePasswordWithScheme(ByteString) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Encodes the provided plaintext password, prefixing the encoded representation with the name of the storage scheme in curly braces.

encodePasswordWithScheme(ByteString, DN) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Encodes the provided plaintext password, prefixing the encoded representation with the name of the storage scheme in curly braces.

EndpointException - Exception in com.unboundid.directory.sdk.sync.types

This class provides a type of Exception which is used to indicate an error when interfacing with an external resource.

EndpointException(PostStepResult) - Constructor for exception com.unboundid.directory.sdk.sync.types.EndpointException

Creates a new EndpointException with the provided information.

EndpointException(PostStepResult, String) - Constructor for exception com.unboundid.directory.sdk.sync.types.EndpointException

Creates a new EndpointException with the provided information.

EndpointException(PostStepResult, Throwable) - Constructor for exception com.unboundid.directory.sdk.sync.types.EndpointException

Creates a new EndpointException with the provided information.

EndpointException(PostStepResult, String, Throwable) - Constructor for exception com.unboundid.directory.sdk.sync.types.EndpointException

Creates a new EndpointException with the provided information.

EndpointException(LDAPException) - Constructor for exception com.unboundid.directory.sdk.sync.types.EndpointException

Creates a new EndpointException with the provided information.

Entry - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods which may be used to interact with an entry.

entryExists(String) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the specified entry exists in the backend.

entryType(String) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the database entry type that this change corresponds to (for example "account" or "subscriber").

EqualityMatchingRule - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with equality matching rules, which can be used to determine whether one value is logically equivalent to another.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Indicates whether the provided object is equal to this attribute syntax.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether the provided object is equal to this attribute type.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided object is equal to this DIT content rule.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Indicates whether the provided object is equal to this DIT structure rule.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Indicates whether the provided object is equal to this matching rule.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Indicates whether the provided object is equal to this matching rule use.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether the provided object is equal to this name form.

equals(Object) - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether the provided object is equal to this object class.

equals(Object) - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Indicates whether the provided object may be considered equal to this health check result.

ErrorLogger - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which record information about warnings, errors, and events which occur in the server.

ErrorLogger() - Constructor for class com.unboundid.directory.sdk.common.api.ErrorLogger

Creates a new instance of this error logger.

ErrorLoggerConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an error logger.

ExampleUsageProvider - Interface in com.unboundid.directory.sdk.common.internal

This interface is used to mark extensions which may provide examples that demonstrate how they are intended to be used.

ExtendedOperationHandler - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which are used to process extended operations within the server.

ExtendedOperationHandler() - Constructor for class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Creates a new instance of this extended operation handler.

ExtendedOperationHandlerConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an extended operation handler.

ExtendedRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with an extended request.

ExtendedResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with extended results.

ExtensionBundle - Class in com.unboundid.directory.sdk.common.types

This class represents the physical state of an UnboundID Server extension bundle.

ExtensionBundle(File) - Constructor for class com.unboundid.directory.sdk.common.types.ExtensionBundle

Creates a new instance from a root directory specified as a File.

F

fetchEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Return a full destination entry (in LDAP form) from the database, corresponding to the the source Entry that is passed in.

fetchEntry(TransactionContext, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Return a full source entry (in LDAP form) from the database, corresponding to the DatabaseChangeRecord that is passed in through the SyncOperation.

fetchEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Return a full destination entry (in LDAP form) from the destination endpoint, corresponding to the the source Entry that is passed in.

fetchEntry(TransactionContext, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

Return a full destination entry (in LDAP form) from the database, corresponding to the the source Entry that is passed in.

fetchEntry(TransactionContext, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Return a full source entry (in LDAP form) from the database, corresponding to the DatabaseChangeRecord that is passed in through the SyncOperation.

fetchEntry(Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Return a full destination entry (in LDAP form) from the destination endpoint, corresponding to the the source Entry that is passed in.

FileBasedAccessLogger - Class in com.unboundid.directory.sdk.common.api

This class defines an API that may be used to create a specific type of access logger which is intended to write log messages to text files.

FileBasedAccessLogger() - Constructor for class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Creates a new instance of this file-based access logger.

FileBasedAccessLoggerConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a file-based access logger.

FileBasedErrorLogger - Class in com.unboundid.directory.sdk.common.api

This class defines an API that may be used to create a specific type of error logger which is intended to write log messages to text files.

FileBasedErrorLogger() - Constructor for class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Creates a new instance of this file-based error logger.

FileBasedErrorLoggerConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a file-based error logger.

finalizeAccessLogger() - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Performs any cleanup which may be necessary when this access logger is to be taken out of service.

finalizeAccessLogger() - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Performs any cleanup which may be necessary when this file-based access logger is to be taken out of service.

finalizeAccessLogger() - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Performs any cleanup which may be necessary when this access logger is to be taken out of service.

finalizeAccessLogger() - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Performs any cleanup which may be necessary when this access logger is to be taken out of service.

finalizeAlertHandler() - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Performs any cleanup which may be necessary when this alert handler is to be taken out of service.

finalizeAlertHandler() - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Performs any cleanup which may be necessary when this alert handler is to be taken out of service.

finalizeCertificateMapper() - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Performs any cleanup which may be necessary when this certificate mapper is to be taken out of service.

finalizeCertificateMapper() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Performs any cleanup which may be necessary when this certificate mapper is to be taken out of service.

finalizeChangeSubscriptionHandler() - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Performs any cleanup which may be necessary when this change subscription handler is to be taken out of service.

finalizeChangeSubscriptionHandler() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Performs any cleanup which may be necessary when this change subscription handler is to be taken out of service.

finalizeCipherStreamProvider() - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Performs any cleanup which may be necessary when this cipher stream provider is to be taken out of service.

finalizeErrorLogger() - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Performs any cleanup which may be necessary when this error logger is to be taken out of service.

finalizeErrorLogger() - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Performs any cleanup which may be necessary when this file-based error logger is to be taken out of service.

finalizeErrorLogger() - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Performs any cleanup which may be necessary when this error logger is to be taken out of service.

finalizeErrorLogger() - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Performs any cleanup which may be necessary when this file-based error logger is to be taken out of service.

finalizeExtendedOperationHandler() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Performs any cleanup which may be necessary when this extended operation handler is to be taken out of service.

finalizeHTTPOperationLogger() - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Performs any cleanup which may be necessary when this HTTP operation logger is to be taken out of service.

finalizeHTTPOperationLogger() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Performs any cleanup which may be necessary when this HTTP operation logger is to be taken out of service.

finalizeIdentityMapper() - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Performs any cleanup which may be necessary when this identity mapper is to be taken out of service.

finalizeIdentityMapper() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Performs any cleanup which may be necessary when this identity mapper is to be taken out of service.

finalizeJDBCSyncDestination(TransactionContext) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

This hook is called when a Sync Pipe shuts down, or when the resync process shuts down.

finalizeJDBCSyncDestination(TransactionContext) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

This hook is called when a Sync Pipe shuts down, or when the Resync process shuts down.

finalizeJDBCSyncSource(TransactionContext) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

This hook is called when a Sync Pipe shuts down, when the resync process shuts down, or when the set-startpoint subcommand (from the realtime-sync command line tool) is finished.

finalizeJDBCSyncSource(TransactionContext) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

This hook is called when a Sync Pipe shuts down, when the resync process shuts down, or when the set-startpoint subcommand (from the realtime-sync command line tool) is finished.

finalizeKeyManagerProvider() - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Performs any cleanup which may be necessary when this key manager provider is to be taken out of service.

finalizeLDAPHealthCheck() - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Performs any cleanup which may be necessary when this LDAP health check is to be taken out of service.

finalizeLDAPHealthCheck() - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Performs any cleanup which may be necessary when this LDAP health check is to be taken out of service.

finalizeLDAPSyncDestinationPlugin() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Performs any cleanup which may be necessary when this LDAP sync destination plugin is taken out of service.

finalizeLDAPSyncDestinationPlugin() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Performs any cleanup which may be necessary when this LDAP sync destination plugin is to be taken out of service.

finalizeLDAPSyncSourcePlugin() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Performs any cleanup which may be necessary when this LDAP sync source plugin is taken out of service.

finalizeLDAPSyncSourcePlugin() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Performs any cleanup which may be necessary when this LDAP sync source plugin is to be taken out of service.

finalizeMonitorProvider() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Performs any cleanup which may be necessary when this monitor provider is to be taken out of service.

finalizePasswordGenerator() - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Performs any cleanup which may be necessary when this password generator is to be taken out of service.

finalizePasswordGenerator() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Performs any cleanup which may be necessary when this password generator is to be taken out of service.

finalizePasswordStorageScheme() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Performs any cleanup which may be necessary when this password storage scheme is to be taken out of service.

finalizePasswordValidator() - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Performs any cleanup which may be necessary when this password validator is to be taken out of service.

finalizePasswordValidator() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Performs any cleanup which may be necessary when this password validator is to be taken out of service.

finalizePlacementAlgorithm() - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Performs any cleanup which may be necessary when this LDAP health check is to be taken out of service.

finalizePlugin() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Performs any cleanup which may be necessary when this plugin is to be taken out of service.

finalizePlugin() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Performs any cleanup which may be necessary when this plugin is to be taken out of service.

finalizeProxyTransformation() - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Performs any cleanup which may be necessary when this proxy transformation is to be taken out of service.

finalizeProxyTransformation() - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Performs any cleanup which may be necessary when this proxy transformation is to be taken out of service.

finalizeSyncDestination() - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

This hook is called when a Sync Pipe shuts down, or when the resync process shuts down.

finalizeSyncDestination() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

This hook is called when a Sync Pipe shuts down, or when the resync process shuts down.

finalizeSyncPipePlugin() - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Performs any cleanup which may be necessary when this sync pipe plugin is taken out of service.

finalizeSyncPipePlugin() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Performs any cleanup which may be necessary when this sync pipe plugin is to be taken out of service.

finalizeTrustManagerProvider() - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Performs any cleanup which may be necessary when this trust manager provider is to be taken out of service.

finalizeVirtualAttributeProvider() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Performs any cleanup which may be necessary when this virtual attribute provider is to be taken out of service.

finalizeVirtualAttributeProvider() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Performs any cleanup which may be necessary when this virtual attribute provider is to be taken out of service.

forName(String) - Static method in enum com.unboundid.directory.sdk.common.types.AlertSeverity

Retrieves the alert severity with the specified name.

forName(String) - Static method in enum com.unboundid.directory.sdk.ds.types.IndexType

Retrieves the IndexType for the specified name.

forName(String) - Static method in enum com.unboundid.directory.sdk.ds.types.WritabilityMode

Retrieves the WritabilityMode for the specified name.

ForwardTarget - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods which may be used to obtain information about a server to which an operation may be forwarded for processing.

FULL_VERSION_STRING - Static variable in class com.unboundid.directory.sdk.common.types.Version

The full version string for the Server SDK.

G

generateAttribute(OperationContext, Entry, String) - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Generates an attribute for inclusion in the provided entry.

generateAttribute(OperationContext, Entry, String) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Generates an attribute for inclusion in the provided entry.

generatePassword(Entry) - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Performs any processing which may be necessary to generate a user password.

generatePassword(Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Performs any processing which may be necessary to generate a user password.

GenericConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for all types of extensions.

GenericDirectoryConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for extensions used by the Directory Server.

GenericHTTPConfig - Interface in com.unboundid.directory.sdk.http.config

This interface defines a set of methods that may be used to obtain information about the general configuration for extensions used by the Directory Server.

GenericProxyConfig - Interface in com.unboundid.directory.sdk.proxy.config

This interface defines a set of methods that may be used to obtain information about the general configuration for extensions used by the Directory Proxy Server.

GenericResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with properties common to most types of LDAP results.

GenericSyncConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration for extensions used by the Synchronization Server.

getActiveOperations() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the number of operations which are currently being processed against the LDAP external server through the local Directory Proxy Server instance.

getAdditionalLogMessage() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves an additional log message for the result which will not be returned to the client but may be included in access log messages for the associated operation.

getAlertGeneratorClassName() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the name of the class that generated this alert notification.

getAlertID() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the unique ID assigned to this alert notification.

getAlertMessage() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the message for this alert notification, which may contain specific information about the error, warning, or event that triggered the alert.

getAlertSeverity() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the severity for this alert notification.

getAlertTime() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the time that this alert notification was generated.

getAlertTypeDescription() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves a description of the alert type for this alert notification.

getAlertTypeName() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the name of the alert type for this alert notification.

getAlertTypeOID() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves the OID of the alert type for this alert notification.

getAlertTypeSummary() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves a short summary of the alert type for this alert notification.

getAllBackends() - Method in interface com.unboundid.directory.sdk.ds.types.DirectoryServerContext

Returns an array of all the backends defined in the Directory Server.

getApproximateMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the approximate matching rule for this attribute type, if any.

getAssertionValue() - Method in interface com.unboundid.directory.sdk.common.operation.CompareRequest

Retrieves the assertion value to compare against the values of the target attribute.

getAttachment(String) - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the object attached to the associated operation with the given name.

getAttachment(Object) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Returns an attachment from the operation that was previously set with a call to SyncOperation.putAttachment(java.lang.Object, java.lang.Object).

getAttribute(AttributeType) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves the attribute with the specified name.

getAttribute(String) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves the attribute with the specified name.

getAttribute(AttributeType, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves the attribute with the specified name and exact set of options.

getAttribute(String, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves the attribute with the specified name and exact set of options.

getAttributes() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the list of requested attributes.

getAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves the set of attributes that are associated with this matching rule use.

getAttributes() - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves a list of the attributes contained in the entry.

getAttributeSyntax(String) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the attribute syntax with the specified OID, if available.

getAttributeSyntaxesByOID() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of attribute syntaxes defined in the schema, mapped from OID to the corresponding attribute syntax.

getAttributeType() - Method in interface com.unboundid.directory.sdk.common.operation.CompareRequest

Retrieves the name or OID of the attribute to compare.

getAttributeType(String, boolean) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified attribute type from the server schema, optionally creating a new attribute type with the specified name if none is defined.

getAttributeTypesByName() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of attribute types defined in the server schema, mapped from lowercase name or OID to the attribute type definition.

getAuthenticationDN() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the DN of the user that has authenticated, if applicable.

getAuthenticationEntry() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the entry for the user that has authenticated, if applicable.

getAuthInfo() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves information about the authentication state of the client connection.

getAuthorizationDN() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the DN of the authorization identity for the client connection, if applicable.

getAuthorizationDN() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the DN of the user as whom the request is authorized.

getAuthorizationEntry() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the entry for the authorization identity, if applicable.

getAuthPasswordPlaintextValue(String, String) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Obtains the plaintext password that was used to generate an encoded password with the given authInfo and authValue elements when using the authentication password syntax as described in RFC 3112.

getAuthPasswordSchemeName() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Retrieves the name that should be used to identify this password storage scheme when encoding passwords using the authentication password syntax as described in RFC 3112.

getAuthType() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the type of authentication performed by the client.

getAuxiliaryClasses() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the set of allowed auxiliary classes for this DIT content rule, if any.

getBackendForEntry(String) - Method in interface com.unboundid.directory.sdk.ds.types.DirectoryServerContext

Returns the BackendContext for the backend which should handle the specified entry, or null if there is no backend that handles this entry.

getBackendID() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves the backend ID for this backend.

getBackendInitializationListener() - Method in interface com.unboundid.directory.sdk.ds.types.RegisteredBackendInitializationListener

Retrieves a reference to the backend initialization listener that was registered with the server.

getBackendServers() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendSet

Retrieves the list of servers associated with this backend set.

getBaseDN() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the base DN for the search.

getBaseDNs() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves the set of base DNs handled by the backend.

getBundleId() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the ID string that could be used to uniquely identify this bundle.

getChangedColumns() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the set of changed columns for this change entry.

getChangeListener() - Method in interface com.unboundid.directory.sdk.ds.types.RegisteredChangeListener

Retrieves a reference to the change listener that was registered with the server.

getChangeLogEntry() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the original changelog entry that was detected for this operation.

getChangelogMaximumAge() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncSourceConfig

Gets the configured amount of time (in milliseconds) after which changelog entries should be deleted from the changelog or corresponding table in the database.

getChangeNumber() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the change number that identifies this particular change.

getChangeNumber() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the change number value if one was specified.

getChangeTime() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the time at which the change occurred.

getChangeTime() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the change time value if one was specified.

getChangeType() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the change type (insert/update/delete/resync).

getClientContext() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves information about the client that requested this operation.

getClientInetAddress() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves an InetAddress representing the address of the client system, if available.

getClosureMessage() - Method in enum com.unboundid.directory.sdk.common.types.DisconnectReason

Retrieves the human-readable disconnect reason.

getCompactProductName() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the compact name of the server.

getCompletionStatus() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Gets the completion status for this change.

getConfigDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the configuration directory for this extension bundle.

getConfigEntryDN() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the DN of the configuration entry in which this LDAP external server is defined.

getConfigEntryDN() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendSet

Retrieves the DN of the configuration entry for the proxying request processor that defines this backend set.

getConfigEntryDN() - Method in interface com.unboundid.directory.sdk.proxy.types.Location

Retrieves the DN of the configuration entry for this location.

getConfigObjectDN() - Method in interface com.unboundid.directory.sdk.common.config.GenericConfig

Retrieves the DN of the entry containing the configuration for this extension.

getConfigObjectName() - Method in interface com.unboundid.directory.sdk.common.config.GenericConfig

Retrieves the name of the configuration object for this extension.

getConfigUpdateDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the update directory for this extension bundle.

getConnection(LDAPConnectionOptions, OperationType...) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendSet

Retrieves a newly-established connection to one of the servers in this backend set which is capable of processing all of the specified types of operations.

getConnectionID() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves the identifier that has been assigned to the associated client connection.

getConnectionID() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the identifier that has been assigned to the associated client connection.

getConnectTime() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves the time that the connection was established.

getCSN() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the CSN value if one was specified.

getCurrentEndpointURL() - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Return the URL or path identifying the destination endpoint to which this extension is transmitting data.

getCurrentEndpointURL() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Return the URL or path identifying the destination endpoint to which this extension is transmitting data.

getDatabaseChangeRecord() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the DatabaseChangeRecord that was detected from a RDBMS.

getDatabaseEntryType() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncSourceConfig

Gets the list of configured database entry types that are used to uniquely identify a set of data in the database that makes up an LDAP entry.

getDefaultApproximateMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the default approximate matching rule that will be used for attribute types with this syntax which do not explicitly specify their own approximate matching rule.

getDefaultEqualityMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the default equality matching rule that will be used for attribute types with this syntax which do not explicitly specify their own equality matching rule.

getDefaultOrderingMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the default ordering matching rule that will be used for attribute types with this syntax which do not explicitly specify their own ordering matching rule.

getDefaultSubstringMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the default substring matching rule that will be used for attribute types with this syntax which do not explicitly specify their own substring matching rule.

getDequeueTime() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the time that the operation was removed from the work queue, if available.

getDerefPolicy() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the dereference policy for the search.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the description for this attribute syntax, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the description for this attribute type, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the description for this DIT content rule, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the description for this DIT content rule, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the description for this matching rule, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves the description for this DIT content rule, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the description for this name form, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the description for this object class, if any.

getDescription() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncDestinationConfig

Gets the description for this Sync Destination.

getDescription() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncSourceConfig

Gets the description for this Sync Source.

getDescription() - Method in interface com.unboundid.directory.sdk.sync.config.SyncDestinationConfig

Gets the description for this Notification Destination.

getDescription() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns the configured description for this Sync Class.

getDestinationCorrelationAttributes() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns the set(s) of destination correlation attributes that are configured on this Sync Class.

getDestinationCorrelationAttributesOnDelete() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns the set(s) of destination correlation attributes that are configured on this Sync Class for DELETE operations.

getDestinationCreateOnlyAttributes() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns the set of attributes that are never allowed to be modified once an entry is created.

getDestinationEntryAfterChange() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Returns a representation of the target destination entry after it is modified or renamed.

getDestinationEntryBeforeChange() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Returns a representation of the target destination entry before it is modified or renamed.

getDiagnosticMessage() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves the diagnostic message for the result, if any.

getDiskSpaceConsumer() - Method in interface com.unboundid.directory.sdk.common.types.RegisteredDiskSpaceConsumer

Retrieves a reference to the disk space consumer that was registered with the server.

getDiskSpaceConsumerName() - Method in interface com.unboundid.directory.sdk.common.api.DiskSpaceConsumer

Retrieves the name that should be used to identify this disk space consumer.

getDiskSpaceConsumerPaths() - Method in interface com.unboundid.directory.sdk.common.api.DiskSpaceConsumer

Retrieves a list of filesystem paths in which this disk space consumer may store files which may consume a significant amount of space.

getDITContentRule(ObjectClass) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified DIT content rule from the server schema.

getDITContentRulesByStructuralClass() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of DIT content rules defined in the server schema, mapped from structural object class to the corresponding DIT structure rule definition.

getDITStructureRule(int) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified DIT structure rule from the server schema.

getDITStructureRule(NameForm) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified DIT structure rule from the server schema.

getDITStructureRulesByRuleID() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of DIT structure rules defined in the server schema, mapped from rule ID to the corresponding DIT structure rule definition.

getDN() - Method in interface com.unboundid.directory.sdk.common.operation.CompareRequest

Retrieves the DN of the entry to compare.

getDN() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Retrieves the DN of the entry to be deleted.

getDN() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Retrieves the DN of the entry to move and/or rename.

getDN() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyRequest

Retrieves the DN of the entry to modify.

getDN() - Method in interface com.unboundid.directory.sdk.common.operation.SimpleBindRequest

Retrieves the DN of the user attempting to bind.

getDN() - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves the DN of the entry as a string.

getDN() - Method in interface com.unboundid.directory.sdk.ds.types.ChangeSubscription

Retrieves the DN of the configuration entry defining this change subscription.

getDocumentationDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the documentation directory for this extension bundle.

getEnqueueTime() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the time that the operation was added to the work queue, if available.

getEntry() - Method in interface com.unboundid.directory.sdk.common.operation.AddRequest

Retrieves the entry to be added.

getEntry() - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableAddRequest

Retrieves the entry to be added.

getEntry(String) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves the specified entry from the backend.

getEntryCount() - Method in interface com.unboundid.directory.sdk.common.types.CompletedSearchOperationContext

Retrieves the number of entries that were returned to the client during the course of the search.

getEntryCount() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves the total number of entries contained in this backend, if that information is available.

getEntryType() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the database entry type that this change corresponds to (for example "account" or "subscriber").

getEqualityMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the equality matching rule for this attribute type, if any.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in interface com.unboundid.directory.sdk.common.internal.ExampleUsageProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.Task

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Retrieves a map containing examples of configurations that may be used for this extension.

getExamplesArgumentSets() - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Retrieves a map containing examples of configurations that may be used for this extension.

getExcludeReason() - Method in class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

Retrieves a message with additional information about the reason the entry should be excluded, if applicable.

getExpirationTime() - Method in interface com.unboundid.directory.sdk.ds.types.ChangeSubscription

Retrieves the expiration time for this change subscription.

getExtendedOperationName(String) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves the name of the extended operation with the provided OID.

getExtensionBundle() - Method in class com.unboundid.directory.sdk.common.types.InstallExtensionDetails

Retrieves the extension bundle being installed.

getExtensionBundle() - Method in class com.unboundid.directory.sdk.common.types.UpdateExtensionDetails

Retrieves the extension bundle being installed.

getExtensionBundleDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the root directory of this extension bundle.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.Task

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Retrieves a human-readable description for this extension.

getExtensionDescription() - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Retrieves a human-readable description for this extension.

getExtensionJarFile() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the extension jar file in the bundle.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Retrieves a human-readable name for this extension.

getExtensionName() - Method in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.Task

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Retrieves a human-readable name for this extension.

getExtensionName() - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Retrieves a human-readable name for this extension.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves a map of all defined extensions for this attribute type.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves a map of all defined extensions for this DIT content rule.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves a map of all defined extensions for this DIT structure rule.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves a map of all defined extensions for this matching rule use.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves a map of all defined extensions for this name form.

getExtensions() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves a map of all defined extensions for this object class.

getFilter() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the filter for the search.

getForwardTargetAddress() - Method in interface com.unboundid.directory.sdk.common.types.ForwardTarget

Retrieves the address of the target server.

getForwardTargetPort() - Method in interface com.unboundid.directory.sdk.common.types.ForwardTarget

Retrieves the port of the target server.

getForwardTargetProtocol() - Method in interface com.unboundid.directory.sdk.common.types.ForwardTarget

Retrieves the name of the protocol used to communicate with the target server.

getFullProductName() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the full name of the server.

getFullVendorName() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the full name of the server vendor.

getHardDeleteRequestControl() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Retrieves the hard-delete request control included in the delete request if it is present.

getHealthCheckResult() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the health check result currently assigned to this LDAP external server.

getHistoryDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the history directory for this extension bundle.

getHTTPConnectionHandlerConfigDN() - Method in interface com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig

Retrieves the DN of the configuration object for the HTTP connection handler that created the servlet extension.

getHTTPServerObject() - Method in interface com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig

Retrieves a handle to an object that may be used to interact with the HTTP server itself.

getIdentifiableInfo() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the DN that identifies the row that changed (for example "account_id=123").

getIdentifiableInfo() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return a String that can be used to correlate this change back to the source entry.

getIDToAbandon() - Method in interface com.unboundid.directory.sdk.common.operation.AbandonRequest

Retrieves the message ID of the operation to abandon.

getIgnoreChangesByUser() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncSourceConfig

Gets the configured users from which detected changes will be ignored.

getInstalledExtensionBundle() - Method in class com.unboundid.directory.sdk.common.types.UpdateExtensionDetails

Retrieves the extension bundle getting updated.

getInstanceName() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the instance name that has been assigned to the server.

getInternalConnection(String, boolean) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves an internal connection that is authenticated as the specified user.

getInternalConnection(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves an internal connection that is authenticated as the specified user.

getInternalRootConnection(boolean) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves an internal connection that is authenticated as a root user that is not subject to access control.

getInternalRootConnection() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves an internal connection that is authenticated as a root user that is not subject to access control.

getInternalRootConnection(boolean) - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves an internal connection that is authenticated as a root user that is not subject to access control.

getInternalRootConnection() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves an internal connection that is authenticated as a root user that is not subject to access control.

getInternalUserConnection(boolean) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves an internal connection that is authenticated as the same user as the associated client connection.

getInternalUserConnection() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves an internal connection that is authenticated as the same user that requested this operation and may be subject to access control.

getInternalUserConnection(boolean) - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves an internal connection that is authenticated as the same user that requested this operation and may be subject to access control.

getKeyManagers() - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Retrieves a set of key managers that may be used for operations within the server which may require access to certificates.

getLibrariesDir() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the lib directory for this extension bundle.

getLocation() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the location assigned to this LDAP external server, if any.

getLocation() - Method in interface com.unboundid.directory.sdk.proxy.types.ProxyServerContext

Retrieves the location that has been assigned to the server, if any.

getLogFile() - Method in interface com.unboundid.directory.sdk.common.config.FileBasedAccessLoggerConfig

Retrieves the path to the log file to which new log messages will be written.

getLogFile() - Method in interface com.unboundid.directory.sdk.common.config.FileBasedErrorLoggerConfig

Retrieves the path to the log file to which new log messages will be written.

getLogWriter() - Method in interface com.unboundid.directory.sdk.common.config.FileBasedAccessLoggerConfig

Returns the underlying writer for the server access log, which can be used to log arbitrary messages back through the core server logging framework.

getLogWriter() - Method in interface com.unboundid.directory.sdk.common.config.FileBasedErrorLoggerConfig

Returns the underlying writer for the server error logger, which can be used to log arbitrary messages back through the core server logging framework.

getMajorVersionNumber() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the major version number for the server.

getMatchedConnectionCriteria() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Returns a List containing the names of all the Connection Criteria that match this connection.

getMatchedDN() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves the matched DN for the result, if any.

getMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves the matching rule for this matching rule use.

getMatchingRule(String) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified matching rule from the server schema.

getMatchingRulesByName() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of matching rules defined in the server schema, mapped from lowercase name or OID to the matching rule definition.

getMatchingRuleUse(MatchingRule) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified matching rule use from the server schema.

getMatchingRuleUsesByMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of matching rule uses defined in the server schema, mapped from matching rule to its corresponding matching rule use.

getMaxOpenConnections() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncDestinationConfig

Gets the maximum number of connections that the Sync Destination is allowed to have open to the database at a given time.

getMaxOpenConnections() - Method in interface com.unboundid.directory.sdk.sync.config.JDBCSyncSourceConfig

Gets the maximum number of connections that the Sync Source is allowed to have open to the database at a given time.

getMessage() - Method in class com.unboundid.directory.sdk.ds.types.StartupPluginResult

Retrieves a message with additional information about the processing performed by this plugin, if available.

getMessageID() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the message ID for this operation from the client request.

getMessages() - Method in class com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

Retrieves the list of messages to print to the console.

getMessages() - Method in class com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

Retrieves the list of messages to print to the console.

getMessages() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves a list of messages providing additional information about the reason for the associated state and score.

getMinorVersionNumber() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the minor version number for the server.

getModifications() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyRequest

Retrieves the modifications to be applied.

getModifiedSourceAttributes() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the names of the attributes that were modified at the source.

getModifier() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the database user that made the change.

getMonitorAttributes() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves a list of attributes containing the data to include in the monitor entry generated from this monitor provider.

getMonitorInstanceName() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves the name that identifies this monitor provider instance.

getMonitorObjectClass() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves the name of the object class that will be used for monitor entries created from this monitor provider.

getMonitorProvider() - Method in interface com.unboundid.directory.sdk.common.types.RegisteredMonitorProvider

Retrieves a reference to the monitor provider that was registered with the server.

getName() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the name for this attribute syntax, if any.

getName() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the name for this matching rule, if any.

getName() - Method in enum com.unboundid.directory.sdk.common.types.AlertSeverity

Retrieves the name of this alert severity.

getName() - Method in interface com.unboundid.directory.sdk.ds.types.ChangeSubscription

Retrieves the name of this change subscription.

getName() - Method in interface com.unboundid.directory.sdk.proxy.types.Location

Retrieves the name assigned to this location.

getName() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns the name of this Sync Class.

getNameForm() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the name form for this DIT structure rule.

getNameForm(String) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified name form from the server schema.

getNameForm(ObjectClass) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified name form from the server schema.

getNameFormsByStructuralClass() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of name forms defined in the server schema, mapped from structural object class to the corresponding name form definition.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the name for this attribute syntax, or the numeric OID if it does not have a name.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the primary name for this attribute type, or the numeric OID if no names are defined.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the primary name for this DIT content rule, or the numeric OID of the structural object class no names are defined.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the name for this matching rule, or the numeric OID if it does not have a name.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the primary name for this name form, or the numeric OID if no names are defined.

getNameOrOID() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the primary name for this object class, or the numeric OID if no names are defined.

getNameOrRuleID() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the primary name for this DIT structure rule, or the rule ID if no names are defined.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the list of names for this attribute type, if any.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the list of names for this DIT content rule, if any.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the list of names for this DIT structure rule, if any.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves the list of names for this matching rule use, if any.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the list of names for this name form, if any.

getNames() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the list of names for this object class, if any.

getNewRDN() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Retrieves the new RDN to use for the entry.

getNewSuperiorDN() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Retrieves the DN for the new superior entry, if any.

getNextBatchOfChanges(TransactionContext, int, AtomicLong) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Return the next batch of change records from the database.

getNextBatchOfChanges(TransactionContext, int, AtomicLong) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Return the next batch of change records from the database.

getObjectClass(String, boolean) - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the specified object class from the server schema, optionally creating a new class with the specified name if none is defined.

getObjectClassesByName() - Method in interface com.unboundid.directory.sdk.common.schema.Schema

Retrieves the set of object classes defined in the server schema, mapped from lowercase name or OID to the object class definition.

getObjectClassType() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the object class type for this object class.

getOID() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the numeric OID for this attribute syntax.

getOID() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the numeric OID for this attribute type.

getOID() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the numeric OID for this matching rule.

getOID() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the numeric OID for this name form.

getOID() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the numeric OID for this object class.

getOperationID() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the identifier that has been assigned to this operation for the associated client connection.

getOperationName() - Method in enum com.unboundid.directory.sdk.common.types.OperationType

Retrieves the human-readable name for this operation type.

getOperationType() - Method in interface com.unboundid.directory.sdk.common.operation.Request

Retrieves the operation type for this request.

getOperationType() - Method in interface com.unboundid.directory.sdk.common.operation.Result

Retrieves the operation type for this result.

getOperationType() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the operation type for this operation.

getOptionalAttributeChain() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the set of optional attributes for this object class and all of its superior classes.

getOptionalAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the set of optional attributes for this DIT content rule, if any.

getOptionalAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the set of optional attributes for this name form, if any.

getOptionalAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the set of optional attributes for this object class.

getOrderingMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the ordering matching rule for this attribute type, if any.

getParentBackend() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves information about the parent for the associated backend, if any.

getParsedDN() - Method in interface com.unboundid.directory.sdk.common.types.Entry

Retrieves a parsed representation of the DN for the entry.

getPassword() - Method in interface com.unboundid.directory.sdk.common.operation.SimpleBindRequest

Retrieves the password for the bind request.

getPatchVersionNumber() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the patch version number for the server.

getPlaintextValue(ByteString) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Attempts to determine the plaintext password used to generate the provided encoded password.

getPointVersionNumber() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the point version number for the server.

getPostStepResult() - Method in exception com.unboundid.directory.sdk.sync.types.EndpointException

Gets the result object which indicates how the Synchronization server should proceed with the sync operation.

getPreferredFailoverLocations() - Method in interface com.unboundid.directory.sdk.proxy.types.Location

Retrieves an ordered list of the preferred failover locations for this location.

getProcessingEndTime() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the time that the worker thread completed processing for the operation.

getProcessingStartTime() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the time that the worker thread began processing the operation.

getProcessingTimeMillis() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the length of time in milliseconds that the worker thread spent processing the operation.

getProcessingTimeNanos() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the length of time in nanoseconds that the worker thread spent processing the operation.

getProhibitedAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the set of prohibited attributes for this DIT content rule, if any.

getProperty(Object) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the property value (if one exists) for the given key.

getProtocol() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves the name of the protocol that the client is using to communicate with the server.

getQueueWaitTimeMillis() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves the length of time in milliseconds that the operation was held in the work queue before being picked up for processing by a worker thread.

getReferenceCount() - Method in interface com.unboundid.directory.sdk.common.types.CompletedSearchOperationContext

Retrieves the number of references that were returned to the client during the course of the search.

getReferralURLs() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves the referral URLs for the result.

getRequest() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves the request for the associated operation.

getRequestControls() - Method in interface com.unboundid.directory.sdk.common.operation.Request

Retrieves the set of controls included in the request.

getRequestOID() - Method in interface com.unboundid.directory.sdk.common.operation.ExtendedRequest

Retrieves the OID for the extended request.

getRequestValue() - Method in interface com.unboundid.directory.sdk.common.operation.ExtendedRequest

Retrieves the value for the extended request, if any.

getRequiredAttributeChain() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the set of required attributes for this object class and all of its superior classes.

getRequiredAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the set of required attributes for this DIT content rule, if any.

getRequiredAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the set of required attributes for this name form.

getRequiredAttributes() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the set of required attributes for this object class.

getResult() - Method in interface com.unboundid.directory.sdk.common.types.CompletedOperationContext

Retrieves information about the result of the operation processing.

getResultCode() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves the result code for the result.

getResultControls() - Method in interface com.unboundid.directory.sdk.common.operation.Result

Retrieves the set of controls included in the result.

getResultOID() - Method in interface com.unboundid.directory.sdk.common.operation.ExtendedResult

Retrieves the OID for the extended result, if any.

getResultValue() - Method in interface com.unboundid.directory.sdk.common.operation.ExtendedResult

Retrieves the value for the extended result, if any.

getRuleID() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the rule ID for this DIT structure rule.

getSASLCredentials() - Method in interface com.unboundid.directory.sdk.common.operation.SASLBindRequest

Retrieves the SASL credentials for the bind request, if any.

getSASLMechanism() - Method in interface com.unboundid.directory.sdk.common.operation.SASLBindRequest

Retrieves the name of the SASL mechanism to use.

getSASLMechanismName() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Retrieves the name of the SASL mechanism used to authenticate, if applicable.

getSchema() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves a reference to the server schema.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the name of the schema file in which this attribute type is defined.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the name of the schema file in which this DIT content rule is defined.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the name of the schema file in which this DIT structure rule is defined.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves the name of the schema file in which this matching rule use is defined.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the name of the schema file in which this name form is defined.

getSchemaFileName() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the name of the schema file in which this object class is defined.

getScope() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the scope for the search.

getScore() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves the numeric score for the associated server, which may be used to help differentiate the server from other servers with the same state.

getSerializableValue() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the generic (serializable) startpoint value if one was specified.

getServerAddress() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the address for this LDAP external server.

getServerContext() - Method in interface com.unboundid.directory.sdk.common.config.GenericConfig

Retrieves a handle to the server context for the server in which this extension is running.

getServerContext() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves information about the server with which the client connection is associated.

getServerContext() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves information about the server in which this operation is being processed.

getServerContext() - Method in interface com.unboundid.directory.sdk.ds.config.GenericDirectoryConfig

Retrieves a handle to the server context for the server in which this extension is running.

getServerContext() - Method in interface com.unboundid.directory.sdk.ds.types.TaskContext

Retrieves information about the server in which the task is being processed.

getServerContext() - Method in interface com.unboundid.directory.sdk.http.config.GenericHTTPConfig

Retrieves a handle to the server context for the server in which this extension is running.

getServerContext() - Method in interface com.unboundid.directory.sdk.proxy.config.GenericProxyConfig

Retrieves a handle to the server context for the server in which this extension is running.

getServerContext() - Method in interface com.unboundid.directory.sdk.proxy.types.ProxyOperationContext

Retrieves information about the Directory Proxy Server in which this operation is being processed.

getServerContext() - Method in interface com.unboundid.directory.sdk.sync.config.GenericSyncConfig

Retrieves a handle to the server context for the server in which this extension is running.

getServerInetAddress() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves an InetAddress representing the address on the server to which the client established the connection, if available.

getServerName() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the server name if one was specified, representing the External Server at which to set the start point.

getServerPort() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Retrieves the port for this LDAP external server.

getServerRoot() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the path to the server root directory.

getServerSASLCredentials() - Method in interface com.unboundid.directory.sdk.common.operation.BindResult

Retrieves the server SASL credentials for the bind result, if any.

getServerSDKVersion() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the server SDK version number the extensions where built against.

getServerShutdownListener() - Method in interface com.unboundid.directory.sdk.common.types.RegisteredServerShutdownListener

Retrieves a reference to the shutdown listener that was registered with the server.

getServletFilters() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a list of servlet filter instances that should be installed with the created servlet instance, in the order they should be invoked.

getServletFilters() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Retrieves a list of servlet filter instances that should be installed with the created servlet instance, in the order they should be invoked.

getServletInitOrder() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves the order in which the servlet should be started.

getServletInitOrder() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Retrieves the order in which the servlet should be started.

getServletInitParameters() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a map of initialization parameters that should be provided to the servlet when it is initialized.

getServletInitParameters() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Retrieves a map of initialization parameters that should be provided to the servlet when it is initialized.

getServletPaths() - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Retrieves a list of the request paths for which the associated servlet should be invoked.

getServletPaths() - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Retrieves a list of the request paths for which the associated servlet should be invoked.

getShortVendorName() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the compact name of the server vendor.

getSizeLimit() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the size limit for the search.

getSoftDeletedEntry() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteResult

Retrieves the soft-deleted entry if this DeleteResult is in response to a soft-delete request.

getSoftDeleteRequestControl() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Retrieves the soft-delete request control included in the delete request if it is present.

getSourceEntry() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the Entry that was fetched from the sync source.

getSourceRevision() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves a value which identifies the source revision (in the version control system used to hold the server source code) from which the server was built.

getStartpoint() - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Gets the current value of the startpoint for change detection.

getStartpoint() - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Gets the current value of the startpoint for change detection.

getStartpointType() - Method in class com.unboundid.directory.sdk.sync.types.SetStartpointOptions

Gets the startpointType (i.e.

getStartTime() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the time that the server was started.

getStartupDependencies() - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Retrieves the set of startup dependencies which must be resolved in order for this plugin to be invoked at server startup.

getStartupDependencies() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Retrieves the set of startup dependencies which must be resolved in order for this plugin to be invoked at server startup.

getStartupID() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves a compact ID that was generated at the time the server was started.

getStartupUUID() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves a unique identifier that was generated at the time the server was started.

getState() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves the health check state for the associated server.

getStorageSchemeName() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Retrieves the name for this password storage scheme.

getStructuralClass() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves the structural object class for this DIT content rule.

getStructuralClass() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the structural object class for this DIT content rule.

getStructuralClass() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves the structural object class for this name form.

getSubordinateBackends() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves information about any backends which are immediately subordinate to the associated backend.

getSubstringMatchingRule() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the substring matching rule for this attribute type, if any.

getSuperiorClasses() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves the immediate superior classes for this object class, if any.

getSuperiorRules() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves the set of superior DIT structure rules for this rule, if any.

getSuperiorType() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the superior type for this attribute type, if any.

getSupportContact() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the support contact for this extension bundle.

getSupportedControls() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves the OIDs of any controls supported by this extended operation handler.

getSupportedExtensions() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves the OIDs of the extended operation types supported by this extended operation handler.

getSupportedFeatures() - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Retrieves the OIDs of any features supported by this extended operation handler that should be advertised in the server root DSE.

getSyncClass() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the SyncClass for the operation being processed.

getSyncClassName() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the name of the Sync Class for the operation being processed.

getSyncPipeName() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the name of the Sync Pipe for the operation being processed.

getSyntax() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the attribute syntax for this attribute type.

getSyntaxOID() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the OID of the attribute syntax with which this matching rule is most closely associated.

getTableName() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

Get the database table on which the change occurred.

getTaskEntry() - Method in interface com.unboundid.directory.sdk.ds.types.TaskContext

Retrieves a read-only copy of the entry that contains the definition for this task.

getTaskEntryDN() - Method in interface com.unboundid.directory.sdk.ds.types.TaskContext

Retrieves the DN of the entry that contains the definition for this task.

getTaskID() - Method in interface com.unboundid.directory.sdk.ds.types.TaskContext

Retrieves the unique identifier for this task.

getTaskName() - Method in class com.unboundid.directory.sdk.ds.api.Task

Retrieves a human-readable name that may be used for this task.

getTime() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves the time that this health check result was created.

getTimeLimitSeconds() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves the time limit for the search in seconds.

getTimestampFromString(String) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Returns a SQL Timestamp based on the string value that is passed in.

getTitle() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Retrieves the title of this extension bundle.

getTransactionIsolation() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Retrieves the current transaction isolation level for the underlying Connection.

getTrustManagers() - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Retrieves a set of trust managers that may be used for operations within the server which may need to determine whether to trust a presented certificate chain.

getType() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return the type of this SynchronizationOperation.

getTypesOnly() - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Indicates whether search result entries should contain only attribute types or both types and values.

getUndeletedEntry() - Method in interface com.unboundid.directory.sdk.common.operation.AddResult

Retrieves the undeleted entry if this AddResult is in response to an undelete request.

getUniqueId() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Return a unique ID for this SyncOperation.

getUpdateIntervalMillis() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Retrieves the update interval in milliseconds that should be used for this monitor provider.

getUrl() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Get the URL of the extension bundle.

getUsage() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves the usage for this attribute type.

getVendor() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Retrieves the vendor name of this extension bundle.

getVendorId() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Retrieves the vendor ID of this extension bundle.

getVersion() - Method in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Retrieves the version string of this extension bundle.

getVersionQualifier() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Retrieves the version qualifier string for the server.

getWarnings() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Returns a list of warning messages (if any) about this SyncOperation.

getWritabilityMode() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Retrieves the WritabilityMode for the backend.

H

handleAlert(AlertNotification) - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Performs any processing which may be necessary to handle the provided alert notification.

handleAlert(AlertNotification) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Performs any processing which may be necessary to handle the provided alert notification.

handlesEntry(String) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether this backend should contain the entry with the specified DN.

hasAttribute(AttributeType) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified type.

hasAttribute(String) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name.

hasAttribute(AttributeType, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and set of options.

hasAttribute(String, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and set of options.

hasAttributeValue(AttributeType, String) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and value.

hasAttributeValue(String, String) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and value.

hasAttributeValue(AttributeType, byte[]) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and value.

hasAttributeValue(String, byte[]) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether the entry contains an attribute with the specified name and value.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves the hash code for this attribute syntax.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves a hash code for this attribute type.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves a hash code for this DIT content rule.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves a hash code for this DIT structure rule.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the hash code for this matching rule.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves a hash code for this matching rule use.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves a hash code for this name form.

hashCode() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves a hash code for this object class.

hashCode() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves a hash code for this health check result.

hasName(String) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Indicates whether the provided string is equal to any of the defined names for this matching rule use.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Indicates whether the provided string matches the name or numeric OID for this attribute syntax.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether the provided string is equal to the OID or any of the defined names for this attribute type.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided string is equal to any of the defined names or the OID of the structural class for this DIT content rule.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Indicates whether the provided string matches the name or numeric OID for this matching rule.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether the provided string is equal to the OID or any of the defined names for this name form.

hasNameOrOID(String) - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether the provided string is equal to the OID or any of the defined names for this object class.

hasNameOrRuleID(String) - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Indicates whether the provided string is equal to any of the defined names or the rule ID for this DIT structure rule.

HealthCheckResult - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used to assess the health of an LDAP external server.

HealthCheckState - Enum in com.unboundid.directory.sdk.proxy.types

This enum defines the set of possible states that may be returned by LDAP health checks.

HISTORY_PATH_RELATIVE - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The relative path where the config files are.

HTTPOperationLogger - Class in com.unboundid.directory.sdk.http.api

This class defines an API that must be implemented by extensions which record information about interaction with HTTP clients.

HTTPOperationLogger() - Constructor for class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Creates a new instance of this HTTP operation logger.

HTTPOperationLoggerConfig - Interface in com.unboundid.directory.sdk.http.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an HTTP operation logger.

HTTPServerContext - Interface in com.unboundid.directory.sdk.http.types

This interface may be used to obtain information about the HTTP Server (or related product) in which an extension is running.

HTTPServletExtension - Class in com.unboundid.directory.sdk.http.api

This class defines an API that must be implemented by extensions which create servlets for use with an HTTP connection handler.

HTTPServletExtension() - Constructor for class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Creates a new instance of this HTTP servlet extension.

HTTPServletExtensionConfig - Interface in com.unboundid.directory.sdk.http.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an HTTP servlet extension.

I

IdentityMapper - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which attempt to map a username to a user defined in the server.

IdentityMapper() - Constructor for class com.unboundid.directory.sdk.ds.api.IdentityMapper

Creates a new instance of this identity mapper.

IdentityMapperConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an identity mapper.

idStringToDN(String, String) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

Takes an identifier string (for example from the database changelog table) and creates a DN from the components.

includeEntry() - Method in class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

Indicates whether the associated entry should be still be included in the LDIF import or export.

IndexType - Enum in com.unboundid.directory.sdk.ds.types

This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the directory server.

initializeAccessLogger(ServerContext, AccessLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Initializes this access logger.

initializeAccessLogger(ServerContext, FileBasedAccessLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Initializes this file-based access logger.

initializeAccessLogger(ServerContext, AccessLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Initializes this access logger.

initializeAccessLogger(ServerContext, FileBasedAccessLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Initializes this access logger.

initializeAlertHandler(ServerContext, AlertHandlerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Initializes this alert handler.

initializeAlertHandler(ServerContext, AlertHandlerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Initializes this alert handler.

initializeCertificateMapper(DirectoryServerContext, CertificateMapperConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Initializes this certificate mapper.

initializeCertificateMapper(DirectoryServerContext, CertificateMapperConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Initializes this certificate mapper.

initializeChangeSubscriptionHandler(DirectoryServerContext, ChangeSubscriptionHandlerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Initializes this change subscription handler.

initializeChangeSubscriptionHandler(DirectoryServerContext, ChangeSubscriptionHandlerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Initializes this change subscription handler.

initializeCipherStreamProvider(DirectoryServerContext, CipherStreamProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Initializes this cipher stream provider.

initializeErrorLogger(ServerContext, ErrorLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Initializes this error logger.

initializeErrorLogger(ServerContext, FileBasedErrorLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Initializes this file-based error logger.

initializeErrorLogger(ServerContext, ErrorLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Initializes this error logger.

initializeErrorLogger(ServerContext, FileBasedErrorLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Initializes this file-based error logger.

initializeExtendedOperationHandler(DirectoryServerContext, ExtendedOperationHandlerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Initializes this extended operation handler.

initializeHTTPOperationLogger(HTTPServerContext, HTTPOperationLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Initializes this HTTP operation logger.

initializeHTTPOperationLogger(HTTPServerContext, HTTPOperationLoggerConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Initializes this scripted HTTP operation logger.

initializeIdentityMapper(DirectoryServerContext, IdentityMapperConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Initializes this identity mapper.

initializeIdentityMapper(DirectoryServerContext, IdentityMapperConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Initializes this identity mapper.

initializeJDBCSyncDestination(TransactionContext, SyncServerContext, JDBCSyncDestinationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

This hook is called when a Sync Pipe first starts up, or when the resync process first starts up.

initializeJDBCSyncDestination(TransactionContext, SyncServerContext, JDBCSyncDestinationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

This hook is called when a Sync Pipe first starts up, or when the Resync process first starts up.

initializeJDBCSyncSource(TransactionContext, SyncServerContext, JDBCSyncSourceConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

This hook is called when a Sync Pipe first starts up, when the resync process first starts up, or when the set-startpoint subcommand is called from the realtime-sync command line tool.

initializeJDBCSyncSource(TransactionContext, SyncServerContext, JDBCSyncSourceConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

This hook is called when a Sync Pipe first starts up, when the resync process first starts up, or when the set-startpoint subcommand is called from the realtime-sync command line tool.

initializeKeyManagerProvider(ServerContext, KeyManagerProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Initializes this key manager provider.

initializeLDAPHealthCheck(ProxyServerContext, LDAPHealthCheckConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Initializes this LDAP health check.

initializeLDAPHealthCheck(ProxyServerContext, LDAPHealthCheckConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Initializes this LDAP health check.

initializeLDAPSyncDestinationPlugin(SyncServerContext, LDAPSyncDestinationPluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Initializes this LDAP sync destination plugin.

initializeLDAPSyncDestinationPlugin(SyncServerContext, LDAPSyncDestinationPluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Initializes this LDAP sync destination plugin.

initializeLDAPSyncSourcePlugin(SyncServerContext, LDAPSyncSourcePluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Initializes this LDAP sync source plugin.

initializeLDAPSyncSourcePlugin(SyncServerContext, LDAPSyncSourcePluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Initializes this LDAP sync source plugin.

initializeMonitorProvider(ServerContext, MonitorProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Initializes this monitor provider.

initializePasswordGenerator(DirectoryServerContext, PasswordGeneratorConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Initializes this password generator.

initializePasswordGenerator(DirectoryServerContext, PasswordGeneratorConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Initializes this password generator.

initializePasswordStorageScheme(DirectoryServerContext, PasswordStorageSchemeConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Initializes this password storage scheme.

initializePasswordValidator(DirectoryServerContext, PasswordValidatorConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Initializes this password validator.

initializePasswordValidator(DirectoryServerContext, PasswordValidatorConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Initializes this password validator.

initializePlacementAlgorithm(ProxyServerContext, PlacementAlgorithmConfig, ArgumentParser, String, List<BackendSet>) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Initializes this placement algorithm.

initializePlugin(DirectoryServerContext, PluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Initializes this plugin.

initializePlugin(DirectoryServerContext, PluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Initializes this plugin.

initializeProxyTransformation(ProxyServerContext, ProxyTransformationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Initializes this proxy transformation.

initializeProxyTransformation(ProxyServerContext, ProxyTransformationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Initializes this proxy transformation.

initializeSyncDestination(SyncServerContext, SyncDestinationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Initializes this sync destination.

initializeSyncDestination(SyncServerContext, SyncDestinationConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Initializes this sync destination.

initializeSyncPipePlugin(SyncServerContext, SyncPipePluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Initializes this sync pipe plugin.

initializeSyncPipePlugin(SyncServerContext, SyncPipePluginConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Initializes this sync pipe plugin.

initializeTask(DirectoryServerContext, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.Task

Initializes this task.

initializeTask(DirectoryServerContext, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedTask

Initializes this task.

initializeTrustManagerProvider(ServerContext, TrustManagerProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Initializes this trust manager provider.

initializeVirtualAttributeProvider(DirectoryServerContext, VirtualAttributeProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Initializes this virtual attribute provider.

initializeVirtualAttributeProvider(DirectoryServerContext, VirtualAttributeProviderConfig, ArgumentParser) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Initializes this virtual attribute provider.

InstallExtensionDetails - Class in com.unboundid.directory.sdk.common.types

This class defines a structure which may be used to provide information about the manage extension installation state.

InstallExtensionDetails(ExtensionBundle) - Constructor for class com.unboundid.directory.sdk.common.types.InstallExtensionDetails

Creates a new install extension details with the provided information.

IntermediateResponsePluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by an intermediate response plugin.

IntermediateResponsePluginResult(boolean, boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Creates a new intermediate response plugin result with the provided information.

InternalConnection - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to perform internal operations within the server.

interruptTask(TaskReturnState, String) - Method in class com.unboundid.directory.sdk.ds.api.Task

Attempts to interrupt the execution of this task.

invert() - Method in enum com.unboundid.directory.sdk.common.types.ConditionResult

Retrieves the condition result value which is the inverse of this value.

invert(ConditionResult) - Static method in enum com.unboundid.directory.sdk.common.types.ConditionResult

Retrieves the condition result value which is the inverse of the provided result.

isAuthenticated() - Method in interface com.unboundid.directory.sdk.common.types.AuthInfo

Indicates whether the associated client has authenticated to the server.

isAuthenticated() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Indicates whether the client has authenticated to the server.

isAvailable() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Indicates whether this LDAP external server currently has a health check state of AVAILABLE.

isClosed() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Checks whether this TransactionContext is closed.

isCollective() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether this attribute type is declared collective in the server schema.

isConfigurationAcceptable(AccessLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(AlertHandlerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.AlertHandler

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ErrorLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(FileBasedAccessLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(FileBasedErrorLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(KeyManagerProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(MonitorProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(TrustManagerProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(T, ArgumentParser, List<String>) - Method in interface com.unboundid.directory.sdk.common.internal.Reconfigurable

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(AccessLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(AlertHandlerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ErrorLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(FileBasedAccessLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(FileBasedErrorLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(CertificateMapperConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ChangeSubscriptionHandlerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(CipherStreamProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.CipherStreamProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ExtendedOperationHandlerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(IdentityMapperConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PasswordGeneratorConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PasswordStorageSchemeConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PasswordValidatorConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.Plugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(VirtualAttributeProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(CertificateMapperConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ChangeSubscriptionHandlerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(IdentityMapperConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PasswordGeneratorConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PasswordValidatorConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(VirtualAttributeProviderConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(HTTPOperationLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(HTTPServletExtensionConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.http.api.HTTPServletExtension

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(HTTPOperationLoggerConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(HTTPServletExtensionConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPHealthCheckConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(PlacementAlgorithmConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ProxyTransformationConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPHealthCheckConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(ProxyTransformationConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPSyncDestinationPluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPSyncSourcePluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(SyncPipePluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPSyncDestinationPluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(LDAPSyncSourcePluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isConfigurationAcceptable(SyncPipePluginConfig, ArgumentParser, List<String>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

isCreatesAsModifies() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns whether this Sync class will convert create operations into modify operations if the destination entry to be modified already exists.

isDirectoryFunctionalityAvailable() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the extension is running in a server that has Directory Server functionality available.

isDirectoryProxyFunctionalityAvailable() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the extension is running in a server that has Directory Proxy Server functionality available.

isExplicitlyIndexed(String, IndexType) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the backend has been explicitly configured with an index for the specified attribute type and index type.

isHardDelete() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Indicates whether this request will result in the target entry being hard-deleted.

isIgnoreZeroLengthValues() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns whether this Sync Class will prevent writes to the destination that contain empty (zero-length) values.

isIndexed(String, IndexType) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the backend considers filter components involving the specified attribute type and index type indexed.

isIndexed(Filter) - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the backend may consider a search with the provided filter as indexed.

isInternal() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Indicates whether this represents an internal client connection.

isInternalOperation() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Indicates whether this operation was initiated within the server rather than by an external client.

isInterruptible() - Method in class com.unboundid.directory.sdk.ds.api.Task

Indicates whether this task may be interrupted before it has completed (e.g., canceled by an administrator or aborted at server shutdown).

isLocal() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the backend is considered local (i.e., holds data in a repository that is local to and entirely managed by the server).

isLocal() - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Indicates whether this LDAP external server is in the same location as the Directory Proxy Server that is referencing it.

isModifiesAsCreates() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns whether this Sync class will convert modify operations into create operations if the destination entry to be modified does not exist.

isModifyDN() - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Determines whether this SyncOperation represents a modify DN operation on the source entry (if the source is an LDAP directory).

isMultiValued() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Indicates whether this virtual attribute provider may generate attributes with multiple values.

isMultiValued() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Indicates whether this virtual attribute provider may generate attributes with multiple values.

isNoUserModification() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether this attribute type is declared NO-USER-MODIFICATION in the server schema.

isNullOrEmpty(String) - Static method in class com.unboundid.directory.sdk.sync.util.ScriptUtils

String helper method to check if a value is a null object or empty string.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether this attribute type is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether this DIT content rule is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Indicates whether this DIT structure rule is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Indicates whether this matching rule is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Indicates whether this matching rule use is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether this name form is declared obsolete in the server schema.

isObsolete() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether this object class is declared obsolete in the server schema.

isOperational() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether this attribute type has an operational usage.

isOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided attribute type is optional for this DIT content rule.

isOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether the provided attribute type is optional for this name form.

isOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether the provided attribute type is optional for use with this object class or any of its superior classes.

isPasswordAcceptable(OperationContext, ByteString, Set<ByteString>, Entry, StringBuilder) - Method in class com.unboundid.directory.sdk.ds.api.PasswordValidator

Indicates whether the proposed password is acceptable for the specified user.

isPasswordAcceptable(OperationContext, ByteString, Set<ByteString>, Entry, StringBuilder) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Indicates whether the proposed password is acceptable for the specified user.

isPrivateBackend() - Method in interface com.unboundid.directory.sdk.ds.types.BackendContext

Indicates whether the backend is considered a private backend (with data generated and/or maintained by the server) rather than a public backend (with user data provided and managed by clients).

isProhibited(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided attribute type is prohibited for this DIT content rule.

isReplicationOperation() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Indicates whether this operation was initiated via replication rather than within the local server.

isRequired(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided attribute type is required by this DIT content rule.

isRequired(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether the provided attribute type is required by this name form.

isRequired(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether the provided attribute type is required for use with this object class or any of its superior classes.

isRequiredOrOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Indicates whether the provided attribute type is allowed for use with this DIT content rule as either a required or optional type.

isRequiredOrOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Indicates whether the provided attribute type is allowed for use with this name form as either a required or optional type.

isRequiredOrOptional(AttributeType) - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Indicates whether the provided attribute type is allowed for use with this object class or any of its superior classes, either as a required or optional type.

isReversible() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether this password storage scheme encodes passwords in a form that allows the original plaintext value to be obtained from the encoded representation.

isRunning() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the server is currently running.

isSecure() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Indicates whether the client is communicating with the server in a secure manner.

isSecure() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Indicates whether this operation was requested over a secure connection.

isSecure() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether this password storage scheme encodes passwords in a form that may be considered secure.

isShuttingDown() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the server is in the process of shutting down.

isSingleValued() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Indicates whether this attribute type is declared single-valued in the server schema.

isSoftDelete() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Indicates whether this request will result in the target entry being soft-deleted.

isStarting() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the server is in the process of starting up.

isSyncFunctionalityAvailable() - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Indicates whether the extension is running in a server that has Synchronization Server functionality available.

isTimedOut() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Checks whether this TransactionContext has timed out.

isUndelete() - Method in interface com.unboundid.directory.sdk.common.operation.AddRequest

Indicates whether this AddRequest contains the UndeleteRequestControl.

isUnindexed() - Method in interface com.unboundid.directory.sdk.common.types.CompletedSearchOperationContext

Indicates whether the search operation was considered unindexed.

isUseReversibleForm() - Method in interface com.unboundid.directory.sdk.sync.types.SyncClass

Returns whether this Sync Class will use the ADD/DELETE modification type or the REPLACE modification type when making modifications on the destination.

J

JDBCSyncDestination - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions in order to synchronize data into a relational database.

JDBCSyncDestination() - Constructor for class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Creates a new instance of this JDBC Sync Destination.

JDBCSyncDestinationConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a JDBC Sync Destination.

JDBCSyncSource - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions in order to synchronize data out of a relational database.

JDBCSyncSource() - Constructor for class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Creates a new instance of this JDBC Sync Source.

JDBCSyncSourceConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a JDBC Sync Source.

K

KeyManagerProvider - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which provide access to key managers.

KeyManagerProvider() - Constructor for class com.unboundid.directory.sdk.common.api.KeyManagerProvider

Creates a new instance of this key manager provider.

KeyManagerProviderConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a key manager provider.

L

LDAPHealthCheck - Class in com.unboundid.directory.sdk.proxy.api

This class defines an API that must be implemented by extensions which are used to assess the health of backend servers accessed through the Directory Proxy Server.

LDAPHealthCheck() - Constructor for class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Creates a new instance of this LDAP health check.

LDAPHealthCheckConfig - Interface in com.unboundid.directory.sdk.proxy.config

This interface defines a set of methods that may be used to obtain information about the general configuration for an LDAP health check.

LDAPSyncDestinationPlugin - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions that perform processing on synchronization operations within an LDAP Sync Destination.

LDAPSyncDestinationPlugin() - Constructor for class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Creates a new instance of this LDAP sync destination plugin.

LDAPSyncDestinationPluginConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration of a sync pipe plugin.

LDAPSyncSourcePlugin - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions that perform processing on synchronization operations within an LDAP Sync Source.

LDAPSyncSourcePlugin() - Constructor for class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Creates a new instance of this LDAP sync source plugin.

LDAPSyncSourcePluginConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration of a sync pipe plugin.

LDIFPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by an LDIF import or export plugin.

LDIFPluginResult(boolean, boolean, CharSequence) - Constructor for class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

Creates a new LDIF plugin result with the provided information.

LIBRARIES_PATH_RELATIVE - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The relative path where all the libraries (jar files) are.

listAllEntries(TransactionContext, String, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Gets a list of all the entries in the database for a given entry type.

listAllEntries(TransactionContext, Iterator<String>, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Deprecated.

listAllEntries(TransactionContext, String, Iterator<String>, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

Gets a list of all the entries in the database from a given file input.

listAllEntries(TransactionContext, String, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Gets a list of all the entries in the database for a given entry type.

listAllEntries(TransactionContext, Iterator<String>, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Deprecated.

listAllEntries(TransactionContext, String, Iterator<String>, BlockingQueue<DatabaseChangeRecord>) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

Gets a list of all the entries in the database from a given file input.

Location - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used interact with a location defined in the server.

logAbandonForward(OperationContext, AbandonRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an abandon request that will be forwarded to another server.

logAbandonForward(OperationContext, AbandonRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an abandon request that will be forwarded to another server.

logAbandonForward(OperationContext, AbandonRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an abandon request that will be forwarded to another server.

logAbandonForward(OperationContext, AbandonRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an abandon request that will be forwarded to another server.

logAbandonRequest(OperationContext, AbandonRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an abandon request received from a client.

logAbandonRequest(OperationContext, AbandonRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an abandon request received from a client.

logAbandonRequest(OperationContext, AbandonRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an abandon request received from a client.

logAbandonRequest(OperationContext, AbandonRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an abandon request received from a client.

logAbandonResult(CompletedOperationContext, AbandonRequest, GenericResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing an abandon request.

logAbandonResult(CompletedOperationContext, AbandonRequest, GenericResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing an abandon request.

logAbandonResult(CompletedOperationContext, AbandonRequest, GenericResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing an abandon request.

logAbandonResult(CompletedOperationContext, AbandonRequest, GenericResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing an abandon request.

logAddForward(OperationContext, AddRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an add request that will be forwarded to another server.

logAddForward(OperationContext, AddRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an add request that will be forwarded to another server.

logAddForward(OperationContext, AddRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an add request that will be forwarded to another server.

logAddForward(OperationContext, AddRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an add request that will be forwarded to another server.

logAddForwardFailure(OperationContext, AddRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward an add request to another server.

logAddForwardFailure(OperationContext, AddRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward an add request to another server.

logAddForwardFailure(OperationContext, AddRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward an add request to another server.

logAddForwardFailure(OperationContext, AddRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward an add request to another server.

logAddRequest(OperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an add request received from a client.

logAddRequest(OperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an add request received from a client.

logAddRequest(OperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an add request received from a client.

logAddRequest(OperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an add request received from a client.

logAddResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing an add request.

logAddResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing an add request.

logAddResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing an add request.

logAddResponse(CompletedOperationContext, AddRequest, AddResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing an add request.

logBindForward(OperationContext, SimpleBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a simple bind request that will be forwarded to another server.

logBindForward(OperationContext, SASLBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a SASL bind request that will be forwarded to another server.

logBindForward(OperationContext, SimpleBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a simple bind request that will be forwarded to another server.

logBindForward(OperationContext, SASLBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a SASL bind request that will be forwarded to another server.

logBindForward(OperationContext, SimpleBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a simple bind request that will be forwarded to another server.

logBindForward(OperationContext, SASLBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a SASL bind request that will be forwarded to another server.

logBindForward(OperationContext, SimpleBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a simple bind request that will be forwarded to another server.

logBindForward(OperationContext, SASLBindRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a SASL bind request that will be forwarded to another server.

logBindForwardFailure(OperationContext, SimpleBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a simple bind request to another server.

logBindForwardFailure(OperationContext, SASLBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.

logBindForwardFailure(OperationContext, SimpleBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a simple bind request to another server.

logBindForwardFailure(OperationContext, SASLBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.

logBindForwardFailure(OperationContext, SimpleBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a simple bind request to another server.

logBindForwardFailure(OperationContext, SASLBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.

logBindForwardFailure(OperationContext, SimpleBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a simple bind request to another server.

logBindForwardFailure(OperationContext, SASLBindRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.

logBindRequest(OperationContext, SimpleBindRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a simple bind request received from a client.

logBindRequest(OperationContext, SASLBindRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a SASL bind request received from a client.

logBindRequest(OperationContext, SimpleBindRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a simple bind request received from a client.

logBindRequest(OperationContext, SASLBindRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a SASL bind request received from a client.

logBindRequest(OperationContext, SimpleBindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a simple bind request received from a client.

logBindRequest(OperationContext, SASLBindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a SASL bind request received from a client.

logBindRequest(OperationContext, SimpleBindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a simple bind request received from a client.

logBindRequest(OperationContext, SASLBindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a SASL bind request received from a client.

logBindResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a simple bind request.

logBindResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a SASL bind request.

logBindResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a simple bind request.

logBindResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a SASL bind request.

logBindResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a simple bind request.

logBindResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a SASL bind request.

logBindResponse(CompletedOperationContext, SimpleBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a simple bind request.

logBindResponse(CompletedOperationContext, SASLBindRequest, BindResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a SASL bind request.

LogCategory - Enum in com.unboundid.directory.sdk.common.types

This enum defines the set of severities that may be used for error log messages.

logClientCertificateChain(ClientContext, Certificate[], String) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a certificate chain presented by a client.

logClientCertificateChain(ClientContext, Certificate[], String) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a certificate chain presented by a client.

logClientCertificateChain(ClientContext, Certificate[], String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a certificate chain presented by a client.

logClientCertificateChain(ClientContext, Certificate[], String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a certificate chain presented by a client.

logCompareForward(OperationContext, CompareRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a compare request that will be forwarded to another server.

logCompareForward(OperationContext, CompareRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a compare request that will be forwarded to another server.

logCompareForward(OperationContext, CompareRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a compare request that will be forwarded to another server.

logCompareForward(OperationContext, CompareRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a compare request that will be forwarded to another server.

logCompareForwardFailure(OperationContext, CompareRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a compare request to another server.

logCompareForwardFailure(OperationContext, CompareRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a compare request to another server.

logCompareForwardFailure(OperationContext, CompareRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a compare request to another server.

logCompareForwardFailure(OperationContext, CompareRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a compare request to another server.

logCompareRequest(OperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a compare request received from a client.

logCompareRequest(OperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a compare request received from a client.

logCompareRequest(OperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a compare request received from a client.

logCompareRequest(OperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a compare request received from a client.

logCompareResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a compare request.

logCompareResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a compare request.

logCompareResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a compare request.

logCompareResponse(CompletedOperationContext, CompareRequest, CompareResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a compare request.

logConnect(ClientContext) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message indicating that a new connection has been established.

logConnect(ClientContext) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message indicating that a new connection has been established.

logConnect(ClientContext) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message indicating that a new connection has been established.

logConnect(ClientContext) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message indicating that a new connection has been established.

logDeleteForward(OperationContext, DeleteRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a delete request that will be forwarded to another server.

logDeleteForward(OperationContext, DeleteRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a delete request that will be forwarded to another server.

logDeleteForward(OperationContext, DeleteRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a delete request that will be forwarded to another server.

logDeleteForward(OperationContext, DeleteRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a delete request that will be forwarded to another server.

logDeleteForwardFailure(OperationContext, DeleteRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a delete request to another server.

logDeleteForwardFailure(OperationContext, DeleteRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a delete request to another server.

logDeleteForwardFailure(OperationContext, DeleteRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a delete request to another server.

logDeleteForwardFailure(OperationContext, DeleteRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a delete request to another server.

logDeleteRequest(OperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a delete request received from a client.

logDeleteRequest(OperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a delete request received from a client.

logDeleteRequest(OperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a delete request received from a client.

logDeleteRequest(OperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a delete request received from a client.

logDeleteResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a delete request.

logDeleteResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a delete request.

logDeleteResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a delete request.

logDeleteResponse(CompletedOperationContext, DeleteRequest, DeleteResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a delete request.

logDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message indicating that a connection has been closed.

logDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message indicating that a connection has been closed.

logDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message indicating that a connection has been closed.

logDisconnect(ClientContext, DisconnectReason, String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message indicating that a connection has been closed.

logError(LogCategory, LogSeverity, long, String) - Method in class com.unboundid.directory.sdk.common.api.ErrorLogger

Records information about the provided message, if appropriate.

logError(LogCategory, LogSeverity, long, String) - Method in class com.unboundid.directory.sdk.common.api.FileBasedErrorLogger

Records information about the provided message, if appropriate.

logError(LogCategory, LogSeverity, long, String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Records information about the provided message, if appropriate.

logError(LogCategory, LogSeverity, long, String) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Records information about the provided message, if appropriate.

logError(String) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Logs an error message to the synchronization log for this change.

logExtendedForward(OperationContext, ExtendedRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an extended request that will be forwarded to another server.

logExtendedForward(OperationContext, ExtendedRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an extended request that will be forwarded to another server.

logExtendedForward(OperationContext, ExtendedRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an extended request that will be forwarded to another server.

logExtendedForward(OperationContext, ExtendedRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an extended request that will be forwarded to another server.

logExtendedForwardFailure(OperationContext, ExtendedRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward an extended request to another server.

logExtendedForwardFailure(OperationContext, ExtendedRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward an extended request to another server.

logExtendedForwardFailure(OperationContext, ExtendedRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward an extended request to another server.

logExtendedForwardFailure(OperationContext, ExtendedRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward an extended request to another server.

logExtendedRequest(OperationContext, ExtendedRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an extended request received from a client.

logExtendedRequest(OperationContext, ExtendedRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an extended request received from a client.

logExtendedRequest(OperationContext, ExtendedRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an extended request received from a client.

logExtendedRequest(OperationContext, ExtendedRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an extended request received from a client.

logExtendedResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing an extended request.

logExtendedResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing an extended request.

logExtendedResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing an extended request.

logExtendedResponse(CompletedOperationContext, ExtendedRequest, ExtendedResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing an extended request.

logInfo(String) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Logs an informational message to the synchronization log for this change.

logIntermediateResponse(OperationContext, IntermediateResponse) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an intermediate response that was returned to the client.

logIntermediateResponse(OperationContext, IntermediateResponse) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an intermediate response that was returned to the client.

logIntermediateResponse(OperationContext, IntermediateResponse) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an intermediate response that was returned to the client.

logIntermediateResponse(OperationContext, IntermediateResponse) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an intermediate response that was returned to the client.

logMessage(LogSeverity, String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Writes a message to the server error log.

logModifyDNForward(OperationContext, ModifyDNRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a modify DN request that will be forwarded to another server.

logModifyDNForward(OperationContext, ModifyDNRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a modify DN request that will be forwarded to another server.

logModifyDNForward(OperationContext, ModifyDNRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a modify DN request that will be forwarded to another server.

logModifyDNForward(OperationContext, ModifyDNRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a modify DN request that will be forwarded to another server.

logModifyDNForwardFailure(OperationContext, ModifyDNRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a modify DN request to another server.

logModifyDNForwardFailure(OperationContext, ModifyDNRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify DN request to another server.

logModifyDNForwardFailure(OperationContext, ModifyDNRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify DN request to another server.

logModifyDNForwardFailure(OperationContext, ModifyDNRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify DN request to another server.

logModifyDNRequest(OperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a modify DN request received from a client.

logModifyDNRequest(OperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a modify DN request received from a client.

logModifyDNRequest(OperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a modify DN request received from a client.

logModifyDNRequest(OperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a modify DN request received from a client.

logModifyDNResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a modify DN request.

logModifyDNResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a modify DN request.

logModifyDNResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a modify DN request.

logModifyDNResponse(CompletedOperationContext, ModifyDNRequest, ModifyDNResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a modify DN request.

logModifyForward(OperationContext, ModifyRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a modify request that will be forwarded to another server.

logModifyForward(OperationContext, ModifyRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a modify request that will be forwarded to another server.

logModifyForward(OperationContext, ModifyRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a modify request that will be forwarded to another server.

logModifyForward(OperationContext, ModifyRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a modify request that will be forwarded to another server.

logModifyForwardFailure(OperationContext, ModifyRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a modify request to another server.

logModifyForwardFailure(OperationContext, ModifyRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify request to another server.

logModifyForwardFailure(OperationContext, ModifyRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify request to another server.

logModifyForwardFailure(OperationContext, ModifyRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a modify request to another server.

logModifyRequest(OperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a modify request received from a client.

logModifyRequest(OperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a modify request received from a client.

logModifyRequest(OperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a modify request received from a client.

logModifyRequest(OperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a modify request received from a client.

logModifyResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a modify request.

logModifyResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a modify request.

logModifyResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a modify request.

logModifyResponse(CompletedOperationContext, ModifyRequest, ModifyResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a modify request.

logRequest(HttpServletRequest, Map<String, Object>) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Logs information about a servlet request that has been received from the client.

logRequest(HttpServletRequest, Map<String, Object>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Logs information about a servlet request that has been received from the client.

logResponse(HttpServletRequest, HttpServletResponse, Map<String, Object>) - Method in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

Logs information about a servlet response to be returned to the client.

logResponse(HttpServletRequest, HttpServletResponse, Map<String, Object>) - Method in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Logs information about a servlet response to be returned to the client.

logSearchForward(OperationContext, SearchRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a search request that will be forwarded to another server.

logSearchForward(OperationContext, SearchRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a search request that will be forwarded to another server.

logSearchForward(OperationContext, SearchRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a search request that will be forwarded to another server.

logSearchForward(OperationContext, SearchRequest, ForwardTarget) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a search request that will be forwarded to another server.

logSearchForwardFailure(OperationContext, SearchRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a failure encountered while attempting to forward a search request to another server.

logSearchForwardFailure(OperationContext, SearchRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a search request to another server.

logSearchForwardFailure(OperationContext, SearchRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a failure encountered while attempting to forward a search request to another server.

logSearchForwardFailure(OperationContext, SearchRequest, ForwardTarget, LDAPException) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a failure encountered while attempting to forward a search request to another server.

logSearchRequest(OperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a search request received from a client.

logSearchRequest(OperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a search request received from a client.

logSearchRequest(OperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a search request received from a client.

logSearchRequest(OperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a search request received from a client.

logSearchResultDone(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about the result of processing a search request.

logSearchResultDone(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about the result of processing a search request.

logSearchResultDone(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about the result of processing a search request.

logSearchResultDone(CompletedSearchOperationContext, SearchRequest, SearchResult) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about the result of processing a search request.

logSearchResultEntry(OperationContext, SearchRequest, Entry, List<Control>) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a search result entry that was returned to the client.

logSearchResultEntry(OperationContext, SearchRequest, Entry, List<Control>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a search result entry that was returned to the client.

logSearchResultEntry(OperationContext, SearchRequest, Entry, List<Control>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a search result entry that was returned to the client.

logSearchResultEntry(OperationContext, SearchRequest, Entry, List<Control>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a search result entry that was returned to the client.

logSearchResultReference(OperationContext, SearchRequest, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about a search result reference that was returned to the client.

logSearchResultReference(OperationContext, SearchRequest, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about a search result reference that was returned to the client.

logSearchResultReference(OperationContext, SearchRequest, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about a search result reference that was returned to the client.

logSearchResultReference(OperationContext, SearchRequest, List<String>, List<Control>) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about a search result reference that was returned to the client.

LogSeverity - Enum in com.unboundid.directory.sdk.common.types

This enum defines the set of severities that may be used for error log messages.

logUnbindRequest(OperationContext, UnbindRequest) - Method in class com.unboundid.directory.sdk.common.api.AccessLogger

Logs a message about an unbind request received from a client.

logUnbindRequest(OperationContext, UnbindRequest) - Method in class com.unboundid.directory.sdk.common.api.FileBasedAccessLogger

Logs a message about an unbind request received from a client.

logUnbindRequest(OperationContext, UnbindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Logs a message about an unbind request received from a client.

logUnbindRequest(OperationContext, UnbindRequest) - Method in class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Logs a message about an unbind request received from a client.

LogWriter - Interface in com.unboundid.directory.sdk.common.types

This interface provides methods to interact with a log writer within the core server logging framework.

M

main(String...) - Static method in class com.unboundid.directory.sdk.common.types.Version

Prints version information for the UnboundID Server SDK to standard output.

MAJOR_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.Version

The major version number for the Server SDK.

ManageExtensionPlugin - Class in com.unboundid.directory.sdk.common.api

This class defines an API that may be implemented by extensions which will be managed by the manage-extension tool.

ManageExtensionPlugin() - Constructor for class com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

MANIFEST_ATTR_SERVER_SDK_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the server SDK version number.

MANIFEST_ATTR_SUPPORT_CONTACT - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle support contact.

MANIFEST_ATTR_TITLE - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle name.

MANIFEST_ATTR_URL - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle URL.

MANIFEST_ATTR_VENDOR - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle vendor.

MANIFEST_ATTR_VENDOR_ID - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle vendor ID.

MANIFEST_ATTR_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

The name of the jar file manifest attribute that provides the extension bundle version.

mapCertificate(Certificate[]) - Method in class com.unboundid.directory.sdk.ds.api.CertificateMapper

Performs any processing which may be necessary to map the provided certificate chain to a user within the server.

mapCertificate(Certificate[]) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Performs any processing which may be necessary to map the provided certificate chain to a user within the server.

mapUsername(String) - Method in class com.unboundid.directory.sdk.ds.api.IdentityMapper

Performs any processing which may be necessary to map the provided username to a user within the server.

mapUsername(String) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Performs any processing which may be necessary to map the provided username to a user within the server.

matchesBaseAndScope(String, SearchScope) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether this entry is within the range of the provided base DN and scope.

matchesConnectionCriteria(String) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Determines whether this ClientContext matches the given Connection Criteria.

matchesFilter(String) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether this entry matches the provided filter.

matchesFilter(Filter) - Method in interface com.unboundid.directory.sdk.common.types.Entry

Indicates whether this entry matches the provided filter.

MatchingRule - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with matching rules, which can be used to perform matching-related operations against data.

MatchingRuleUse - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about a matching rule use defined in the server schema.

mayCacheInOperation() - Method in class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Indicates whether the server may cache values generated by this virtual attribute provider for reuse against the same entry in the course of processing the same operation.

mayCacheInOperation() - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Indicates whether the server may cache values generated by this virtual attribute provider for reuse against the same entry in the course of processing the same operation.

MINOR_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.Version

The minor version number for the Server SDK.

modifier(String) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the database user that made the change.

modifyDNOperationProcessed(CompletedOperationContext, ModifyDNRequest, ModifyDNResult, Entry, Entry) - Method in interface com.unboundid.directory.sdk.ds.api.ChangeListener

Indicates that a modify DN operation has been processed within the server.

modifyDNOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, ModifyDNRequest, ModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Performs any processing necessary for a modify DN operation matching the subscription criteria.

modifyDNOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, ModifyDNRequest, ModifyDNResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Performs any processing necessary for a modify DN operation matching the subscription criteria.

ModifyDNRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a modify DN request.

ModifyDNResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with modify DN results.

modifyDNUnaltered(ModifyDNRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided modify DN request to the backend server without altering the request or result in any way.

modifyEntry(TransactionContext, Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncDestination

Modify an "entry" in the database, corresponding to the the LDAP Entry that is passed in.

modifyEntry(Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncDestination

Modify an "entry" on the destination, corresponding to the the LDAP Entry that is passed in.

modifyEntry(TransactionContext, Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

Modify an "entry" in the database, corresponding to the the LDAP Entry that is passed in.

modifyEntry(Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

Modify an "entry" on the destination, corresponding to the the LDAP Entry that is passed in.

modifyOperationProcessed(CompletedOperationContext, ModifyRequest, ModifyResult, Entry, Entry) - Method in interface com.unboundid.directory.sdk.ds.api.ChangeListener

Indicates that a modify operation has been processed within the server.

modifyOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, ModifyRequest, ModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.api.ChangeSubscriptionHandler

Performs any processing necessary for a modify operation matching the subscription criteria.

modifyOperationProcessed(CompletedOperationContext, BigInteger, Set<ChangeSubscription>, ModifyRequest, ModifyResult, Entry, Entry) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Performs any processing necessary for a modify operation matching the subscription criteria.

ModifyRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a modify request.

ModifyResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with modify results.

modifyUnaltered(ModifyRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided modify request to the backend server without altering the request or result in any way.

MonitorProvider - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which expose monitoring information about server components.

MonitorProvider() - Constructor for class com.unboundid.directory.sdk.common.api.MonitorProvider

Creates a new instance of this monitor provider.

MonitorProviderConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a monitor provider.

N

NameForm - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about a name form defined in the server schema.

normalizeSubstring(ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.SubstringMatchingRule

Normalizes the provided value fragment into a form that can be used to efficiently compare it in a substring assertion.

normalizeValue(ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves the normalized form of the provided value.

O

ObjectClass - Interface in com.unboundid.directory.sdk.common.schema

This interface defines a set of methods that may be used to obtain information about an object class defined in the server schema.

OperationContext - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods that may be used to obtain information about an operation being processed by the server.

OperationType - Enum in com.unboundid.directory.sdk.common.types

This enumeration defines the set of possible operation types that may be processed by the server.

OrderingMatchingRule - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with ordering matching rules, which can be used to determine the logical order of two values in a sorted list.

P

PasswordGenerator - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which generate user passwords.

PasswordGenerator() - Constructor for class com.unboundid.directory.sdk.ds.api.PasswordGenerator

Creates a new instance of this password generator.

PasswordGeneratorConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a password generator.

passwordMatches(ByteString, ByteString) - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether the provided plaintext password could have been used to generate the given encoded password.

PasswordStorageScheme - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which may be used to encode passwords for storage in the server.

PasswordStorageScheme() - Constructor for class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Creates a new instance of this password storage scheme.

PasswordStorageSchemeConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a password storage scheme.

PasswordValidator - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which attempt to determine whether a proposed user password is acceptable.

PasswordValidator() - Constructor for class com.unboundid.directory.sdk.ds.api.PasswordValidator

Creates a new instance of this password validator.

PasswordValidatorConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a password validator.

PATCH_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.Version

The patch version number for the Server SDK.

PlacementAlgorithm - Class in com.unboundid.directory.sdk.proxy.api

This class defines an API that must be implemented by extensions which are used to select the backend set in which a new entry should be added in an entry-balanced environment.

PlacementAlgorithm() - Constructor for class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Creates a new instance of this placement algorithm.

PlacementAlgorithmConfig - Interface in com.unboundid.directory.sdk.proxy.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a placement algorithm.

Plugin - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which act as server plugins.

Plugin() - Constructor for class com.unboundid.directory.sdk.ds.api.Plugin

Creates a new instance of this plugin.

PluginConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a plugin.

POINT_VERSION - Static variable in class com.unboundid.directory.sdk.common.types.Version

The point version number for the Server SDK.

PostConnectPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a post-connect plugin.

PostConnectPluginResult(boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

Creates a new post-connect plugin result with the provided information.

PostDisconnectPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a post-disconnect plugin.

PostDisconnectPluginResult(boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PostDisconnectPluginResult

Creates a new post-disconnect plugin result with the provided information.

postFetch(LDAPInterface, SearchRequest, List<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

This method is called after an attempt to fetch a destination entry.

postFetch(LDAPInterface, AtomicReference<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

This method is called after fetching a source entry.

postFetch(LDAPInterface, SearchRequest, List<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

This method is called after an attempt to fetch a destination entry.

postFetch(LDAPInterface, AtomicReference<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

This method is called after fetching a source entry.

postInstall(InstallExtensionDetails) - Method in class com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

Invoked when an extension is first installed after all files are copied to the server installation but before restarting the server.

PostManageExtensionPluginResult - Class in com.unboundid.directory.sdk.common.types

This class defines a structure which may be used to provide information about the result of the processing performed by a manage extension plugin.

PostManageExtensionPluginResult(boolean, List<String>) - Constructor for class com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

Creates a new post manage extension plugin result with the provided information.

postMapping(Entry, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

This method is called immediately after the attributes and DN in the source entry are mapped into the equivalent destination entry.

postMapping(Entry, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

This method is called immediately after the attributes and DN in the source entry are mapped into the equivalent destination entry.

PostOperationPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a post-operation plugin.

PostOperationPluginResult(boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PostOperationPluginResult

Creates a new post-operation plugin result with the provided information.

PostResponsePluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a post-response plugin.

PostResponsePluginResult(boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

Creates a new post-response plugin result with the provided information.

PostStepResult - Enum in com.unboundid.directory.sdk.sync.types

This result is returned by plugins that are invoked after step of the synchronization processing.

postUpdate(UpdateExtensionDetails) - Method in class com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

Invoked when an extension is updated after all files are update to the server installation but before restarting the server.

preCreate(LDAPInterface, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

This method is called before a destination entry is created.

preCreate(LDAPInterface, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

This method is called before a destination entry is created.

preDelete(LDAPInterface, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

This method is called before a destination entry is deleted.

preDelete(LDAPInterface, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

This method is called before a destination entry is deleted.

preFetch(LDAPInterface, SearchRequest, List<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

This method is called before a destination entry is fetched.

preFetch(LDAPInterface, SearchRequest, List<Entry>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

This method is called before a destination entry is fetched.

preInstall(InstallExtensionDetails) - Method in class com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

Invoked when an extension is first installed before shutting down the server and any files are copied to the server installation.

PreManageExtensionPluginResult - Class in com.unboundid.directory.sdk.common.types

This class defines a structure which may be used to provide information about the result of the processing performed by a manage extension plugin.

PreManageExtensionPluginResult(boolean, List<String>) - Constructor for class com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

Creates a new pre manage extension plugin result with the provided information.

preMapping(Entry, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

This method is called immediately before the attributes and DN in the source entry are mapped into the equivalent destination entry.

preMapping(Entry, Entry, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

This method is called immediately before the attributes and DN in the source entry are mapped into the equivalent destination entry.

preModify(LDAPInterface, Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

This method is called before a destination entry is modified.

preModify(LDAPInterface, Entry, List<Modification>, SyncOperation) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

This method is called before a destination entry is modified.

PreOperationPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a pre-operation plugin.

PreOperationPluginResult(boolean, boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Creates a new pre-operation plugin result with the provided information.

prepareCall(String) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Creates a CallableStatement object for calling database stored procedures.

prepareStatement(String) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Creates a PreparedStatement object for sending parameterized SQL statements to the database.

PreParsePluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a pre-parse plugin.

PreParsePluginResult(boolean, boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Creates a new pre-parse plugin result with the provided information.

PreStepResult - Enum in com.unboundid.directory.sdk.sync.types

This result is returned by plugins that are invoked before a step of the synchronization processing.

preUpdate(UpdateExtensionDetails) - Method in class com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

Invoked when an extension is updated before shutting down the server and any files are updated to the server installation.

processExtendedOperation(String) - Method in interface com.unboundid.directory.sdk.common.types.InternalConnection

Processes an extended operation with the provided request OID.

processExtendedOperation(String, ASN1OctetString) - Method in interface com.unboundid.directory.sdk.common.types.InternalConnection

Processes an extended operation with the provided request OID and value.

processExtendedOperation(ExtendedRequest) - Method in interface com.unboundid.directory.sdk.common.types.InternalConnection

Processes the provided extended request.

processExtendedOperation(OperationContext, ExtendedRequest, UpdatableExtendedResult) - Method in class com.unboundid.directory.sdk.ds.api.ExtendedOperationHandler

Performs any processing appropriate for the provided extended request.

processServerShutdown(String) - Method in interface com.unboundid.directory.sdk.common.api.ServerShutdownListener

Performs any processing that may be necessary when the server begins the shutdown process.

PRODUCT_NAME - Static variable in class com.unboundid.directory.sdk.common.types.Version

The official full product name for the Server SDK.

ProxyOperationContext - Interface in com.unboundid.directory.sdk.proxy.types

This interface defines a set of methods that may be used to obtain information about an operation being processed by the Directory Proxy Server.

ProxyServerContext - Interface in com.unboundid.directory.sdk.proxy.types

This interface may be used to obtain information about the Directory Proxy Server in which an extension is running.

ProxyTransformation - Class in com.unboundid.directory.sdk.proxy.api

This class defines an API that must be implemented by extensions which are used to transform requests and/or responses as they pass through the Directory Proxy Server.

ProxyTransformation() - Constructor for class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Creates a new instance of this proxy transformation.

ProxyTransformationConfig - Interface in com.unboundid.directory.sdk.proxy.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a proxy transformation.

putAttachment(Object, Object) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Stores an attachment in the operation.

R

Reconfigurable<T> - Interface in com.unboundid.directory.sdk.common.internal

This interface is used to mark extensions which may be notified of changes to their configuration.

registerBackendInitializationListener(BackendInitializationListener) - Method in interface com.unboundid.directory.sdk.ds.types.DirectoryServerContext

Registers the provided backend initialization listener with the server so that it may be notified of any backends coming online or going offline.

registerChangeListener(ChangeListener, Set<ChangeType>, List<String>, Filter) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Registers the provided change listener with the server so that it may be notified of any changes matching the provided criteria.

registerDiskSpaceConsumer(DiskSpaceConsumer) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Registers the provided disk space consumer with the server.

RegisteredBackendInitializationListener - Interface in com.unboundid.directory.sdk.ds.types

This interface is used to mark an object which has been registered with the server as a backend initialization listener.

RegisteredChangeListener - Interface in com.unboundid.directory.sdk.ds.types

This interface is used to mark an object which has been registered with the server as a change notification listener.

RegisteredDiskSpaceConsumer - Interface in com.unboundid.directory.sdk.common.types

This interface is used to mark an object which has been registered with the server as a disk space consumer.

RegisteredMonitorProvider - Interface in com.unboundid.directory.sdk.common.types

This interface is used to mark an object which has been registered with the server as a monitor provider.

RegisteredServerShutdownListener - Interface in com.unboundid.directory.sdk.common.types

This interface is used to mark an object which has been registered with the server as a server shutdown listener.

registerMonitorProvider(MonitorProvider, GenericConfig) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Registers the given monitor provider with the server.

registerShutdownListener(ServerShutdownListener) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Registers the provided listener to be notified when the server shutdown process has begun.

registerSupportedControlOID(String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Registers the provided OID with the server so that it will appear in the supportedControl attribute of the server's root DSE.

removeAttribute(AttributeType) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Removes all occurrences of the specified attribute from the entry.

removeAttribute(String) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Removes all occurrences of the attribute with the specified name from the entry.

removeAttribute(AttributeType, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Removes the attribute with the specified name and exact set of options from the entry.

removeAttribute(String, Set<String>) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Removes the attribute with the specified name and exact set of options from the entry.

removeModifiedSourceAttribute(String) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Remove a source attribute that should not be synchronized to the destination.

REPOSITORY_PATH - Static variable in class com.unboundid.directory.sdk.common.types.Version

The source repository branch from which the Server SDK was built.

Request - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with operation requests.

restartServer() - Method in class com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

Indicates whether the manage-extension tool should restart the server after the installation if it was previous started.

Result - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with operation results.

REVISION_ID - Static variable in class com.unboundid.directory.sdk.common.types.Version

The source repository revision ID from which the Server SDK was built.

rollBack() - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Rolls back the internal Connection if the transaction has not timed out and is still valid.

runTask(TaskContext) - Method in class com.unboundid.directory.sdk.ds.api.Task

Performs the appropriate processing for this task.

runTask(TaskContext) - Method in class com.unboundid.directory.sdk.ds.scripting.ScriptedTask

Performs the appropriate processing for this task.

runThread() - Method in interface com.unboundid.directory.sdk.common.api.ServerThread

Performs the actual processing for this thread.

S

SASLBindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a SASL bind request.

Schema - Interface in com.unboundid.directory.sdk.common.schema

This interface provides a number of methods that may be used to interact with the server schema.

ScriptedAccessLogger - Class in com.unboundid.directory.sdk.common.scripting

This class defines an API that must be implemented by scripted extensions which record information about interaction with clients, including connections established and received and operations requested and completed.

ScriptedAccessLogger() - Constructor for class com.unboundid.directory.sdk.common.scripting.ScriptedAccessLogger

Creates a new instance of this access logger.

ScriptedAlertHandler - Class in com.unboundid.directory.sdk.common.scripting

This class defines an API that must be implemented by scripted extensions which will be invoked whenever an administrative alert is generated within the server.

ScriptedAlertHandler() - Constructor for class com.unboundid.directory.sdk.common.scripting.ScriptedAlertHandler

Creates a new instance of this alert handler.

ScriptedCertificateMapper - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which attempt to map a certificate presented by a client (e.g., via SSL or StartTLS) to a user defined in the server.

ScriptedCertificateMapper() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedCertificateMapper

Creates a new instance of this certificate mapper.

ScriptedChangeSubscriptionHandler - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which receive notification of changes of interest processed within the server.

ScriptedChangeSubscriptionHandler() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedChangeSubscriptionHandler

Creates a new instance of this change subscription handler.

ScriptedErrorLogger - Class in com.unboundid.directory.sdk.common.scripting

This class defines an API that must be implemented by scripted extensions which record information about warnings, errors, and events which occur in the server.

ScriptedErrorLogger() - Constructor for class com.unboundid.directory.sdk.common.scripting.ScriptedErrorLogger

Creates a new instance of this error logger.

ScriptedFileBasedAccessLogger - Class in com.unboundid.directory.sdk.common.scripting

This class defines an API that may be used to create a specific type of scripted access logger which is intended to write log messages to text files.

ScriptedFileBasedAccessLogger() - Constructor for class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedAccessLogger

Creates a new instance of this access logger.

ScriptedFileBasedErrorLogger - Class in com.unboundid.directory.sdk.common.scripting

This class defines an API that may be used to create a specific type of scripted error logger which is intended to write log messages to text files.

ScriptedFileBasedErrorLogger() - Constructor for class com.unboundid.directory.sdk.common.scripting.ScriptedFileBasedErrorLogger

Creates a new instance of this file-based error logger.

ScriptedHTTPOperationLogger - Class in com.unboundid.directory.sdk.http.scripting

This class defines an API that must be implemented by extensions which record information about interaction with HTTP clients.

ScriptedHTTPOperationLogger() - Constructor for class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

Creates a new instance of this scripted HTTP operation logger.

ScriptedHTTPServletExtension - Class in com.unboundid.directory.sdk.http.scripting

This class defines an API that must be implemented by scripted extensions which create servlets for use with an HTTP connection handler.

ScriptedHTTPServletExtension() - Constructor for class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPServletExtension

Creates a new instance of this HTTP servlet extension.

ScriptedIdentityMapper - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which attempt to map a username to a user defined in the server.

ScriptedIdentityMapper() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedIdentityMapper

Creates a new instance of this identity mapper.

ScriptedJDBCSyncDestination - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions in order to synchronize data into a relational database.

ScriptedJDBCSyncDestination() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncDestination

ScriptedJDBCSyncSource - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions in order to synchronize data out of a relational database.

ScriptedJDBCSyncSource() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

ScriptedLDAPHealthCheck - Class in com.unboundid.directory.sdk.proxy.scripting

This class defines an API that must be implemented by scripted extensions which are used to assess the health of backend servers accessed through the Directory Proxy Server.

ScriptedLDAPHealthCheck() - Constructor for class com.unboundid.directory.sdk.proxy.scripting.ScriptedLDAPHealthCheck

Creates a new instance of this LDAP health check.

ScriptedLDAPSyncDestinationPlugin - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions that perform processing on synchronization operations within an LDAP Sync Destination.

ScriptedLDAPSyncDestinationPlugin() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncDestinationPlugin

Creates a new instance of this LDAP sync destination plugin.

ScriptedLDAPSyncSourcePlugin - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions that perform processing on synchronization operations within an LDAP Sync Source.

ScriptedLDAPSyncSourcePlugin() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedLDAPSyncSourcePlugin

Creates a new instance of this LDAP sync source plugin.

ScriptedPasswordGenerator - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which generate user passwords.

ScriptedPasswordGenerator() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordGenerator

Creates a new instance of this password generator.

ScriptedPasswordValidator - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which attempt to determine whether a proposed user password is acceptable.

ScriptedPasswordValidator() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedPasswordValidator

Creates a new instance of this password validator.

ScriptedPlugin - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which act as server plugins.

ScriptedPlugin() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedPlugin

Creates a new instance of this plugin.

ScriptedProxyTransformation - Class in com.unboundid.directory.sdk.proxy.scripting

This class defines an API that must be implemented by scripted extensions which are used to transform requests and/or responses as they pass through the Directory Proxy Server.

ScriptedProxyTransformation() - Constructor for class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Creates a new instance of this proxy transformation.

ScriptedSyncDestination - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions that wish to push changes processed by the Synchronization Server to an arbitrary destination.

ScriptedSyncDestination() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncDestination

ScriptedSyncPipePlugin - Class in com.unboundid.directory.sdk.sync.scripting

This class defines an API that must be implemented by scripted extensions that perform processing on synchronization operations within the Sync Pipe.

ScriptedSyncPipePlugin() - Constructor for class com.unboundid.directory.sdk.sync.scripting.ScriptedSyncPipePlugin

Creates a new instance of this sync pipe plugin.

ScriptedTask - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which may be used as administrative tasks.

ScriptedTask() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedTask

Creates a new instance of this task.

ScriptedVirtualAttributeProvider - Class in com.unboundid.directory.sdk.ds.scripting

This class defines an API that must be implemented by scripted extensions which construct attribute values which may be included in entries instead of or in addition to real values which are actually stored in the backend.

ScriptedVirtualAttributeProvider() - Constructor for class com.unboundid.directory.sdk.ds.scripting.ScriptedVirtualAttributeProvider

Creates a new instance of this virtual attribute provider.

ScriptUtils - Class in com.unboundid.directory.sdk.sync.util

This class contains various utility methods for working with the UnboundID LDAP SDK and JDBC objects within script implementations.

SearchEntryPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a search entry plugin.

SearchEntryPluginResult(boolean, boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Creates a new search entry plugin result with the provided information.

SearchReferencePluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a search reference plugin.

SearchReferencePluginResult(boolean, boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Creates a new search reference plugin result with the provided information.

SearchRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a search request.

SearchResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with search results.

SearchResultProvider - Interface in com.unboundid.directory.sdk.proxy.internal

This interface defines a set of methods that may be used to cause the Directory Proxy Server to send search result entries and/or references to the client in the course of processing a proxy transformation.

searchToRawEntry(String, String) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Executes the given SQL query and converts the results into a raw LDAP Entry, where the attribute names are the raw column names from the result of the query.

searchToRawEntry(PreparedStatement, String) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Executes the given PreparedStatement and converts the results into a raw LDAP Entry, where the attribute names are the raw column names from the result of the query.

searchUnaltered(SearchRequest) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Sends the provided search request to the backend server without altering the request or result in any way.

selectBackendSet(OperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Determines the backend set that should be used to process the specified add operation.

sendAlert(AlertSeverity, String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Generates an administrative alert notification.

sendAlert(String, AlertSeverity, String, String) - Method in interface com.unboundid.directory.sdk.common.types.ServerContext

Generates an administrative alert notification.

sendEntry() - Method in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Indicates whether the associated entry should be returned to the client.

sendEntry(SearchResultEntry, boolean) - Method in interface com.unboundid.directory.sdk.proxy.internal.SearchResultProvider

Attempts to return the provided search result entry to the client.

sendIntermediateResponse(IntermediateResponse) - Method in interface com.unboundid.directory.sdk.common.types.ActiveOperationContext

Attempts to send an intermediate response message to the client.

sendIntermediateResponse() - Method in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Indicates whether the associated intermediate response should be returned to the client.

sendReference() - Method in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Indicates whether the associated reference should be returned to the client.

sendReference(SearchResultReference, boolean) - Method in interface com.unboundid.directory.sdk.proxy.internal.SearchResultProvider

Attempts to return the provided search result reference to the client.

sendResponseImmediately() - Method in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Indicates whether the server should send a response to the client immediately without performing any core processing.

sendResponseImmediately() - Method in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Indicates whether the server should send a response to the client immediately without performing any core processing.

sendSearchEntry(SearchResultEntry) - Method in interface com.unboundid.directory.sdk.common.types.ActiveSearchOperationContext

Attempts to send a search result entry to the client.

sendSearchReference(SearchResultReference) - Method in interface com.unboundid.directory.sdk.common.types.ActiveSearchOperationContext

Attempts to send a search result reference to the client.

sendUnsolicitedNotification(String, ResultCode, String) - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Attempts to send an unsolicited notification to the client with the provided information.

ServerContext - Interface in com.unboundid.directory.sdk.common.types

This interface may be used to obtain information about the server in which an extension is running.

ServerShutdownListener - Interface in com.unboundid.directory.sdk.common.api

This interface defines a set of methods that should be implemented by classes which should be notified when the server has begun the process of shutting down.

ServerThread - Interface in com.unboundid.directory.sdk.common.api

This interface defines a set of methods that may be implemented by a thread which should be run in the server.

setAdditionalLogMessage(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Specifies an additional log message for the result which will not be returned to the client but may be included in access log messages for the associated operation.

setAssertionValue(ByteString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableCompareRequest

Specifies the assertion value to compare against the values of the target attribute.

setAttachment(String, Object) - Method in interface com.unboundid.directory.sdk.common.types.ActiveOperationContext

Sets an attachment for the associated operation.

setAttribute(Attribute) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Replaces the specified attribute in the entry, or adds the attribute if it does not exist.

setAttributes(List<String>) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the list of requested attributes.

setAttributeType(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableCompareRequest

Specifies the name or OID of the attribute to compare.

setBaseDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the base DN for the search.

setBaseDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the base DN for the search.

setCompletionStatus(CompletionStatus) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

This method is used by the Sync Pipe to indicate if the completion status of a synchronization operation.

setDeleteOldRDN(boolean) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies whether to remove the old RDN values from the entry.

setDerefPolicy(DereferencePolicy) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the dereference policy for the search.

setDiagnosticMessage(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Specifies the diagnostic message for the result, if any.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableCompareRequest

Specifies the DN of the entry to compare.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableCompareRequest

Specifies the DN of the entry to compare.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableDeleteRequest

Specifies the DN of th entry to be deleted.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableDeleteRequest

Specifies the DN of th entry to be deleted.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the DN of the entry to move and/or rename.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the DN of the entry to move and/or rename.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyRequest

Specifies the DN of the entry to modify.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyRequest

Specifies the DN of the entry to modify.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSimpleBindRequest

Specifies the DN of the user attempting to bind.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSimpleBindRequest

Specifies the DN of the user attempting to bind.

setDN(String) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Specifies the DN for the entry.

setDN(DN) - Method in interface com.unboundid.directory.sdk.common.types.UpdatableEntry

Specifies the DN for the entry.

setFilter(Filter) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the filter for the search.

setFilter(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the filter for the search.

setIDToAbandon(int) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableAbandonRequest

Specifies the message ID of the operation to abandon.

setMatchedDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Specifies the matched DN for the result, if any.

setModifications(List<Modification>) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyRequest

Specifies the modifications to be applied.

setNewRDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the new RDN to use for the entry.

setNewRDN(RDN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the new RDN to use for the entry.

setNewSuperiorDN(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the DN for the new superior entry, if any.

setNewSuperiorDN(DN) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableModifyDNRequest

Specifies the DN for the new superior entry, if any.

setPassword(ByteString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSimpleBindRequest

Specifies the password for the bind request.

setPassword(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSimpleBindRequest

Specifies the password for the bind request.

setReferralURLs(List<String>) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Specifies the referral URLs for the result.

setRequestControls(List<Control>) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableRequest

Updates the set of request controls for this request.

setRequestOID(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableExtendedRequest

Specifies the OID for the extended request.

setRequestValue(ASN1OctetString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableExtendedRequest

Specifies the value for the extended request, if any.

setResultCode(ResultCode) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Specifies the result code for the result.

setResultControls(List<Control>) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableResult

Updates the set of result controls for this result.

setResultData(LDAPResult) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableBindResult

Sets the contents of this result with information from the provided LDAP result, including the result code, diagnostic message, matched DN, referral URLs, and controls.

setResultData(LDAPResult) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableExtendedResult

Sets the contents of this result with information from the provided LDAP result, including the result code, diagnostic message, matched DN, referral URLs, and controls.

setResultData(LDAPResult) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Sets the contents of this result with information from the provided LDAP result, including the result code, diagnostic message, matched DN, referral URLs, and controls.

setResultData(LDAPException) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableGenericResult

Sets the contents of this result with information from the provided LDAP exception, including the result code, diagnostic message, matched DN, referral URLs, and controls.

setResultOID(String) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableExtendedResult

Specifies the OID for the extended result, if any.

setResultValue(ASN1OctetString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableExtendedResult

Specifies the value for the extended result, if any.

setSASLCredentials(String, ASN1OctetString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSASLBindRequest

Specifies the SASL credentials for the bind request, if any.

setScope(SearchScope) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the scope for the search.

setServerSASLCredentials(ASN1OctetString) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableBindResult

Specifies the server SASL credentials for the bind result, if any.

setSizeLimit(int) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the size limit for the search.

setSourceEntry(Entry, boolean) - Method in interface com.unboundid.directory.sdk.sync.types.SyncOperation

Sets the entry that was fetched from the sync source.

setStartpoint(TransactionContext, SetStartpointOptions) - Method in class com.unboundid.directory.sdk.sync.api.JDBCSyncSource

This method should effectively set the starting point for synchronization to the place specified by the options parameter.

setStartpoint(TransactionContext, SetStartpointOptions) - Method in class com.unboundid.directory.sdk.sync.scripting.ScriptedJDBCSyncSource

This method should effectively set the starting point for synchronization to the place specified by the options parameter.

SetStartpointOptions - Class in com.unboundid.directory.sdk.sync.types

Used to identify how to set the starting point for synchronization (beginning of changelog, end of changelog, based on a change sequence number, etc).

SetStartpointOptions.StartpointType - Enum in com.unboundid.directory.sdk.sync.types

The possible startpoint types.

setTimeLimitSeconds(int) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies the time limit for the search in seconds.

setTimeout(long) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Sets a timeout for this TransactionContext.

setTransactionIsolation(int) - Method in class com.unboundid.directory.sdk.sync.types.TransactionContext

Attempts to change the transaction isolation level for the underlying Connection object to the one given.

setTypesOnly(boolean) - Method in interface com.unboundid.directory.sdk.common.operation.UpdatableSearchRequest

Specifies whether search result entries should contain attribute values.

SHORT_NAME - Static variable in class com.unboundid.directory.sdk.common.types.Version

The short product name for the Server SDK, without any spaces.

SimpleBindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with a simple bind request.

skipCoreProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Indicates whether the server should skip the core processing for the operation.

skipCoreProcessing() - Method in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Indicates whether the server should skip the core processing for the operation.

StartupDependency - Enum in com.unboundid.directory.sdk.ds.types

This enum defines a set of dependencies that may need to be satisfied by a component which is to be invoked at server startup.

StartupPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a startup plugin.

StartupPluginResult(boolean, boolean, CharSequence) - Constructor for class com.unboundid.directory.sdk.ds.types.StartupPluginResult

Creates a new startup plugin result with the provided information.

STATE_KEY_PROCESSING_TIME_MILLIS - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the operation processing time in milliseconds.

STATE_KEY_PROCESSING_TIME_MILLIS - Static variable in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

The key that will be used to hold the operation processing time in milliseconds.

STATE_KEY_PROCESSING_TIME_NANOS - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the operation processing time in nanoseconds.

STATE_KEY_PROCESSING_TIME_NANOS - Static variable in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

The key that will be used to hold the operation processing time in nanoseconds.

STATE_KEY_REQUEST_ID - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the request ID for the associated HTTP request.

STATE_KEY_REQUEST_TIME_MILLIS - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the time the request was received, in milliseconds since January 1, 1960, UTC, as reported by System.currentTimeMillis().

STATE_KEY_REQUEST_TIME_MILLIS - Static variable in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

The key that will be used to hold the time the request was received, in milliseconds since January 1, 1960, UTC, as reported by System.currentTimeMillis().

STATE_KEY_REQUEST_TIME_NANOS - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the time the request was received, in nanoseconds, as reported by System.nanoTime().

STATE_KEY_RESPONSE_CONTENT_LENGTH - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the response content length in the state map.

STATE_KEY_RESPONSE_CONTENT_LENGTH - Static variable in class com.unboundid.directory.sdk.http.scripting.ScriptedHTTPOperationLogger

The key that will be used to hold the response content length in the state map.

STATE_KEY_RESPONSE_COOKIES - Static variable in class com.unboundid.directory.sdk.http.api.HTTPOperationLogger

The key that will be used to hold the set of cookies included in the response to the client.

SubordinateModifyDNPluginResult - Class in com.unboundid.directory.sdk.ds.types

This class defines a structure which may be used to provide information about the result of the processing performed by a subordinate modify DN plugin.

SubordinateModifyDNPluginResult(boolean, boolean, boolean) - Constructor for class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

Creates a new subordinate modify DN plugin result with the provided information.

SubstringMatchingRule - Interface in com.unboundid.directory.sdk.common.schema

This interface provides an API for interacting with substring matching rules, which can be used to determine whether a given value matches a provided substring assertion.

SUCCESS - Static variable in class com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PostDisconnectPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PostOperationPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.StartupPluginResult

A predefined result instance that indicates all processing completed successfully.

SUCCESS - Static variable in class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

A predefined result instance that indicates all processing completed successfully.

supportsAuthPasswordSyntax() - Method in class com.unboundid.directory.sdk.ds.api.PasswordStorageScheme

Indicates whether this password storage scheme provides the ability to encode passwords in the authentication password syntax as described in RFC 3112.

supportsOperation(OperationType) - Method in interface com.unboundid.directory.sdk.proxy.types.BackendServer

Indicates whether this LDAP external server may be used to process operations of the specified type.

SyncClass - Interface in com.unboundid.directory.sdk.sync.types

This interface represents the matched Sync Class for a SyncOperation.

SyncDestination - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions that wish to push changes processed by the Synchronization Server to an arbitrary destination.

SyncDestination() - Constructor for class com.unboundid.directory.sdk.sync.api.SyncDestination

Creates a new instance of this notification destination.

SyncDestinationConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a JDBC Sync Destination.

SynchronizationServerExtension - Annotation Type in com.unboundid.directory.sdk.sync.internal

This annotation type may be used to indicate that the marked class represents an API that can be used to create an extension for use in the Synchronization Server.

SyncOperation - Interface in com.unboundid.directory.sdk.sync.types

This interface represents a single synchronized change from the Sync Source to the Sync Destination.

SyncOperationType - Enum in com.unboundid.directory.sdk.sync.types

The type of a Sync Operation.

SyncPipePlugin - Class in com.unboundid.directory.sdk.sync.api

This class defines an API that must be implemented by extensions that perform processing on synchronization operations within the Sync Pipe.

SyncPipePlugin() - Constructor for class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Creates a new instance of this sync pipe plugin.

SyncPipePluginConfig - Interface in com.unboundid.directory.sdk.sync.config

This interface defines a set of methods that may be used to obtain information about the general configuration of a sync pipe plugin.

SyncServerContext - Interface in com.unboundid.directory.sdk.sync.types

This interface may be used to obtain information about the Synchronization Server in which an extension is running.

T

tableName(String) - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.Builder

Set the database table on which the change occurred.

Task - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which may be used as administrative tasks.

Task() - Constructor for class com.unboundid.directory.sdk.ds.api.Task

Creates a new instance of this task.

TaskContext - Interface in com.unboundid.directory.sdk.ds.types

This interface may be used to obtain information about an administrative task which is being processed.

TaskReturnState - Enum in com.unboundid.directory.sdk.ds.types

This enum defines the states that a task may have after it has completed processing.

toLDAPSDKEntry() - Method in interface com.unboundid.directory.sdk.common.types.Entry

Converts this server entry to its corresponding LDAP SDK representation.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.AddRequest

Retrieves an LDAP SDK representation of this add request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.BindRequest

Retrieves an LDAP SDK representation of this bind request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.CompareRequest

Retrieves an LDAP SDK representation of this compare request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Retrieves an LDAP SDK representation of this delete request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.ExtendedRequest

Retrieves an LDAP SDK representation of this extended request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Retrieves an LDAP SDK representation of this modify DN request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyRequest

Retrieves an LDAP SDK representation of this modify request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.SASLBindRequest

Retrieves an LDAP SDK representation of this SASL bind request.

toLDAPSDKRequest(SearchResultListener) - Method in interface com.unboundid.directory.sdk.common.operation.SearchRequest

Retrieves an LDAP SDK representation of this search request.

toLDAPSDKRequest() - Method in interface com.unboundid.directory.sdk.common.operation.SimpleBindRequest

Retrieves an LDAP SDK representation of this simple bind request.

toLDAPSDKResult() - Method in interface com.unboundid.directory.sdk.common.operation.BindResult

Retrieves an LDAP SDK representation of this bind result.

toLDAPSDKResult() - Method in interface com.unboundid.directory.sdk.common.operation.CompareResult

Retrieves an LDAP SDK representation of this compare result.

toLDAPSDKResult() - Method in interface com.unboundid.directory.sdk.common.operation.GenericResult

Retrieves an LDAP SDK representation of this result.

toLDAPSDKResult() - Method in interface com.unboundid.directory.sdk.common.operation.SearchResult

Retrieves an LDAP SDK representation of this search result.

toLDIFChangeRecord() - Method in interface com.unboundid.directory.sdk.common.operation.AddRequest

Retrieves an LDIF change record that corresponds to this add request.

toLDIFChangeRecord() - Method in interface com.unboundid.directory.sdk.common.operation.ChangeRequest

Retrieves an LDIF change record that corresponds to this change request.

toLDIFChangeRecord() - Method in interface com.unboundid.directory.sdk.common.operation.DeleteRequest

Retrieves an LDIF change record that corresponds to this delete request.

toLDIFChangeRecord() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyDNRequest

Retrieves an LDIF change record that corresponds to this modify DN request.

toLDIFChangeRecord() - Method in interface com.unboundid.directory.sdk.common.operation.ModifyRequest

Retrieves an LDIF change record that corresponds to this modify request.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Retrieves a string representation of this attribute syntax.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.AttributeType

Retrieves a string representation of this attribute type definition.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.DITContentRule

Retrieves a string representation of this DIT content rule definition.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.DITStructureRule

Retrieves a string representation of this DIT structure rule definition.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Retrieves a string representation of this matching rule.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRuleUse

Retrieves a string representation of this matching rule use definition.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.NameForm

Retrieves a string representation of this name form definition.

toString() - Method in interface com.unboundid.directory.sdk.common.schema.ObjectClass

Retrieves a string representation of this object class definition.

toString() - Method in interface com.unboundid.directory.sdk.common.types.AlertNotification

Retrieves a string representation of this alert notification.

toString() - Method in interface com.unboundid.directory.sdk.common.types.ClientContext

Retrieves a string representation of the client connection.

toString() - Method in enum com.unboundid.directory.sdk.common.types.ConditionResult

Retrieves a string representation of this condition result value.

toString() - Method in enum com.unboundid.directory.sdk.common.types.DisconnectReason

Retrieves a string representation of this disconnect reason.

toString() - Method in interface com.unboundid.directory.sdk.common.types.OperationContext

Retrieves a string representation of this operation.

toString() - Method in enum com.unboundid.directory.sdk.common.types.OperationType

Retrieves a string representation of this operation type.

toString() - Method in class com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

Retrieves a string representation of this post manage extension plugin result.

toString() - Method in class com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

Retrieves a string representation of this pre manage extension plugin result.

toString() - Method in enum com.unboundid.directory.sdk.ds.types.IndexType

Retrieves the human-readable name for this IndexType.

toString() - Method in class com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult

Retrieves a string representation of this intermediate response plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.LDIFPluginResult

Retrieves a string representation of this LDIF plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

Retrieves a string representation of this post-connect plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PostDisconnectPluginResult

Retrieves a string representation of this post-disconnect plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PostOperationPluginResult

Retrieves a string representation of this post-operation plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

Retrieves a string representation of this post-response plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

Retrieves a string representation of this pre-operation plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.PreParsePluginResult

Retrieves a string representation of this pre-parse plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult

Retrieves a string representation of this search entry plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult

Retrieves a string representation of this search reference plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.StartupPluginResult

Retrieves a string representation of this startup plugin result.

toString() - Method in class com.unboundid.directory.sdk.ds.types.SubordinateModifyDNPluginResult

Retrieves a string representation of this search entry plugin result.

toString() - Method in enum com.unboundid.directory.sdk.ds.types.WritabilityMode

Retrieves a string representation of this WritabilityMode.

toString() - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Retrieves a string representation of this LDAP health check.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.proxy.api.LDAPHealthCheck

Appends a string representation of this LDAP health check to the provided buffer.

toString() - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Retrieves a string representation of this placement algorithm.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.proxy.api.PlacementAlgorithm

Appends a string representation of this placement algorithm to the provided buffer.

toString() - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Retrieves a string representation of this proxy transformation.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Appends a string representation of this proxy transformation to the provided buffer.

toString() - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Retrieves a string representation of this health check result.

toString() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Retrieves a string representation of this LDAP sync destination plugin.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncDestinationPlugin

Appends a string representation of this LDAP sync destination plugin to the provided buffer.

toString() - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Retrieves a string representation of this LDAP sync source plugin.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.sync.api.LDAPSyncSourcePlugin

Appends a string representation of this LDAP sync source plugin to the provided buffer.

toString() - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Retrieves a string representation of this sync pipe plugin.

toString(StringBuilder) - Method in class com.unboundid.directory.sdk.sync.api.SyncPipePlugin

Appends a string representation of this sync pipe plugin to the provided buffer.

toString() - Method in class com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord

TransactionContext - Class in com.unboundid.directory.sdk.sync.types

This class wraps an open JDBC Connection and provides controlled access to it via a handful of delegating methods.

TransactionContext(Connection) - Constructor for class com.unboundid.directory.sdk.sync.types.TransactionContext

Constructor.

transformAddRequest(ProxyOperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided add request.

transformAddRequest(ProxyOperationContext, AddRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided add request.

transformAddResult(ProxyOperationContext, ReadOnlyAddRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided add result.

transformAddResult(ProxyOperationContext, ReadOnlyAddRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided add result.

transformBindRequest(ProxyOperationContext, BindRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided bind request.

transformBindRequest(ProxyOperationContext, BindRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided bind request.

transformBindResult(ProxyOperationContext, BindRequest, BindResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided bind request.

transformBindResult(ProxyOperationContext, BindRequest, BindResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided bind request.

transformCompareRequest(ProxyOperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided compare request.

transformCompareRequest(ProxyOperationContext, CompareRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided compare request.

transformCompareResult(ProxyOperationContext, ReadOnlyCompareRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided compare result.

transformCompareResult(ProxyOperationContext, ReadOnlyCompareRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided compare result.

transformDeleteRequest(ProxyOperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided delete request.

transformDeleteRequest(ProxyOperationContext, DeleteRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided delete request.

transformDeleteResult(ProxyOperationContext, ReadOnlyDeleteRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided delete result.

transformDeleteResult(ProxyOperationContext, ReadOnlyDeleteRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided delete result.

transformModifyDNRequest(ProxyOperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided modify DN request.

transformModifyDNRequest(ProxyOperationContext, ModifyDNRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided modify DN request.

transformModifyDNResult(ProxyOperationContext, ReadOnlyModifyDNRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided modify DN result.

transformModifyDNResult(ProxyOperationContext, ReadOnlyModifyDNRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided modify DN result.

transformModifyRequest(ProxyOperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided modify request.

transformModifyRequest(ProxyOperationContext, ModifyRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided modify request.

transformModifyResult(ProxyOperationContext, ReadOnlyModifyRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided modify result.

transformModifyResult(ProxyOperationContext, ReadOnlyModifyRequest, LDAPResult) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided modify result.

transformSearchRequest(ProxyOperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided search request.

transformSearchRequest(ProxyOperationContext, SearchRequest) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided search request.

transformSearchResult(ProxyOperationContext, ReadOnlySearchRequest, SearchResult, SearchResultProvider) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided search result.

transformSearchResult(ProxyOperationContext, ReadOnlySearchRequest, SearchResult, SearchResultProvider) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided search result.

transformSearchResultEntry(ProxyOperationContext, ReadOnlySearchRequest, SearchResultEntry) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided search result entry.

transformSearchResultEntry(ProxyOperationContext, ReadOnlySearchRequest, SearchResultEntry) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided search result entry.

transformSearchResultReference(ProxyOperationContext, ReadOnlySearchRequest, SearchResultReference) - Method in class com.unboundid.directory.sdk.proxy.api.ProxyTransformation

Applies any necessary transformation to the provided search result reference.

transformSearchResultReference(ProxyOperationContext, ReadOnlySearchRequest, SearchResultReference) - Method in class com.unboundid.directory.sdk.proxy.scripting.ScriptedProxyTransformation

Applies any necessary transformation to the provided search result reference.

TrustManagerProvider - Class in com.unboundid.directory.sdk.common.api

This class defines an API that must be implemented by extensions which provide access to trust managers which are used to determine whether to trust a certificate that has been presented to the server.

TrustManagerProvider() - Constructor for class com.unboundid.directory.sdk.common.api.TrustManagerProvider

Creates a new instance of this trust manager provider.

TrustManagerProviderConfig - Interface in com.unboundid.directory.sdk.common.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a trust manager provider.

U

UnbindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to interact with an unbind request.

UnboundIDExtension - Interface in com.unboundid.directory.sdk.common.internal

This interface is used to mark classes which may be extensions to UnboundID products.

UpdatableAbandonRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update an abandon request.

UpdatableAddRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update an add request.

UpdatableAddResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update add results.

UpdatableBindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a bind request.

UpdatableBindResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update bind results.

UpdatableCompareRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a compare request.

UpdatableCompareResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update compare results.

UpdatableDeleteRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a delete request.

UpdatableDeleteResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update delete results.

UpdatableEntry - Interface in com.unboundid.directory.sdk.common.types

This interface defines a set of methods which may be used to update the contents of an entry.

UpdatableExtendedRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update an extended request.

UpdatableExtendedResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update extended results.

UpdatableGenericResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update the contents of operation results.

UpdatableModifyDNRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a modify DN request.

UpdatableModifyDNResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update modify DN results.

UpdatableModifyRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a modify request.

UpdatableModifyResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update modify results.

UpdatableRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update the contents of operation requests.

UpdatableResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update the contents of operation results.

UpdatableSASLBindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a SASL bind request.

UpdatableSearchRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a search request.

UpdatableSearchResult - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update search results.

UpdatableSimpleBindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update a simple bind request.

UpdatableUnbindRequest - Interface in com.unboundid.directory.sdk.common.operation

This interface defines a set of methods which may be used to update an unbind request.

UPDATE_LOG_NAME - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

File written to history/[timestamp]-[version] to document whatever modifications were made to the file system during an update.

UPDATE_PATH - Static variable in class com.unboundid.directory.sdk.common.types.ExtensionBundle

Path to the config/update directory where update base files are stored.

UpdateExtensionDetails - Class in com.unboundid.directory.sdk.common.types

This class defines a structure which may be used to provide information about the manage extension update state.

UpdateExtensionDetails(ExtensionBundle, ExtensionBundle) - Constructor for class com.unboundid.directory.sdk.common.types.UpdateExtensionDetails

Creates a new update extension details with the provided information.

updateMonitorData() - Method in class com.unboundid.directory.sdk.common.api.MonitorProvider

Updates the information collected by this monitor provider.

V

valueIsAcceptable(ByteString, StringBuilder) - Method in interface com.unboundid.directory.sdk.common.schema.AttributeSyntax

Indicates whether the provided value is acceptable for use with this attribute syntax.

valueMatchesSubstring(ByteString, ByteString, List<ByteString>, ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.SubstringMatchingRule

Indicates whether the provided value matches the given substring assertion.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.AlertSeverity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.AuthType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.ConditionResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.DisconnectReason

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.LogCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.LogSeverity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.common.types.OperationType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.ds.types.IndexType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.ds.types.StartupDependency

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.ds.types.TaskReturnState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.ds.types.WritabilityMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.proxy.types.HealthCheckState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.CompletionStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.ChangeType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.PostStepResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.PreStepResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.SetStartpointOptions.StartpointType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.unboundid.directory.sdk.sync.types.SyncOperationType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.unboundid.directory.sdk.common.types.AlertSeverity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.AuthType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.ConditionResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.DisconnectReason

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.LogCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.LogSeverity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.common.types.OperationType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.ds.types.IndexType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.ds.types.StartupDependency

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.ds.types.TaskReturnState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.ds.types.WritabilityMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.proxy.types.HealthCheckState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.CompletionStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.DatabaseChangeRecord.ChangeType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.PostStepResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.PreStepResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.SetStartpointOptions.StartpointType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.unboundid.directory.sdk.sync.types.SyncOperationType

Returns an array containing the constants of this enum type, in the order they are declared.

valuesMatch(ByteString, ByteString) - Method in interface com.unboundid.directory.sdk.common.schema.MatchingRule

Indicates whether the provided attribute value may be considered logically equivalent to the provided assertion value according to the constraints of this matching rule..

Version - Class in com.unboundid.directory.sdk.common.types

This class provides version information for the UnboundID Server SDK.

Version() - Constructor for class com.unboundid.directory.sdk.common.types.Version

VERSION_NUMBER_STRING - Static variable in class com.unboundid.directory.sdk.common.types.Version

The version number string for the Server SDK.

VERSION_QUALIFIER - Static variable in class com.unboundid.directory.sdk.common.types.Version

The version qualifier string for the Server SDK.

VirtualAttributeProvider - Class in com.unboundid.directory.sdk.ds.api

This class defines an API that must be implemented by extensions which construct attribute values which may be included in entries instead of or in addition to real values which are actually stored in the backend.

VirtualAttributeProvider() - Constructor for class com.unboundid.directory.sdk.ds.api.VirtualAttributeProvider

Creates a new instance of this virtual attribute provider.

VirtualAttributeProviderConfig - Interface in com.unboundid.directory.sdk.ds.config

This interface defines a set of methods that may be used to obtain information about the general configuration for a virtual attribute provider.

W

worseThan(HealthCheckResult) - Method in interface com.unboundid.directory.sdk.proxy.types.HealthCheckResult

Indicates whether this health check result is considered worse than the provided result.

WritabilityMode - Enum in com.unboundid.directory.sdk.ds.types

This class implements an enumeration that may be used to control the writability mode for the entire server or for a specific backend.

write(CharSequence) - Method in interface com.unboundid.directory.sdk.common.types.LogWriter

Writes the given message to the underlying logger.

A B C D E F G H I J K L M N O P R S T U V W