Index (OpenDJ Server 3.0.0.gluu-SNAPSHOT Documentation)

A B C D E F G H I N O P R S T V

A

AbstractDataProvider - Class in org.forgerock.opendj.server.core: This class provides a skeletal implementation of the DataProvider interface, to minimize the effort required to implement this interface.
AbstractDataProvider() - Constructor for class org.forgerock.opendj.server.core.AbstractDataProvider: Creates a new abstract data provider.
ArchivableDataProvider - Interface in org.forgerock.opendj.server.core: A data provider which supports backup and restore functionality.
Attachment<T> - Class in org.forgerock.opendj.server.core: Class used to define dynamic typed attachments on AttachmentHolder instances.
Attachment(String, T) - Constructor for class org.forgerock.opendj.server.core.Attachment: Construct a new attachment with the specified name and default value.
AttachmentHolder - Interface in org.forgerock.opendj.server.core: Interface declares common functionality for objects, which can store Attachments.

B

BackupConfig - Interface in org.forgerock.opendj.server.core: Configuration options for performing backups.
BindRequestContext - Interface in org.forgerock.opendj.server.core: The bind request context allows for updating the authentication state of the connection.
buildId() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the build ID for the generated build of the Directory Server.
buildIsDebug() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns true if this is a debug build of the Directory Server that may include additional debugging facilities not available in standard release versions.
buildJavaVendor() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the vendor for the Java version used to generate this build.
buildJavaVersion() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the Java version used to generate this build.
buildJvmVendor() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the vendor for the JVM used to generate this build.
buildJvmVersion() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the JVM version used to generate this build.
buildOs() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the operating system on which this build was generated.
buildUser() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the username of the user that created this build.

C

close() - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Closes this data provider connection.
compareTo(DataProviderID) - Method in class org.forgerock.opendj.server.core.DataProviderID
containsEntry(DN) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Indicates whether this data provider contains the specified entry.
containsEntry(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Indicates whether this data provider contains the specified entry.
containsEntry(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Indicates whether the underlying data provider contains the specified entry.
createBackup(BackupConfig, LdapResultHandler<Void>) - Method in interface org.forgerock.opendj.server.core.ArchivableDataProvider: Creates a backup of the contents of this data provider in a form that may be restored at a later date if necessary.
createDataProvider(DataProviderID, T) - Method in interface org.forgerock.opendj.server.core.DataProviderFactory: Creates and initializes a new data provider based on the information in the provided configuration.

D

DataProvider - Interface in org.forgerock.opendj.server.core: An entry container which provides the content of one or more sub-trees.
DataProviderCfg - Interface in org.forgerock.opendj.server.core: This will be generated by the config framework.
DataProviderConnection - Interface in org.forgerock.opendj.server.core: A connection to a data provider.
DataProviderEvent - Class in org.forgerock.opendj.server.core: An object that provides information about the source of a data provider related event.
DataProviderEvent(LocalizableMessage, Set<DataProviderEvent.Type>) - Constructor for class org.forgerock.opendj.server.core.DataProviderEvent: Creates a new data provider event.
DataProviderEvent.Type - Enum in org.forgerock.opendj.server.core: Indicates the type of event that has occurred in the data provider.
DataProviderEventListener - Interface in org.forgerock.opendj.server.core: An object that registers to be notified of events generated by a DataProviderConnection object.
DataProviderFactory<T extends DataProviderCfg> - Interface in org.forgerock.opendj.server.core: A factory for creating data provider instances.
DataProviderID - Class in org.forgerock.opendj.server.core: A unique ID which can be used for identifying data providers.
DataProviderStatus - Enum in org.forgerock.opendj.server.core: The status of a data provider.
deregisterEventListener(DataProviderEventListener) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Deregisters an event listener from this data provider.
deregisterEventListener(DataProviderEventListener) - Method in interface org.forgerock.opendj.server.core.DataProvider: Deregisters an event listener from this data provider.
deregisterEventListener(DataProviderEventListener) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Deregisters an event listener from the underlying data provider.
documentationAdminGuideUrl() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the URL of the product WIKI page.
documentationHomePageUrl() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the URL of the product home page.
documentationReferenceGuideUrl() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the URL of the product WIKI page.
documentationWikiUrl() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the URL of the product WIKI page.

E

equals(Object) - Method in class org.forgerock.opendj.server.core.DataProviderID
ExportableDataProvider - Interface in org.forgerock.opendj.server.core: A data provider which supports LDIF export functionality.
exportEntries(EntryWriter, LdapResultHandler<Void>) - Method in interface org.forgerock.opendj.server.core.ExportableDataProvider: Exports the contents of this data provider to the provided entry writer.

F

finalizeDataProvider() - Method in interface org.forgerock.opendj.server.core.DataProvider: Performs any necessary work to finalize this data provider.

G

get(AttachmentHolder) - Method in class org.forgerock.opendj.server.core.Attachment: Retrieves the attachment value, stored on the AttachmentHolder.
getAttachment(String) - Method in interface org.forgerock.opendj.server.core.AttachmentHolder: Retrieves the attachment with the specified name.
getAttachmentNames() - Method in interface org.forgerock.opendj.server.core.AttachmentHolder: Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.
getAuthenticationEntry() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the entry for the user as whom the client is authenticated.
getAuthorizationEntry() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the entry for the user that should be considered the authorization identity for this operation.
getBaseDNs() - Method in interface org.forgerock.opendj.server.core.DataProvider: Returns an unmodifiable set containing the base DNs of the sub-trees which this data provider contains.
getBaseDNs() - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Returns an unmodifiable set containing the base DNs of the sub-trees which the underlying data provider contains.
getBindRequest() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the last successful bind request from the client.
getConnection() - Method in interface org.forgerock.opendj.server.core.Operation: Returns a connection for performing internal operations.
getConnectionID() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the unique identifier that is assigned to the client connection that submitted this operation.
getDataProviderID() - Method in interface org.forgerock.opendj.server.core.ArchivableDataProvider: Returns the ID of this data provider.
getDataProviderID() - Method in interface org.forgerock.opendj.server.core.ExportableDataProvider: Returns the ID of this data provider.
getDataProviderID() - Method in interface org.forgerock.opendj.server.core.ImportableDataProvider: Returns the ID of this data provider.
getEntry(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Retrieves the specified entry from this data provider.
getEntry(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Retrieves the specified entry from the underlying data provider.
getEventTypes() - Method in class org.forgerock.opendj.server.core.DataProviderEvent: Returns an unmodifiable set containing the types of event that have occurred in the data provider.
getInstance() - Static method in class org.forgerock.opendj.server.core.ProductInformation: Returns the singleton product information instance.
getLocalAddress() - Method in interface org.forgerock.opendj.server.core.Operation: Returns the InetSocketAddress associated with the local system.
getLookthroughLimit() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the default maximum number of entries that should checked for matches during a search.
getName() - Method in class org.forgerock.opendj.server.core.DataProviderID: Returns the data provider name associated with this data provider ID.
getOperationID() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the operation ID for this operation.
getPeerAddress() - Method in interface org.forgerock.opendj.server.core.Operation: Returns the InetSocketAddress associated with the remote system.
getProtocol() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the protocol that the client is using to communicate with the Directory Server.
getReason() - Method in class org.forgerock.opendj.server.core.DataProviderEvent: Returns a message describing this event.
getSecurityStrengthFactor() - Method in interface org.forgerock.opendj.server.core.Operation: Returns the strongest cipher strength currently in use by the underlying connection.
getSizeLimit() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the size limit that will be enforced for searches performed using this client connection.
getStatus(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Returns the current status of the provided base DN in this data provider.
getStatus(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Returns the current status of the provided base DN in the underlying data provider.
getSupportedControls(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Returns an unmodifiable set containing the OIDs of the controls that may be supported by the provided base DN in this data provider.
getSupportedControls(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Returns an unmodifiable set containing the OIDs of the controls that may be supported by the provided base DN in the underlying data provider.
getSupportedFeatures(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Returns an unmodifiable set containing the OIDs of the features that may be supported by the provided base DN in this data provider.
getSupportedFeatures(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Returns an unmodifiable set containing the OIDs of the features that may be supported by the provided base DN in the underlying data provider.
getTimeLimit() - Method in interface org.forgerock.opendj.server.core.Operation: Retrieves the time limit that will be enforced for searches performed using this client connection.

H

handleDataProviderEvent(DataProviderEvent) - Method in interface org.forgerock.opendj.server.core.DataProviderEventListener: The data provider has changed state due to an operational error, configuration change, or an administrative action.
hasAllPrivileges(Collection<Privilege>) - Method in interface org.forgerock.opendj.server.core.Operation: Indicates whether the authenticate client has all of the specified privileges.
hashCode() - Method in class org.forgerock.opendj.server.core.DataProviderID
hasPrivilege(Privilege) - Method in interface org.forgerock.opendj.server.core.Operation: Indicates whether the authenticated client has the specified privilege.

I

ImportableDataProvider - Interface in org.forgerock.opendj.server.core: A data provider which supports LDIF import functionality.
importEntries(EntryReader, LdapResultHandler<Void>) - Method in interface org.forgerock.opendj.server.core.ImportableDataProvider: Imports the contents of this data provider from the provided entry reader.
isConfigurationAcceptable(T, List<LocalizableMessage>) - Method in interface org.forgerock.opendj.server.core.DataProviderFactory: Indicates whether the provided configuration is acceptable for creating and initializing a new data provider using this data provider factory.
isInternal() - Method in class org.forgerock.opendj.server.core.DataProviderID: Indicating whether or not this ID represents an internal data provider.

N

newInternalID(String) - Static method in class org.forgerock.opendj.server.core.DataProviderID: Creates a new ID for an internal data provider.
newUserID(String) - Static method in class org.forgerock.opendj.server.core.DataProviderID: Creates a new ID for a user configured data provider.
notifyDataProviderEventOccurred(DataProviderEvent) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Notify all event listeners that this data provider has changed state due to an operational error, configuration change, or an administrative action.
notifyDataProviderEventOccurred(LocalizableMessage, Set<DataProviderEvent.Type>) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Notify all event listeners that this data provider has changed state due to an operational error, configuration change, or an administrative action.

O

Operation - Interface in org.forgerock.opendj.server.core: The context in which a request is to be processed.
org.forgerock.opendj.server.core - package org.forgerock.opendj.server.core: Contains APIs for new DataProvider design.

P

patchFixIds() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the set of bug IDs for fixes included in this build of the Directory Server.
Privilege - Interface in org.forgerock.opendj.server.core: TODO: User privilege.
ProductInformation - Class in org.forgerock.opendj.server.core: OpenDJ product information, including version number, build information, and references to documentation.
productName() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the full product name for the Directory Server, which may contain white space.
productPublicationDate() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the product publication date.
productReleaseDate() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the product release date.
productShortName() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the short product name for the Directory Server, suitable for use in file names.

R

registerEventListener(DataProviderEventListener) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Registers an event listener with this data provider.
registerEventListener(DataProviderEventListener) - Method in interface org.forgerock.opendj.server.core.DataProvider: Registers an event listener with this data provider.
registerEventListener(DataProviderEventListener) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Registers an event listener with the underlying data provider.
remove(AttachmentHolder) - Method in class org.forgerock.opendj.server.core.Attachment: Remove attachment value, stored on the AttachmentHolder.
removeAttachment(String) - Method in interface org.forgerock.opendj.server.core.AttachmentHolder: Removes the attachment with the specified name.
restoreBackup(RestoreConfig, LdapResultHandler<Void>) - Method in interface org.forgerock.opendj.server.core.ArchivableDataProvider: Restores a backup of the contents of this data provider.
RestoreConfig - Interface in org.forgerock.opendj.server.core: Configuration options for restoring backups.

S

scmRevision() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the revision number of the source repository on which this build is based.
scmUrl() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the URL of the source repository location on which this build is based.
set(AttachmentHolder, T) - Method in class org.forgerock.opendj.server.core.Attachment: Set attachment value, stored on the AttachmentHolder.
setAttachment(String, Object) - Method in interface org.forgerock.opendj.server.core.AttachmentHolder: Sets the value of the specified attachment.
setAuthenticationInfo(BindRequest, Entry, Entry) - Method in interface org.forgerock.opendj.server.core.BindRequestContext: Specifies information about the authentication that has been performed for this connection.
setAuthorizationEntry(Entry) - Method in interface org.forgerock.opendj.server.core.Operation: Sets the entry for the user that should be considered the authorization identity for this operation.
startDataProvider() - Method in interface org.forgerock.opendj.server.core.DataProvider: Starts this data provider so that it is ready to process client requests.
stopDataProvider() - Method in interface org.forgerock.opendj.server.core.DataProvider: Performs any necessary work to stop this data provider.
supportsBackup(BackupConfig, StringBuilder) - Method in interface org.forgerock.opendj.server.core.ArchivableDataProvider: Indicates whether this data provider provides a mechanism to perform a backup of its contents in a form that can be restored later, based on the provided configuration.
supportsChangeNotification(DN) - Method in class org.forgerock.opendj.server.core.AbstractDataProvider: Indicates whether or not the provided base DN in this data provider supports change notification.
supportsChangeNotification(DN) - Method in interface org.forgerock.opendj.server.core.DataProvider: Indicates whether or not the provided base DN in this data provider supports change notification.
supportsChangeNotification(DN) - Method in interface org.forgerock.opendj.server.core.DataProviderConnection: Indicates whether or not the provided base DN in the underlying data provider supports change notification.

T

toString() - Method in class org.forgerock.opendj.server.core.DataProviderEvent: Returns a string describing this event.
toString() - Method in class org.forgerock.opendj.server.core.DataProviderID
toString() - Method in enum org.forgerock.opendj.server.core.DataProviderStatus: Retrieves a string representation of this status.

V

valueOf(String) - Static method in enum org.forgerock.opendj.server.core.DataProviderEvent.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.server.core.DataProviderStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.forgerock.opendj.server.core.DataProviderEvent.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.server.core.DataProviderStatus: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the version number for the Directory Server.
versionBuildNumber() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the build number for the Directory Server.
versionCompact() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the compact version string for this product, suitable for use in path names and similar cases.
versionFull() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the full version string for this product.
versionMajorNumber() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the major version number for the Directory Server.
versionMinorNumber() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the minor version number for the Directory Server.
versionPointNumber() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the point version number for the Directory Server.
versionPrintable() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the printable version string for this product.
versionQualifier() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the version qualifier string for the Directory Server.
versionRevision() - Method in class org.forgerock.opendj.server.core.ProductInformation: Returns the revision number of the source repository on which this build is based.

A B C D E F G H I N O P R S T V