Package org.opends.server.backends

Class LDIFBackend

java.lang.Object
org.opends.server.api.Backend<C>
org.opends.server.api.LocalBackend<LdifBackendCfg>
org.opends.server.backends.LDIFBackend
All Implemented Interfaces:
ConfigurationChangeListener<LdifBackendCfg>, AlertGenerator, Backupable, HealthStatusProvider
public final class LDIFBackend extends LocalBackend<LdifBackendCfg> implements ConfigurationChangeListener<LdifBackendCfg>, AlertGenerator, Backupable
This class provides a backend implementation that stores the underlying data in an LDIF file. When the backend is initialized, the contents of the backend are read into memory and all read operations are performed purely from memory. Write operations cause the underlying LDIF file to be re-written on disk.

  • Constructor Details

    • LDIFBackend

      public LDIFBackend()

  • Method Details

    • openBackend

      public void openBackend() throws ConfigException, InitializationException
      Description copied from class: LocalBackend
      Opens this backend based on the information provided when the backend was configured. It also should open any underlying storage and register all suffixes with the server.
      Specified by:
      openBackend in class LocalBackend<LdifBackendCfg>
      Throws:
      ConfigException - If an unrecoverable problem arises while opening the backend.
      InitializationException - If a problem occurs during opening that is not related to the server configuration.
      See Also:

    • isPublicBackend

      public boolean isPublicBackend()
      Description copied from class: Backend
      Indicates whether the base DNs of this backend should be considered public or private.

      This method also controls the visibility of the associated naming contexts. i.e. if any base DN of this backend is a naming context, then it will be public or private, based on the value returned by this method.

      Reminder: Public naming contexts are returned when querying the root DSE entry.

      Specified by:
      isPublicBackend in class Backend<LdifBackendCfg>
      Returns:
      true if this backend's baseDNs could be exposed as a public naming context, false if they must remain private naming contexts.

    • closeBackend

      protected void closeBackend()
      Description copied from class: LocalBackend
      Performs any necessary work to finally close this backend, particularly closing any underlying databases or connections and deregistering any suffixes that it manages with the Directory Server.

      It will be called as final step of finalizeBackend(), so subclasses might override it.

      Specified by:
      closeBackend in class LocalBackend<LdifBackendCfg>

    • getBaseDNs

      public Set<Dn> getBaseDNs()
      Description copied from class: Backend
      Retrieves the set of base-level DNs that may be used within this backend.
      Specified by:
      getBaseDNs in class Backend<LdifBackendCfg>
      Returns:
      The set of base-level DNs that may be used within this backend.

    • getEntryCount

      public long getEntryCount()
      Description copied from class: LocalBackend
      Retrieves the total number of entries contained in this backend, if that information is available.
      Specified by:
      getEntryCount in class LocalBackend<LdifBackendCfg>
      Returns:
      The total number of entries contained in this backend, or -1 if that information is not available.

    • isIndexed

      public boolean isIndexed(AttributeType attributeType, IndexType indexType)
      Description copied from class: LocalBackend
      Indicates whether search operations which target the specified attribute in the indicated manner would be considered indexed in this backend. The operation should be considered indexed only if the specified operation can be completed efficiently within the backend.

      Note that this method should return a general result that covers all values of the specified attribute. If a the specified attribute is indexed in the indicated manner but some particular values may still be treated as unindexed (e.g., if the number of entries with that attribute value exceeds some threshold), then this method should still return true for the specified attribute and index type.
      Specified by:
      isIndexed in class LocalBackend<LdifBackendCfg>
      Parameters:
      attributeType - The attribute type for which to make the determination.
      indexType - The index type for which to make the determination.
      Returns:
      true if search operations targeting the specified attribute in the indicated manner should be considered indexed, or false if not.

    • isIndexed

      public boolean isIndexed(AttributeType attributeType, MatchingRule matchingRule)
      Description copied from class: LocalBackend
      Indicates whether extensible match search operations that target the specified attribute with the given matching rule should be considered indexed in this backend.
      Specified by:
      isIndexed in class LocalBackend<LdifBackendCfg>
      Parameters:
      attributeType - The attribute type for which to make the determination.
      matchingRule - The matching rule for which to make the determination.
      Returns:
      true if extensible match search operations targeting the specified attribute with the given matching rule should be considered indexed, or false if not.

    • hasSubordinates

      public ConditionResult hasSubordinates(Dn entryDN) throws LdapException
      Description copied from class: LocalBackend
      Indicates whether the requested entry has any subordinates.
      Specified by:
      hasSubordinates in class LocalBackend<LdifBackendCfg>
      Parameters:
      entryDN - The distinguished name of the entry.
      Returns:
      ConditionResult.TRUE if the entry has one or more subordinates or ConditionResult.FALSE otherwise or ConditionResult.UNDEFINED if it can not be determined.
      Throws:
      LdapException - If a problem occurs while trying to retrieve the entry.

    • getNumberOfChildren

      public long getNumberOfChildren(Dn parentDN) throws LdapException
      Description copied from class: LocalBackend
      Retrieves the number of subordinates immediately below the requested entry.
      Specified by:
      getNumberOfChildren in class LocalBackend<LdifBackendCfg>
      Parameters:
      parentDN - The distinguished name of the parent.
      Returns:
      The number of subordinate entries for the requested entry.
      Throws:
      LdapException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

    • getNumberOfEntriesInBaseDN

      public long getNumberOfEntriesInBaseDN(Dn baseDN) throws LdapException
      Description copied from class: LocalBackend
      Retrieves the number of entries for the specified base DN including all entries from the requested entry to the lowest level in the tree.
      Specified by:
      getNumberOfEntriesInBaseDN in class LocalBackend<LdifBackendCfg>
      Parameters:
      baseDN - The base distinguished name.
      Returns:
      The number of subordinate entries including the base dn.
      Throws:
      LdapException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

    • getEntry

      public Entry getEntry(Dn entryDN)
      Description copied from class: LocalBackend
      Retrieves the requested entry from this backend. The caller is not required to hold any locks on the specified DN.
      Specified by:
      getEntry in class LocalBackend<LdifBackendCfg>
      Parameters:
      entryDN - The distinguished name of the entry to retrieve.
      Returns:
      The requested entry, or null if the entry does not exist.

    • entryExists

      public boolean entryExists(Dn entryDN)
      Description copied from class: LocalBackend
      Indicates whether an entry with the specified DN exists in the backend. The default implementation calls getEntry, but backend implementations may override this with a more efficient version. The caller is not required to hold any locks on the specified DN.
      Overrides:
      entryExists in class LocalBackend<LdifBackendCfg>
      Parameters:
      entryDN - The DN of the entry for which to determine existence.
      Returns:
      true if the specified entry exists in this backend, or false if it does not.

    • addEntry

      public void addEntry(Entry entry, AddOperation addOperation) throws LdapException
      Description copied from class: LocalBackend
      Adds the provided entry to this backend. This method must ensure that the entry is appropriate for the backend and that no entry already exists with the same DN. The caller must hold a write lock on the DN of the provided entry.
      Specified by:
      addEntry in class LocalBackend<LdifBackendCfg>
      Parameters:
      entry - The entry to add to this backend.
      addOperation - The add operation with which the new entry is associated. This may be null for adds performed internally.
      Throws:
      LdapException - If a problem occurs while trying to add the entry.
      CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the add operation.

    • deleteEntry

      public void deleteEntry(Dn entryDN, DeleteOperation deleteOperation) throws LdapException
      Description copied from class: LocalBackend
      Removes the specified entry from this backend. This method must ensure that the entry exists and that it does not have any subordinate entries (unless the backend supports a subtree delete operation and the client included the appropriate information in the request). The caller must hold a write lock on the provided entry DN.
      Specified by:
      deleteEntry in class LocalBackend<LdifBackendCfg>
      Parameters:
      entryDN - The DN of the entry to remove from this backend.
      deleteOperation - The delete operation with which this action is associated. This may be null for deletes performed internally.
      Throws:
      LdapException - If a problem occurs while trying to remove the entry.
      CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the delete operation.

    • replaceEntry

      public void replaceEntry(Entry oldEntry, Entry newEntry, ModifyOperation modifyOperation) throws LdapException
      Description copied from class: LocalBackend
      Replaces the specified entry with the provided entry in this backend. The backend must ensure that an entry already exists with the same DN as the provided entry. The caller must hold a write lock on the DN of the provided entry.
      Specified by:
      replaceEntry in class LocalBackend<LdifBackendCfg>
      Parameters:
      oldEntry - The original entry that is being replaced.
      newEntry - The new entry to use in place of the existing entry with the same DN.
      modifyOperation - The modify operation with which this action is associated.
      Throws:
      LdapException - If a problem occurs while trying to replace the entry.
      CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the modify operation.

    • renameEntry

      public void renameEntry(Dn currentDN, Entry entry, ModifyDnOperation modifyDNOperation) throws LdapException
      Description copied from class: LocalBackend
      Moves and/or renames the provided entry in this backend, altering any subordinate entries as necessary. This must ensure that an entry already exists with the provided current DN, and that no entry exists with the target DN of the provided entry. The caller must hold write locks on both the current DN and the new DN for the entry.
      Specified by:
      renameEntry in class LocalBackend<LdifBackendCfg>
      Parameters:
      currentDN - The current DN of the entry to be moved/renamed.
      entry - The new content to use for the entry.
      modifyDNOperation - The modify DN operation with which this action is associated. This may be null for modify DN operations performed internally.
      Throws:
      LdapException - If a problem occurs while trying to perform the rename.
      CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the modify DN operation.

    • search

      public void search(SearchOperation searchOperation) throws LdapException
      Description copied from class: LocalBackend
      Processes the specified search in this backend. Matching entries should be provided back to the core server using the SearchOperation.returnEntry method. The caller is not required to have any locks when calling this operation.
      Specified by:
      search in class LocalBackend<LdifBackendCfg>
      Parameters:
      searchOperation - The search operation to be processed.
      Throws:
      LdapException - If a problem occurs while processing the search.
      CancelledResultException - If this backend noticed and reacted to a request to cancel or abandon the search operation.

    • getSupportedControls

      public Set<String> getSupportedControls()
      Description copied from class: Backend
      Retrieves the OIDs of the controls that may be supported by this backend.
      Overrides:
      getSupportedControls in class Backend<LdifBackendCfg>
      Returns:
      The OIDs of the controls that may be supported by this backend.

    • supports

      public boolean supports(LocalBackend.BackendOperation backendOperation)
      Description copied from class: LocalBackend
      Indicates whether this backend supports the provided backend operation.
      Overrides:
      supports in class LocalBackend<LdifBackendCfg>
      Parameters:
      backendOperation - the backend operation
      Returns:
      true if this backend supports the provided backend operation, false otherwise.

    • exportLDIF

      public void exportLDIF(LDIFExportConfig exportConfig)
      Description copied from class: LocalBackend
      Exports the contents of this backend to LDIF. This method should only be called if LocalBackend.supports(BackendOperation) with LocalBackend.BackendOperation.LDIF_EXPORT returns true.

      Note that the server will not explicitly initialize this backend before calling this method.

      Overrides:
      exportLDIF in class LocalBackend<LdifBackendCfg>
      Parameters:
      exportConfig - The configuration to use when performing the export.

    • importLDIF

      public LocalBackend.LDIFImportResult importLDIF(LDIFImportConfig importConfig, ServerContext serverContext) throws LdapException
      Description copied from class: LocalBackend
      Imports information from an LDIF file into this backend. This method should only be called if LocalBackend.supports(BackendOperation) with LocalBackend.BackendOperation.LDIF_IMPORT returns true.

      Note that the server will not explicitly initialize this backend before calling this method.

      Overrides:
      importLDIF in class LocalBackend<LdifBackendCfg>
      Parameters:
      importConfig - The configuration to use when performing the import.
      serverContext - The server context
      Returns:
      Information about the result of the import processing.
      Throws:
      LdapException - If a problem occurs while performing the LDIF import.

    • configureBackend

      public void configureBackend(LdifBackendCfg config, ServerContext serverContext) throws ConfigException
      Description copied from class: Backend
      Configure this backend based on the information in the provided configuration. When the method returns, the backend will have been configured (ready to be opened) but still unable to process operations.
      Specified by:
      configureBackend in class Backend<LdifBackendCfg>
      Parameters:
      config - The configuration of this backend.
      serverContext - The server context for this instance
      Throws:
      ConfigException - If there is an error in the configuration.

    • getServerContext

      protected ServerContext getServerContext()
      Description copied from class: LocalBackend
      Returns the server context used by this backend.
      Overrides:
      getServerContext in class LocalBackend<LdifBackendCfg>
      Returns:
      the server context used by this backend

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(LdifBackendCfg configuration, List<LocalizableMessage> unacceptableReasons)
      Description copied from interface: ConfigurationChangeListener
      Indicates whether the proposed change to the configuration is acceptable to this change listener.
      Specified by:
      isConfigurationChangeAcceptable in interface ConfigurationChangeListener<LdifBackendCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
      Returns:
      Returns true if the proposed change is acceptable, or false if it is not.

    • applyConfigurationChange

      public ConfigChangeResult applyConfigurationChange(LdifBackendCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<LdifBackendCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.

    • getComponentEntryDN

      public Dn getComponentEntryDN()
      Description copied from interface: AlertGenerator
      Retrieves the DN of the configuration entry with which this alert generator is associated.
      Specified by:
      getComponentEntryDN in interface AlertGenerator
      Returns:
      The DN of the configuration entry with which this alert generator is associated.

    • getAlerts

      public Map<String,String> getAlerts()
      Description copied from interface: AlertGenerator
      Retrieves information about the set of alerts that this generator may produce. The map returned should be between the notification type for a particular notification and the human-readable description for that notification. This alert generator must not generate any alerts with types that are not contained in this list.
      Specified by:
      getAlerts in interface AlertGenerator
      Returns:
      Information about the set of alerts that this generator may produce.

    • getDirectory

      public Path getDirectory()
      Description copied from interface: Backupable
      Returns the directory containing all the backend files to be backed up.
      Specified by:
      getDirectory in interface Backupable
      Returns:
      the directory containing all the backend files to be backed up.

    • getBackendFiles

      public BackupManager.CountedIterator<BackendFile> getBackendFiles()
      Description copied from interface: Backupable
      Returns an iterator that goes over all the backend files. The iterator may return deleted files, such files must be ignored during iteration.
      Specified by:
      getBackendFiles in interface Backupable
      Returns:
      A backend file iterator.

    • beforeBackup

      public void beforeBackup()
      Description copied from interface: Backupable
      Performs any necessary processing before a backup is performed. For example, this can take a shared lock or flush out a memory cache to backend files or delete stale data files.
      Specified by:
      beforeBackup in interface Backupable

    • afterBackup

      public void afterBackup()
      Description copied from interface: Backupable
      Performs any necessary processing after a backup is performed. This method is called even if backup has failed. For example, this can release a shared lock.
      Specified by:
      afterBackup in interface Backupable

    • beforeRestore

      public void beforeRestore()
      Description copied from interface: Backupable
      Performs any necessary processing before a restore is performed. For example, this can take an exclusive lock.
      Specified by:
      beforeRestore in interface Backupable

    • afterRestore

      public void afterRestore() throws InitializationException
      Description copied from interface: Backupable
      Performs any necessary processing after a restore is performed. This method is called even if restore has failed. For example, this can release an exclusive lock or load the restored files into memory.
      Specified by:
      afterRestore in interface Backupable
      Throws:
      InitializationException - If an error occurs.

    • getAndClearOfflineChanges

      public Collection<ChangeRecord> getAndClearOfflineChanges()
      Description copied from class: LocalBackend
      Returns any changes that have been applied to this backend while the server was offline. This method should only be called if LocalBackend.supports(BackendOperation) with LocalBackend.BackendOperation.OFFLINE_CHANGES returns true. This method is called on startup in order to synchronize the offline changes to the rest of the topology if the backend is replicated. On return, the backend should clear the offline changes.
      Overrides:
      getAndClearOfflineChanges in class LocalBackend<LdifBackendCfg>
      Returns:
      A list of zero or more changes that were made while the server was offline.

    • sampleEntries

      public void sampleEntries(Consumer<Entry> consumer, Dn baseDn) throws LdapException
      Description copied from class: LocalBackend
      Consumes all or a subset of entries contained in this backend under the provided base DN.

      Intent is to consume a restricted set of entries (for backend having more than a small number of entries) which would allow to differentiate two instances of the same backend containing different entries, without having to compare every entries contained in the backend.

      The sample always contains the entry corresponding to the provided base DN. All other entries being consumed and the order at which they're consumed is not defined but it is guaranteed that a backend implementation will consume the exact same set of entries in the exact same order while the backend contains the exact same set of entries.

      Overrides:
      sampleEntries in class LocalBackend<LdifBackendCfg>
      Parameters:
      consumer - the consumer of entry to process the data sample
      baseDn - the base DN of the domain
      Throws:
      LdapException - if an error occurs