All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| AbandonRequest |
This interface defines a set of methods which may be used to interact with an
abandon request.
|
| AccessLogger |
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.
|
| AccessLoggerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an access logger.
|
| AccessTokenValidator |
This class defines an API that may be implemented by PingAuthorize Server
extensions that validate externally generated access tokens.
|
| AccessTokenValidatorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an Access Token Validator.
|
| AccountStatusNotification |
This class defines a data type for storing information associated
with an account status notification.
|
| AccountStatusNotificationHandler |
This class defines an API that must be implemented by extensions which have
the ability to process notifications about events that occur that could
change the status of a user account.
|
| AccountStatusNotificationHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an account status
notification handler.
|
| AccountStatusNotificationProperty |
This class implements an enumeration that holds the possible set of
additional properties that can be included in an account status notification.
|
| AccountStatusNotificationType |
This class implements an enumeration that holds the possible event types that
can trigger an account status notification.
|
| ActiveOperationContext |
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 |
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.
|
| AddRequest |
This interface defines a set of methods which may be used to interact with an
add request.
|
| AddResult |
This interface defines a set of methods which may be used to interact with
add results.
|
| Advice |
This class defines an API that must be implemented by extensions that
implement custom Advice for policies.
|
| AdviceConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a policy Advice.
|
| AdviceStatement |
Interface providing access to Advice statements returned from a
policy evaluation.
|
| AlarmSeverity |
Enumerates severity types for alarm conditions from least severe to most
severe.
|
| AlertHandler |
This class defines an API that must be implemented by extensions which will
be invoked whenever an administrative alert is generated within the server.
|
| AlertHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an alert handler.
|
| AlertNotification |
This interface defines a set of methods that may be used to interact with an
alert notification.
|
| AlertSeverity |
This enumeration defines the severities that may be used for alert types.
|
| ApproximateMatchingRule |
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.
|
| AssuredReplicationRequirements |
This interface may be used to obtain information about the assured
replication requirements that will be used for an operation.
|
| AssuredReplicationResult |
This interface may be used to obtain information about the result of
replication assurance processing for an operation.
|
| AttributeSyntax |
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 |
This interface defines a set of methods that may be used to obtain
information about an attribute type defined in the server schema.
|
| AuditSeverity |
This enum defines the severity levels that may be used for data security
audit report entries.
|
| AuthInfo |
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.
|
| AuthType |
This enum defines the set of authentication types that may be used for a
client connection.
|
| BackendContext |
This interface defines a set of methods that may be used to interact with a
backend that has been defined in the server.
|
| BackendInitializationListener |
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.
|
| BackendServer |
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 |
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.
|
| BindRequest |
This interface defines a set of methods which may be used to interact with a
bind request.
|
| BindResult |
This interface defines a set of methods which may be used to interact with
bind results.
|
| BrokerContext |
This interface may be used to obtain information about the
PingAuthorize Server in which an extension is running.
|
| BrokerExtension |
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
Ping Identity PingAuthorize Server.
|
| CertificateMapper |
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.
|
| CertificateMapperConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a certificate mapper.
|
| ChangeDetector |
This class defines an API that must be implemented by extensions that
detect changes for an LDAP based Sync Source.
|
| ChangeDetectorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration of a change detector.
|
| ChangeListener |
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.
|
| ChangeRecord |
This class represents the basis for a single change record.
|
| ChangeRecord.Builder |
This class is used to construct ChangeRecord instances.
|
| ChangeRequest |
This interface defines a set of methods which may be used to interact with a
request used to alter server contents.
|
| ChangeSubscription |
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 |
This class defines an API that must be implemented by extensions which
receive notification of changes of interest processed within the server.
|
| ChangeSubscriptionHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a change subscription
handler.
|
| CipherStreamProvider |
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.
|
| CipherStreamProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a cipher stream provider.
|
| ClientContext |
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.
|
| CompareRequest |
This interface defines a set of methods which may be used to interact with a
compare request.
|
| CompareResult |
This interface defines a set of methods which may be used to interact with
compare results.
|
| CompletedOperationContext |
This interface defines a set of methods that may be used to obtain
information about an operation for which processing has been completed.
|
| CompletedProxyOperationContext |
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 |
This interface defines a set of methods that may be used to obtain
information about a search operation for which processing has been completed.
|
| CompletionStatus |
This class contains the possible completion reasons for a synchronization
operation.
|
| ConditionResult |
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.
|
| Configurable |
This interface is used to mark extensions which may obtain configuration
information using an LDAP SDK argument parser.
|
| ConnectionCriteria |
This class defines an API that must be implemented by extensions which can
be used to classify client connections.
|
| ConnectionCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a connection criteria object.
|
| ContinuationSASLBindResult |
This interface may be used to obtain information about the result of
processing a SASL bind operation in which additional processing is required
to complete the authentication process.
|
| DatabaseChangeRecord |
This class represents the basis for a single database change record.
|
| DatabaseChangeRecord.Builder |
This class is used to construct DatabaseChangeRecord instances.
|
| DatabaseChangeRecord.ChangeType |
Potential types of database changes.
|
| DataSecurityAuditor |
This class defines an API that must be implemented by extensions that may
examine entries to identify potential security-related issues (or potentially
other characteristics of note).
|
| DataSecurityAuditorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a data security auditor.
|
| DataSecurityAuditorEntryReporter |
This interface defines a method that a data security auditor may be used to
report any issues identified with a given entry.
|
| DataSecurityAuditorSummaryReporter |
This interface defines a method that a data security auditor may be used to
report any issues identified with a given entry.
|
| DegradedAlertType |
This interface may be used to interact with an alert type that may cause the
server to be classified as degraded.
|
| DeleteRequest |
This interface defines a set of methods which may be used to interact with a
delete request.
|
| DeleteResult |
This interface defines a set of methods which may be used to interact with
delete results.
|
| DirectoryProxyServerExtension |
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 (which may also be referred to as the Directory Proxy Server).
|
| DirectoryServerContext |
This interface may be used to obtain information about the Directory Server
(or related product) in which an extension is running.
|
| DirectoryServerExtension |
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 (which may also be referred to as the Directory Server).
|
| DisconnectReason |
This enumeration defines the set of possible reasons for the closure of a
connection between a client and the server.
|
| DiskSpaceConsumer |
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 |
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 |
This interface defines a set of methods that may be used to obtain
information about a DIT structure rule defined in the server schema.
|
| EMailAttachment |
This interface defines a set of methods that may be used to interact with an
email message attachment.
|
| EMailMessage |
This interface defines a set of methods that may be used to interact with a
multi-part email message, which may include either or both a plain-text or
HTML-formatted body, and may optionally include attachments.
|
| EncryptionSettingsDefinition |
This interface defines a set of methods that may be used to interact with an
encryption settings definition.
|
| EndpointException |
This class provides a type of Exception which is used to indicate
an error when interfacing with an external resource.
|
| EnhancedPasswordStorageScheme |
This class defines an API that may be implemented by extensions which provide
enhanced password storage scheme support.
|
| Entry |
This interface defines a set of methods which may be used to interact with an
entry.
|
| EntryBalancingRequestProcessor |
This interface defines a set of methods that may be used to obtain
information about and interact with an entry-balancing request processor and
its component backend sets and servers.
|
| EqualityMatchingRule |
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.
|
| ErrorLogger |
This class defines an API that must be implemented by extensions which
record information about warnings, errors, and events which occur in the
server.
|
| ErrorLoggerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an error logger.
|
| ExampleUsageProvider |
This interface is used to mark extensions which may provide examples that
demonstrate how they are intended to be used.
|
| ExtendedOperationHandler |
This class defines an API that must be implemented by extensions which are
used to process extended operations within the server.
|
| ExtendedOperationHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an extended operation
handler.
|
| ExtendedRequest |
This interface defines a set of methods which may be used to interact with an
extended request.
|
| ExtendedResult |
This interface defines a set of methods which may be used to interact with
extended results.
|
| ExtensionBundle |
This class represents the physical state of a Ping Identity server
extension bundle.
|
| FailureSASLBindResult |
This interface may be used to obtain information about the result of
processing a SASL bind operation in which the authentication attempt failed.
|
| FileBasedAccessLogger |
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.
|
| FileBasedAccessLoggerConfig |
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 |
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.
|
| FileBasedErrorLoggerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a file-based error logger.
|
| ForwardTarget |
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.
|
| GenericBrokerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for extensions used by the
PingAuthorize Server.
|
| GenericConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for all types of extensions.
|
| GenericDirectoryConfig |
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 |
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 |
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 |
This interface defines a set of methods which may be used to interact with
properties common to most types of LDAP results.
|
| GenericSyncConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for extensions used by the
Data Sync Server.
|
| Group |
This interface defines a set of methods that may be used to interact with a
group.
|
| GroupMemberIterator |
This interface defines a set of methods that may be used to iterate through
the members of a group.
|
| GroupMemberIteratorException |
This class defines an exception that may be thrown by a
GroupMemberIterator if a problem is encountered while iterating
through the members of a group. |
| HealthCheckResult |
This interface defines a set of methods that may be used to assess the health
of an LDAP external server.
|
| HealthCheckState |
This enum defines the set of possible states that may be returned by LDAP
health checks.
|
| HTTPOperationLogger |
This class defines an API that must be implemented by extensions which
record information about interaction with HTTP clients.
|
| HTTPOperationLoggerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an HTTP operation logger.
|
| HttpRequestResponse |
Generically represents an HTTP request or response to/from a PingAuthorize
endpoint on which an advice can operate.
|
| HTTPServerContext |
This interface may be used to obtain information about the HTTP Server
(or related product) in which an extension is running.
|
| HTTPServletExtension |
This class defines an API that must be implemented by extensions which create
servlets for use with an HTTP connection handler.
|
| HTTPServletExtensionConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an HTTP servlet extension.
|
| IdentityMapper |
This class defines an API that must be implemented by extensions which
attempt to map a username to a user defined in the server.
|
| IdentityMapperConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an identity mapper.
|
| IndexType |
This class implements an enumeration that may be used to define the
ways in which an attribute may be indexed within the directory server.
|
| InstallExtensionDetails |
This class defines a structure which may be used to provide information about
the manage extension installation state.
|
| IntermediateResponsePluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by an intermediate response plugin.
|
| InternalConnection |
This interface defines a set of methods that may be used to perform internal
operations within the server.
|
| JDBCSyncDestination |
This class defines an API that must be implemented by extensions
in order to synchronize data into a relational database.
|
| JDBCSyncDestinationConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a JDBC Sync Destination.
|
| JDBCSyncSource |
This class defines an API that must be implemented by extensions
in order to synchronize data out of a relational database.
|
| JDBCSyncSourceConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a JDBC Sync Source.
|
| KafkaMessage |
This interface represents a single kafka message.
|
| KafkaSyncDestinationPlugin |
This class defines an API that must be implemented by extensions that
perform processing on synchronization operations within a Kafka Sync
Destination.
|
| KafkaSyncDestinationPluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration of a sync pipe plugin.
|
| KeyManagerProvider |
This class defines an API that must be implemented by extensions which
provide access to key managers.
|
| KeyManagerProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a key manager provider.
|
| LDAPHealthCheck |
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.
|
| LDAPHealthCheckConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an LDAP health check.
|
| LDAPSyncDestinationPlugin |
This class defines an API that must be implemented by extensions that
perform processing on synchronization operations within an LDAP Sync
Destination.
|
| LDAPSyncDestinationPluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration of a sync pipe plugin.
|
| LDAPSyncSourceContext |
This interface extends the base SyncSourceContext to provide
access to an LDAPInterface for the source.
|
| LDAPSyncSourcePlugin |
This class defines an API that must be implemented by extensions that
perform processing on synchronization operations within an LDAP Sync
Source.
|
| LDAPSyncSourcePluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration of a sync pipe plugin.
|
| LDIFExportTaskProperties |
This information may be used to obtain information about an LDIF export task
that was processed by the server.
|
| LDIFPluginResult |
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.
|
| Location |
This interface defines a set of methods that may be used interact with a
location defined in the server.
|
| LogCategory |
This enum defines the set of severities that may be used for error log
messages.
|
| LogFileRotationListener |
This class defines an API that may be used to perform custom processing
whenever a log file is rotated.
|
| LogFileRotationListenerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a log file rotation
listener.
|
| LogSeverity |
This enum defines the set of severities that may be used for error log
and trace log messages.
|
| LogWriter |
This interface provides methods to interact with a log writer within the
core server logging framework.
|
| ManageExtensionPlugin |
This class defines an API that may be implemented by extensions which will
be managed by the manage-extension tool.
|
| MatchingRule |
This interface provides an API for interacting with matching rules, which
can be used to perform matching-related operations against data.
|
| MatchingRuleUse |
This interface defines a set of methods that may be used to obtain
information about a matching rule use defined in the server schema.
|
| MetricsEngineContext |
This interface may be used to obtain information about the
Data Metrics Server in which an extension is running.
|
| MetricsEngineExtension |
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
Data Metrics Server.
|
| ModifyDNRequest |
This interface defines a set of methods which may be used to interact with a
modify DN request.
|
| ModifyDNResult |
This interface defines a set of methods which may be used to interact with
modify DN results.
|
| ModifyRequest |
This interface defines a set of methods which may be used to interact with a
modify request.
|
| ModifyResult |
This interface defines a set of methods which may be used to interact with
modify results.
|
| MonitorProvider |
This class defines an API that must be implemented by extensions which
expose monitoring information about server components.
|
| MonitorProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a monitor provider.
|
| NameForm |
This interface defines a set of methods that may be used to obtain
information about a name form defined in the server schema.
|
| NotFulfilledException |
Exception that may be thrown by a Policy Obligation to indicate that
the obligation could not be fulfilled.
|
| Notification |
This interface defines a set of methods that may be used to obtain
information about a notification to be delivered by a notification
manager.
|
| NotificationChange |
This interface defines a set of methods that may be used to obtain
information about a single change in a notification to be delivered by a
notification manager.
|
| NotificationDeliveryResult |
This class implements an enumeration that may be used to define the
ways in which an attribute may be indexed within the directory server.
|
| NotificationManager |
This class defines an API that must be implemented by extensions which
wish to deliver notification of changes of interest processed within the
server.
|
| NotificationManagerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a notification manager.
|
| NotificationProperties |
This class defines a structure used by a notification manager to specify
information that it wishes to be included in a change notification.
|
| OAuthTokenHandler |
This class defines an API that must be implemented by extensions which will
handle incoming SCIM requests with OAuth 2.0 bearer token authentication.
|
| OAuthTokenHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an OAuth token handler.
|
| ObjectClass |
This interface defines a set of methods that may be used to obtain
information about an object class defined in the server schema.
|
| OneTimePasswordDeliveryMechanism |
This class defines an API that must be implemented by extensions which
attempt to deliver one-time passwords (OTPs) to end users through some
out-of-band mechanism.
|
| OneTimePasswordDeliveryMechanismConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a one-time password delivery
mechanism.
|
| OperationCompletedListener |
This interface defines a set of methods that may be used to notify a server
SDK extension whenever an operation has completed.
|
| OperationContext |
This interface defines a set of methods that may be used to obtain
information about an operation being processed by the server.
|
| OperationType |
This enumeration defines the set of possible operation types that
may be processed by the server.
|
| OrderingMatchingRule |
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.
|
| PassphraseProvider |
This class defines an API that must be implemented by extensions that provide
passphrases for server components like external servers and access to key or
trust stores.
|
| PassphraseProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a passphrase provider.
|
| PassThroughAuthenticationHandler |
This class defines an API that must be implemented by extensions that
attempt to pass through authentication to an external service.
|
| PassThroughAuthenticationHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a pass-through authentication
handler.
|
| PassThroughAuthenticationResult |
This class provides a data structure that holds information about the result
of an attempt to pass through authentication to an external service.
|
| PassThroughAuthenticationResultCode |
|
| PasswordGenerator |
This class defines an API that must be implemented by extensions which
generate user passwords.
|
| PasswordGeneratorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a password generator.
|
| PasswordStorageScheme |
|
| PasswordStorageSchemeConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a password storage scheme.
|
| PasswordValidator |
This class defines an API that must be implemented by extensions which
attempt to determine whether a proposed user password is acceptable.
|
| PasswordValidatorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a password validator.
|
| PlacementAlgorithm |
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.
|
| PlacementAlgorithmConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a placement algorithm.
|
| Plugin |
This class defines an API that must be implemented by extensions which act as
server plugins.
|
| PluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a plugin.
|
| PolicyDecision |
Enumeration representing the possible results returned from policy
evaluation.
|
| PolicyDecisionLogger |
This class defines an API that must be implemented by extensions which
record information about PingAuthorize policy enforcement point
(PEP) and policy decision point (PDP) activity
Each policy decision logger may be configured to indicate whether to
include the PDP response or exclude log messages based on their Policy
Message Type.
|
| PolicyDecisionLoggerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a policy decision
logger.
|
| PolicyMessageType |
|
| PolicyRequestDetails |
Object passed to Advice
implementations containing information about the policy request that
triggered the return of the Advice. |
| PostConnectPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a post-connect plugin.
|
| PostDisconnectPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a post-disconnect plugin.
|
| PostLDIFExportTaskProcessor |
This class defines an API that must be implemented by extensions that perform
some processing immediately after an LDIF export task has completed.
|
| PostLDIFExportTaskProcessorConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a post-LDIF-export task
processor.
|
| PostManageExtensionPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a manage extension plugin.
|
| PostOperationPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a post-operation plugin.
|
| PostResponsePluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a post-response plugin.
|
| PostStepResult |
This result is returned by plugins that are invoked after step of the
synchronization processing.
|
| PreManageExtensionPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a manage extension plugin.
|
| PreOperationPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a pre-operation plugin.
|
| PreParsePluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a pre-parse plugin.
|
| PreStepResult |
This result is returned by plugins that are invoked before a step of the
synchronization processing.
|
| ProxiedExtendedOperationHandler |
This class defines an API that must be implemented by extensions which are
used to forward extended operations to one or more backend servers.
|
| ProxiedExtendedOperationHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a proxied extended operation
handler.
|
| ProxyingRequestProcessor |
This interface defines a set of methods that may be used to obtain
information about and interact with a proxying request processor and its
associated backend servers.
|
| ProxyOperationContext |
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 |
This interface may be used to obtain information about the Directory Proxy
Server in which an extension is running.
|
| ProxyTransformation |
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.
|
| ProxyTransformationConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a proxy transformation.
|
| Reconfigurable<T> |
This interface is used to mark extensions which may be notified of changes
to their configuration.
|
| RecurringTask |
This class defines an API that must be implemented by extensions that may be
used to schedule administrative tasks on a recurring basis.
|
| RecurringTaskConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a recurring task.
|
| RegisteredBackendInitializationListener |
This interface is used to mark an object which has been registered with the
server as a backend initialization listener.
|
| RegisteredChangeListener |
This interface is used to mark an object which has been registered with the
server as a change notification listener.
|
| RegisteredDiskSpaceConsumer |
This interface is used to mark an object which has been registered with the
server as a disk space consumer.
|
| RegisteredMonitorProvider |
This interface is used to mark an object which has been registered with the
server as a monitor provider.
|
| RegisteredOperationCompletedListener |
This interface is used to mark an object which has been registered with the
server as an operation completed listener.
|
| RegisteredServerShutdownListener |
This interface is used to mark an object which has been registered with the
server as a server shutdown listener.
|
| Request |
This interface defines a set of methods which may be used to interact with
operation requests.
|
| RequestCriteria |
This class defines an API that must be implemented by extensions which can
be used to classify client requests.
|
| RequestCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a request criteria object.
|
| RequestProcessor |
This interface defines a set of methods that may be used to obtain
information about and interact with a request processor.
|
| Result |
This interface defines a set of methods which may be used to interact with
operation results.
|
| ResultCriteria |
This class defines an API that must be implemented by extensions which can
be used to classify client results.
|
| ResultCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a result criteria object.
|
| SASLBindRequest |
This interface defines a set of methods which may be used to interact with a
SASL bind request.
|
| SASLBindResult |
This interface may be used to obtain information about the result of
processing a SASL bind operation.
|
| SASLBindResultFactory |
This interface provides methods that may be used to construct SASL bind
result objects.
|
| SASLBindResultType |
This enumeration defines the types of results that may be returned by a SASL
mechanism handler when attempting to process a SASL bind operation.
|
| SASLMechanismHandler |
This class defines an API that must be implemented by extensions which add
support for custom SASL mechanisms to the server, which can provide support
for custom authentication (and optionally, authorization) methods.
|
| SASLMechanismHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a SASL mechanism handler.
|
| Schema |
This interface provides a number of methods that may be used to interact with
the server schema.
|
| SCIM2AttributeMapping |
This class defines an API that must be implemented by extensions that may be
used to convert attributes between the mapped LDAP representation of an entry
and the SCIM 2.0 representation of that entry.
|
| SCIM2AttributeMappingConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a SCIM2 Attribute Mapping.
|
| SCIMCreateRequest |
Represents a request to create a SCIM 2 resource.
|
| SCIMDeleteRequest |
Represents a request to delete a specific SCIM 2 resource.
|
| SCIMLDAPAttributeMapper |
This interface provides a set of utility methods that SCIM 2-based
extensions can use to convert between JSON attribute values and LDAP
attribute values.
|
| SCIMLDAPInterface |
This interface defines a set of helper methods for SCIM 2-related extensions
that interact with SCIM resources and sub-resources backed by an LDAP
server.
|
| SCIMModifyRequest |
Represents a request to partially modify a SCIM 2 resource.
|
| SCIMReplaceRequest |
Represents a request to replace a SCIM 2 resource.
|
| SCIMRequest |
Represents a SCIM 2 request.
|
| SCIMRetrieveRequest |
Represents a request to retrieve a specific SCIM 2 resource.
|
| SCIMSearchRequest |
Represents a search request to retrieve SCIM 2 resources.
|
| SCIMSearchResultListener |
This interfaces defines an API for a SCIM 2-based Server SDK extension to
provide search results to the PingAuthorize Server as they are returned from
the extension's data store.
|
| SCIMServerContext |
This interface may be used to obtain information about the SCIM 2-enabled
HTTP Server in which an extension is running.
|
| SCIMSubResourceTypeHandler |
This class defines an API that may be implemented by PingAuthorize Server
extensions that need to extend the server's standard SCIM 2 capabilities.
|
| SCIMSubResourceTypeHandlerConfig |
This interface defines a set of methods that may be used to obtain
information about the configuration for a SCIM Sub-Resource Type Handler
extension.
|
| SCIMUpdateRequest |
Represents a request to update a SCIM 2 resource.
|
| ScriptedAccessLogger |
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.
|
| ScriptedAccountStatusNotificationHandler |
This class defines an API that must be implemented by scripted extensions
which have the ability to process notifications about events that occur that
could change the status of a user account.
|
| ScriptedAlertHandler |
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.
|
| ScriptedCertificateMapper |
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.
|
| ScriptedChangeSubscriptionHandler |
This class defines an API that must be implemented by scripted extensions
which receive notification of changes of interest processed within the
server.
|
| ScriptedErrorLogger |
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.
|
| ScriptedFileBasedAccessLogger |
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.
|
| ScriptedFileBasedErrorLogger |
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.
|
| ScriptedHTTPOperationLogger |
This class defines an API that must be implemented by extensions which
record information about interaction with HTTP clients.
|
| ScriptedHTTPServletExtension |
This class defines an API that must be implemented by scripted extensions
which create servlets for use with an HTTP connection handler.
|
| ScriptedIdentityMapper |
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.
|
| ScriptedJDBCSyncDestination |
This class defines an API that must be implemented by scripted extensions
in order to synchronize data into a relational database.
|
| ScriptedJDBCSyncSource |
This class defines an API that must be implemented by scripted extensions
in order to synchronize data out of a relational database.
|
| ScriptedLDAPHealthCheck |
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.
|
| ScriptedLDAPSyncDestinationPlugin |
This class defines an API that must be implemented by scripted extensions
that perform processing on synchronization operations within an LDAP Sync
Destination.
|
| ScriptedLDAPSyncSourcePlugin |
This class defines an API that must be implemented by scripted extensions
that perform processing on synchronization operations within an LDAP Sync
Source.
|
| ScriptedOAuthTokenHandler |
This class defines an API that must be implemented by extensions which will
handle incoming SCIM requests with OAuth 2.0 bearer token authentication.
|
| ScriptedPasswordGenerator |
This class defines an API that must be implemented by scripted extensions
which generate user passwords.
|
| ScriptedPasswordValidator |
This class defines an API that must be implemented by scripted extensions
which attempt to determine whether a proposed user password is acceptable.
|
| ScriptedPlugin |
This class defines an API that must be implemented by scripted extensions
which act as server plugins.
|
| ScriptedProxyTransformation |
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.
|
| ScriptedSyncDestination |
This class defines an API that must be implemented by scripted extensions
that wish to push changes processed by the Data Sync Server to an
arbitrary destination.
|
| ScriptedSyncPipePlugin |
This class defines an API that must be implemented by scripted extensions
that perform processing on synchronization operations within the Sync Pipe.
|
| ScriptedSyncSource |
This class defines an API that must be implemented by extensions in order to
synchronize data from a generic (non-LDAP and non-JDBC) endpoint.
|
| ScriptedTask |
This class defines an API that must be implemented by scripted extensions
which may be used as administrative tasks.
|
| ScriptedUncachedAttributeCriteria |
This class defines an API that must be implemented by scripted extensions
which have the ability to determine which attributes should be stored in the
uncached-id2entry database of a local DB backend, while the remainder of the
entry is stored in the id2entry database.
|
| ScriptedUncachedEntryCriteria |
This class defines an API that must be implemented by scripted extensions
which have the ability to determine which entries should be stored in the
uncached-id2entry database of a local DB backend, rather than in the id2entry
database.
|
| ScriptedVirtualAttributeProvider |
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.
|
| ScriptUtils |
This class contains various utility methods for working with the
UnboundID LDAP SDK and JDBC objects within script implementations.
|
| SearchEntryCriteria |
This class defines an API that must be implemented by extensions which can
be used to classify client search result entries.
|
| SearchEntryCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a search entry criteria
object.
|
| SearchEntryPluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a search entry plugin.
|
| SearchReferenceCriteria |
This class defines an API that must be implemented by extensions which can
be used to classify client search result entries.
|
| SearchReferenceCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a search reference criteria
object.
|
| SearchReferencePluginResult |
This class defines a structure which may be used to provide information about
the result of the processing performed by a search reference plugin.
|
| SearchRequest |
This interface defines a set of methods which may be used to interact with a
search request.
|
| SearchResult |
This interface defines a set of methods which may be used to interact with
search results.
|
| SearchResultProvider |
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.
|
| ServerAffinity |
This class provides a data structure for holding information about an
affinity to a particular backend server instance.
|
| ServerAffinityProvider |
This class defines an API that must be implemented by extensions which are
used to influence which backend server a client should use in a load-balanced
set.
|
| ServerAffinityProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a server affinity provider.
|
| ServerContext |
This interface may be used to obtain information about the server in
which an extension is running.
|
| ServerShutdownListener |
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 |
This interface defines a set of methods that may be implemented by a thread
which should be run in the server.
|
| SetStartpointOptions |
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 |
The possible startpoint types.
|
| SimpleBindRequest |
This interface defines a set of methods which may be used to interact with a
simple bind request.
|
| StartupDependency |
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 |
This class defines a structure which may be used to provide information about
the result of the processing performed by a startup plugin.
|
| StoreAdapter |
This class defines an API that must be implemented by extensions that need
to store user data in some non-LDAP data store.
|
| StoreAdapterConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a store adapter.
|
| StoreAdapterPlugin |
This class defines an API that must be implemented by extensions that need
to intercept operations processed by a Store Adapter.
|
| StoreAdapterPluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a store adapter plugin.
|
| StoreAttributeDefinition |
An attribute in a Store Adapter's native schema.
|
| StoreAttributeDefinition.Builder |
Builder class to build an instance of StoreAttributeDefinition.
|
| StoreAttributeDefinition.Type |
An enumeration of the data types for values.
|
| StoreCreateRequest |
Represents a request to create an entry in a Store Adapter.
|
| StoreDeleteRequest |
Represents a request to delete a specific entry from a Store Adapter.
|
| StorePostCreateRequestContext |
Request context for the method called after an entry is created in the
native data store.
|
| StorePostDeleteRequestContext |
Request context for the method after an entry is deleted in the
native data store.
|
| StorePostRetrieveRequestContext |
Request context for the method called after an entry is retrieved from the
native data store.
|
| StorePostSearchEntryContext |
Request context for the method called for each entry found during a search
in the native data store.
|
| StorePostUpdateRequestContext |
Request context for the method after an entry is updated in the
native data store.
|
| StorePreCreateRequestContext |
Request context for the method called before an entry is created in the
native data store.
|
| StorePreDeleteRequestContext |
Request context for the method called before an entry is deleted in the
native data store.
|
| StorePreRetrieveRequestContext |
Request context for the method called before an entry is retrieved from the
native data store.
|
| StorePreSearchRequestContext |
Request context for the method called before searching for entries in the
native data store.
|
| StorePreUpdateRequestContext |
Request context for the method called before an entry is updated in the
native data store.
|
| StoreRequest |
Represents a request to a Store Adapter.
|
| StoreRequestContext |
Common methods available to all Store Adapter Plugin request context
interfaces.
|
| StoreRetrieveRequest |
Represents a request to retrieve a specific entry from a Store Adapter.
|
| StoreSearchRequest |
Represents a search request to retrieve entries from a Store Adapter.
|
| StoreSearchResultListener |
This interface defines methods that provide search result objects to a
requester as they are returned from a Store Adapter.
|
| StoreUpdateRequest |
Represents a request to update a specific entry in a Store Adapter.
|
| SubordinateModifyDNPluginResult |
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.
|
| SubstringMatchingRule |
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.
|
| SuccessSASLBindResult |
This interface may be used to obtain information about the result of
processing a SASL bind operation in which a user has successfully completed
the authentication process.
|
| SyncClass |
This interface represents the matched Sync Class for a SyncOperation. |
| SyncDestination |
This class defines an API that must be implemented by extensions that
wish to push changes processed by the Data Sync Server to an
arbitrary destination.
|
| SyncDestinationConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a generic Sync Destination.
|
| SynchronizationServerExtension |
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
Ping Identity Data Sync Server (which may also be referred to as the
Data Sync Server).
|
| SyncOperation |
This interface represents a single synchronized change from the Sync
Source to the Sync Destination.
|
| SyncOperationType |
The type of a Sync Operation.
|
| SyncPipePlugin |
This class defines an API that must be implemented by extensions that
perform processing on synchronization operations within the Sync Pipe.
|
| SyncPipePluginConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration of a sync pipe plugin.
|
| SyncServerContext |
This interface may be used to obtain information about the
Data Sync Server in which an extension is running.
|
| SyncSource |
This class defines an API that must be implemented by extensions in order to
synchronize data from a generic (non-LDAP and non-JDBC) endpoint.
|
| SyncSourceConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a generic Sync Source.
|
| SyncSourceContext |
This interface provides basic contextual information about a
SyncSource and the SyncPipe that is actively using it.
|
| Task |
This class defines an API that must be implemented by extensions which
may be used as administrative tasks.
|
| TaskContext |
This interface may be used to obtain information about an administrative
task which is being processed.
|
| TaskReturnState |
This enum defines the states that a task may have after it has completed
processing.
|
| TokenOwnerPrincipal |
A principal implementation for a user represented by an access token.
|
| TokenResourceLookupMethod |
This class defines an API that must be implemented by extensions that provide
a custom Token Resource Lookup Method for access token validation.
|
| TokenResourceLookupMethodConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a token resource lookup
method.
|
| TokenValidationResult |
Object returned from a request to an AccessTokenValidator to validate a
token.
|
| TokenValidationResult.Builder |
A Builder for TokenValidationResult.
|
| ToolExecutor |
This can be used to internally execute select command line utilities and
return the results.
|
| ToolResult |
Returns the result of a command line utility.
|
| TransactionContext |
This class wraps an open JDBC Connection and provides controlled access to it
via a handful of delegating methods.
|
| TrustManagerProvider |
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.
|
| TrustManagerProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a trust manager provider.
|
| UnavailableAlertType |
This interface may be used to interact with an alert type that may cause the
server to be classified as unavailable.
|
| UnbindRequest |
This interface defines a set of methods which may be used to interact with
an unbind request.
|
| UnboundIDExtension |
This interface is used to mark classes which may be extensions to UnboundID
products.
|
| UncachedAttributeCriteria |
This class defines an API that must be implemented by extensions which have
the ability to determine which attributes should be stored in the
uncached-id2entry database of a local DB backend, while the remainder of the
entry is stored in the id2entry database.
|
| UncachedAttributeCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an uncached attribute
criteria object.
|
| UncachedEntryCriteria |
This class defines an API that must be implemented by extensions which have
the ability to determine which entries should be stored in the
uncached-id2entry database of a local DB backend, rather than in the id2entry
database.
|
| UncachedEntryCriteriaConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for an uncached entry criteria
object.
|
| UpdatableAbandonRequest |
This interface defines a set of methods which may be used to update an
abandon request.
|
| UpdatableAddRequest |
This interface defines a set of methods which may be used to update an add
request.
|
| UpdatableAddResult |
This interface defines a set of methods which may be used to update add
results.
|
| UpdatableBindRequest |
This interface defines a set of methods which may be used to update a bind
request.
|
| UpdatableBindResult |
This interface defines a set of methods which may be used to update bind
results.
|
| UpdatableCompareRequest |
This interface defines a set of methods which may be used to update a compare
request.
|
| UpdatableCompareResult |
This interface defines a set of methods which may be used to update compare
results.
|
| UpdatableDeleteRequest |
This interface defines a set of methods which may be used to update a delete
request.
|
| UpdatableDeleteResult |
This interface defines a set of methods which may be used to update delete
results.
|
| UpdatableEntry |
This interface defines a set of methods which may be used to update the
contents of an entry.
|
| UpdatableExtendedRequest |
This interface defines a set of methods which may be used to update an
extended request.
|
| UpdatableExtendedResult |
This interface defines a set of methods which may be used to update extended
results.
|
| UpdatableGenericResult |
This interface defines a set of methods which may be used to update the
contents of operation results.
|
| UpdatableModifyDNRequest |
This interface defines a set of methods which may be used to update a modify
DN request.
|
| UpdatableModifyDNResult |
This interface defines a set of methods which may be used to update modify DN
results.
|
| UpdatableModifyRequest |
This interface defines a set of methods which may be used to update a modify
request.
|
| UpdatableModifyResult |
This interface defines a set of methods which may be used to update modify
results.
|
| UpdatableRequest |
This interface defines a set of methods which may be used to update the
contents of operation requests.
|
| UpdatableResult |
This interface defines a set of methods which may be used to update the
contents of operation results.
|
| UpdatableSASLBindRequest |
This interface defines a set of methods which may be used to update a SASL
bind request.
|
| UpdatableSearchRequest |
This interface defines a set of methods which may be used to update a search
request.
|
| UpdatableSearchResult |
This interface defines a set of methods which may be used to update search
results.
|
| UpdatableSimpleBindRequest |
This interface defines a set of methods which may be used to update a simple
bind request.
|
| UpdatableUnbindRequest |
This interface defines a set of methods which may be used to update an unbind
request.
|
| UpdateExtensionDetails |
This class defines a structure which may be used to provide information about
the manage extension update state.
|
| ValueConstructor |
A ValueConstructor is used to build String values using a value-pattern
template that references attribute values within an Entry.
|
| VelocityContext |
Context used to provide named objects to Velocity templates as they are
they are used to render output.
|
| VelocityContextProvider |
This class defines an API that must be implemented by extensions which
contribute content to server pages authored as Velocity templates.
|
| VelocityContextProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a Velocity context
provider.
|
| VelocityContextProviderConfig.ObjectScope |
|
| Version |
This class provides version information for the UnboundID Server SDK.
|
| VirtualAttributeProvider |
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.
|
| VirtualAttributeProviderConfig |
This interface defines a set of methods that may be used to obtain
information about the general configuration for a virtual attribute provider.
|
| WebAppServerContext |
This interface may be used to interact with the server from within a web
application.
|
| WebAppServerContextFactory |
|
| WritabilityMode |
This class implements an enumeration that may be used to control
the writability mode for the entire server or for a specific
backend.
|