Package com.unboundid.directory.sdk.common.types

This package defines a number of data types for use in extensions intended for use in Ping Identity server products.

Interface Summary

Interface	Description
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.
AlertNotification	This interface defines a set of methods that may be used to interact with an alert notification.
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.
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.
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.
CompletedOperationContext	This interface defines a set of methods that may be used to obtain information about an operation for which processing has been completed.
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.
DegradedAlertType	This interface may be used to interact with an alert type that may cause the server to be classified as degraded.
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.
Entry	This interface defines a set of methods which may be used to interact with an entry.
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.
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.
InternalConnection	This interface defines a set of methods that may be used to perform internal operations within the server.
LogWriter	This interface provides methods to interact with a log writer within the core server logging framework.
OperationContext	This interface defines a set of methods that may be used to obtain information about an operation being processed by the server.
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.
ServerContext	This interface may be used to obtain information about the server in which an extension is running.
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.
UnavailableAlertType	This interface may be used to interact with an alert type that may cause the server to be classified as unavailable.
UpdatableEntry	This interface defines a set of methods which may be used to update the contents of an entry.
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.

Class Summary

Class	Description
ExtensionBundle	This class represents the physical state of a Ping Identity server extension bundle.
InstallExtensionDetails	This class defines a structure which may be used to provide information about the manage extension installation state.
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.
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.
TokenValidationResult	Object returned from a request to an AccessTokenValidator to validate a token.
TokenValidationResult.Builder	A Builder for TokenValidationResult.
UpdateExtensionDetails	This class defines a structure which may be used to provide information about the manage extension update state.
Version	This class provides version information for the UnboundID Server SDK.

Enum Summary

Enum	Description
AlarmSeverity	Enumerates severity types for alarm conditions from least severe to most severe.
AlertSeverity	This enumeration defines the severities that may be used for alert types.
AuthType	This enum defines the set of authentication types that may be used for a client connection.
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.
DisconnectReason	This enumeration defines the set of possible reasons for the closure of a connection between a client and the server.
LogCategory	This enum defines the set of severities that may be used for error log messages.
LogSeverity	This enum defines the set of severities that may be used for error log and trace log messages.
OperationType	This enumeration defines the set of possible operation types that may be processed by the server.

Exception Summary

Exception	Description
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.