Package org.opends.server.backends.pluggable

Class BackendImpl<C extends PluggableBackendCfg>

    • Constructor Detail

      • BackendImpl

        public BackendImpl()

    • Method Detail

      • configureBackend

        public void configureBackend​(C cfg,
                             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<C extends PluggableBackendCfg>
        Parameters:
        cfg - The configuration of this backend.
        serverContext - The server context for this instance
        Throws:
        ConfigException - If there is an error in the configuration.

      • closeBackend

        public 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.

        Overrides:
        closeBackend in class LocalBackend<C extends PluggableBackendCfg>

      • 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<C extends PluggableBackendCfg>
        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.

      • supports

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

      • getSupportedFeatures

        public Set<String> getSupportedFeatures()
        Description copied from class: Backend
        Retrieves the OIDs of the features that may be supported by this backend.
        Specified by:
        getSupportedFeatures in class Backend<C extends PluggableBackendCfg>
        Returns:
        The OIDs of the features that may be supported by this backend.

      • getSupportedControls

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

      • 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<C extends PluggableBackendCfg>
        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<C extends PluggableBackendCfg>
        Returns:
        The total number of entries contained in this backend, or -1 if that information is not available.

      • hasSubordinates

        public ConditionResult hasSubordinates​(DN entryDN)
                                throws DirectoryException
        Description copied from class: LocalBackend
        Indicates whether the requested entry has any subordinates.
        Specified by:
        hasSubordinates in class LocalBackend<C extends PluggableBackendCfg>
        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:
        DirectoryException - If a problem occurs while trying to retrieve the entry.

      • getNumberOfEntriesInBaseDN

        public long getNumberOfEntriesInBaseDN​(DN baseDN)
                                throws DirectoryException
        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<C extends PluggableBackendCfg>
        Parameters:
        baseDN - The base distinguished name.
        Returns:
        The number of subordinate entries including the base dn.
        Throws:
        DirectoryException - If baseDN isn't a base dn managed by this backend or if a problem occurs while trying to retrieve the entry.

      • getNumberOfChildren

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

      • entryExists

        public boolean entryExists​(DN entryDN)
                    throws DirectoryException
        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<C extends PluggableBackendCfg>
        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.
        Throws:
        DirectoryException - If a problem occurs while trying to make the determination.

      • getEntry

        public Entry getEntry​(DN entryDN)
               throws DirectoryException
        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<C extends PluggableBackendCfg>
        Parameters:
        entryDN - The distinguished name of the entry to retrieve.
        Returns:
        The requested entry, or null if the entry does not exist.
        Throws:
        DirectoryException - If a problem occurs while trying to retrieve the entry.

      • addEntry

        public void addEntry​(Entry entry,
                     AddOperation addOperation)
              throws DirectoryException,
                     CanceledOperationException
        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<C extends PluggableBackendCfg>
        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:
        DirectoryException - If a problem occurs while trying to add the entry.
        CanceledOperationException - 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 DirectoryException,
                        CanceledOperationException
        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<C extends PluggableBackendCfg>
        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:
        DirectoryException - If a problem occurs while trying to remove the entry.
        CanceledOperationException - 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 DirectoryException,
                         CanceledOperationException
        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<C extends PluggableBackendCfg>
        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. This may be null for modifications performed internally.
        Throws:
        DirectoryException - If a problem occurs while trying to replace the entry.
        CanceledOperationException - 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 DirectoryException,
                        CanceledOperationException
        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<C extends PluggableBackendCfg>
        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:
        DirectoryException - If a problem occurs while trying to perform the rename.
        CanceledOperationException - If this backend noticed and reacted to a request to cancel or abandon the modify DN operation.

      • removeBackup

        public void removeBackup​(BackupDirectory backupDirectory,
                         String backupID)
                  throws DirectoryException
        Description copied from class: LocalBackend
        Removes the specified backup if it is possible to do so.
        Specified by:
        removeBackup in class LocalBackend<C extends PluggableBackendCfg>
        Parameters:
        backupDirectory - The backup directory structure with which the specified backup is associated.
        backupID - The backup ID for the backup to be removed.
        Throws:
        DirectoryException - If it is not possible to remove the specified backup for some reason (e.g., no such backup exists or there are other backups that are dependent upon it).

      • configureStorage

        protected abstract Storage configureStorage​(C cfg,
                                            ServerContext serverContext)
                                     throws ConfigException
        Creates the storage engine which will be used by this pluggable backend. Implementations should create and configure a new storage engine but not open it.
        Parameters:
        cfg - the configuration object
        serverContext - this Directory Server intsance's server context
        Returns:
        The storage engine to be used by this pluggable backend.
        Throws:
        ConfigException - If there is an error in the configuration.

      • isConfigurationAcceptable

        public boolean isConfigurationAcceptable​(C config,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons,
                                         ServerContext serverContext)
        Description copied from class: Backend
        Indicates whether the provided configuration is acceptable for this backend. It should be possible to call this method on an uninitialized backend instance in order to determine whether the backend would be able to use the provided configuration.

        Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.
        Overrides:
        isConfigurationAcceptable in class Backend<C extends PluggableBackendCfg>
        Parameters:
        config - The backend configuration for which to make the determination.
        unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.
        serverContext - this Directory Server instance's server context
        Returns:
        true if the provided configuration is acceptable for this backend, or false if not.

      • isConfigurationChangeAcceptable

        public boolean isConfigurationChangeAcceptable​(PluggableBackendCfg cfg,
                                               List<org.forgerock.i18n.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<C extends PluggableBackendCfg>
        Parameters:
        cfg - 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​(PluggableBackendCfg newCfg)
        Applies the configuration changes to this change listener.

        Storage.write(WriteOperation) replays its operation after a transaction conflict, so the operation below is confined to work a rollback undoes: the trees are deleted and opened there, while the registries, which no rollback reaches, are updated once the write has committed. Getting this the wrong way round leaves the change half applied, and its replay reports the missing half rather than the conflict that caused it.

        What makes the operation replayable is that the base DNs to remove and to add are worked out once, ahead of the write, so that no attempt can see different work to do than the attempt it is replacing.

        Specified by:
        applyConfigurationChange in interface ConfigurationChangeListener<C extends PluggableBackendCfg>
        Parameters:
        newCfg - The new configuration containing the changes.
        Returns:
        Returns information about the result of changing the configuration.

      • getRootContainer

        public final RootContainer getRootContainer()
        Returns a handle to the root container currently used by this backend. The rootContainer could be NULL if the backend is not initialized.
        Returns:
        The RootContainer object currently used by this backend.