OpenDJ Server 3.0.0-SNAPSHOT Documentation
A B C D E F G H I L M 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.
getAdminPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the administration connector port.
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.
getCertificate() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the certificate linked to this setup.
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.
getDataConfiguration() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the data configuration of this model.
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.
getHostName() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the host name.
getHTTPPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the value of the HTTP connection handler port.
getImportLdifRuntimeOptions() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the runtime options that apply to the current import LDIF.
getInstallationPath() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the installation path of this model.
getInstance() - Static method in class org.forgerock.opendj.server.core.ProductInformation
Returns the singleton product information instance.
getInstancePath() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the instance path.
getJMXPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the JMX's port value.
getLdapPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the value of the LDAP port.
getLdapsPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Return the LDAPs port.
getLicense() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the license.
getListenerSettings() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the listener settings.
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.
getPassword() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the password linked to this root user DN.
getPasswordFile() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
The file containing the password for the initial root user for the directory server.
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.
getReplicationConfiguration() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the replication configuration of this model.
getRootUserDN() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the root user DN.
getSecurityStrengthFactor() - Method in interface org.forgerock.opendj.server.core.Operation
Returns the strongest cipher strength currently in use by the underlying connection.
getServerRuntimeSettings() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the runtime options that apply to this installation.
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.
getSNMPPort() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the value of the port used by SNMP.
getSSLPortNumber() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns the port number which is used with SSL.
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.
getType() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns the type of this configuration.

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
hasLicense() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns true if this configuration has a non-empty license.
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.
isCli() - Method in class org.forgerock.opendj.server.setup.cli.SetupCli
Returns whether the command was launched in CLI mode or not.
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.
isCreateProxy() - Method in class org.forgerock.opendj.server.setup.cli.SetupCli
Returns whether the command was launched to setup proxy or not.
isHTTPConnectionHandlerEnabled() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns true if the HTTP connection handler is enabled.
isInteractive() - Method in class org.forgerock.opendj.server.setup.cli.SetupCli
isInternal() - Method in class org.forgerock.opendj.server.core.DataProviderID
Indicating whether or not this ID represents an internal data provider.
isJMXConnectionHandlerEnabled() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns true if the JMX connection handler is enabled.
isQuiet() - Method in class org.forgerock.opendj.server.setup.cli.SetupCli
isService() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns true if the directory server should start as a service.
isSNMPConnectionHandlerEnabled() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns true if the SNMP connection handler is enabled.
isSSLEnabled() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns true is SSL is enabled.
isStartingServerAfterSetup() - Method in class org.forgerock.opendj.server.setup.model.Model
Returns true if the server must start after the installation.
isTLSEnabled() - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Returns true is TLS is enabled.
isVerbose() - Method in class org.forgerock.opendj.server.setup.cli.SetupCli

L

ListenerSettings - Class in org.forgerock.opendj.server.setup.model
This class provides listener settings for the OpenDJ3 setup.
ListenerSettings() - Constructor for class org.forgerock.opendj.server.setup.model.ListenerSettings
Default constructor.

M

main(String[]) - Static method in class org.forgerock.opendj.server.setup.cli.SetupCli
The main method for setup tool.
Model - Class in org.forgerock.opendj.server.setup.model
This class provides configuration's model for the OpenDJ3 setup.
Model() - Constructor for class org.forgerock.opendj.server.setup.model.Model
 
Model.DataStoreModel - Class in org.forgerock.opendj.server.setup.model
Creates a basic data store model configuration for setup.
Model.DataStoreModel() - Constructor for class org.forgerock.opendj.server.setup.model.Model.DataStoreModel
The default data store model.
Model.Type - Enum in org.forgerock.opendj.server.setup.model
This enumeration is used to know what kind of server we want to set up.

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.
org.forgerock.opendj.server.setup.cli - package org.forgerock.opendj.server.setup.cli
Contains API for the Opendj3 setup CLI.
org.forgerock.opendj.server.setup.model - package org.forgerock.opendj.server.setup.model
Contains API for the Opendj3 setup.

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.
setAdminPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the administration connector 's port.
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.
setCertificate(Certificate) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the certificate used in this setup.
setDataConfiguration(DataConfiguration) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the data configuration of this model.
setHostName(String) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the host name of the machine.
setHTTPConnectionHandlerEnabled(boolean) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the status of the HTTP connection handler.
setHTTPPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the value of the port which is going to be used bu the HTTP connection handler.
setImportLdifRuntimeOptions(RuntimeOptions) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the runtime options that apply to the current import LDIF.
setInstallationPath(String) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the installation path of this model.
setInstancePath(String) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the current instance path location.
setJMXConnectionHandlerEnabled(boolean) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the status of the JMX connection handler.
setJMXPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the JMX port's value.
setLdapPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the value of the LDAP port.
setLdapsPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the LDAPs port value.
setLicense(String) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the license linked to this installation.
setListenerSettings(ListenerSettings) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the listener settings.
setPassword(String) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the user root's password.
setPasswordFile(File) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the file containing the password for the initial root user for the directory server.
setReplicationConfiguration(ReplicationConfiguration) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the replication configuration of this model.
setRootUserDN(String) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the root user DN.
setServerRuntimeOptions(RuntimeOptions) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the runtime options that apply to this installation.
setService(boolean) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the directory server as a service.
setSNMPConnectionHandlerEnabled(boolean) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the status of the HTTP connection handler.
setSNMPPort(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the value of the port used by SNMP.
setSSLEnabled(boolean) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets a flag is SSL is enabled.
setSSLPortNumber(int) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets the SSL's port number.
setStartingServerAfterSetup(boolean) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets if the server should start after its installation.
setTLSEnabled(boolean) - Method in class org.forgerock.opendj.server.setup.model.ListenerSettings
Sets a flag is TLS is enabled.
setType(Model.Type) - Method in class org.forgerock.opendj.server.setup.model.Model
Sets the type of this configuration.
SetupCli - Class in org.forgerock.opendj.server.setup.cli
This class implements the new CLI for OpenDJ3 setup.
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.
valueOf(String) - Static method in enum org.forgerock.opendj.server.setup.model.Model.Type
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.
values() - Static method in enum org.forgerock.opendj.server.setup.model.Model.Type
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 L M N O P R S T V 
OpenDJ Server 3.0.0-SNAPSHOT Documentation

Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.