Package org.forgerock.opendj.server.core

Interface DataProviderConnection

  • All Superinterfaces:
    org.forgerock.opendj.ldap.RequestHandler<Operation>
    public interface DataProviderConnection
extends org.forgerock.opendj.ldap.RequestHandler<Operation>
    A connection to a data provider. When a connection is no longer needed it must be closed.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Closes this data provider connection.
      boolean containsEntry​(org.forgerock.opendj.ldap.DN dn)
      Indicates whether the underlying data provider contains the specified entry.
      void deregisterEventListener​(DataProviderEventListener listener)
      Deregisters an event listener from the underlying data provider.
      Set<org.forgerock.opendj.ldap.DN> getBaseDNs()
      Returns an unmodifiable set containing the base DNs of the sub-trees which the underlying data provider contains.
      org.forgerock.opendj.ldap.Entry getEntry​(org.forgerock.opendj.ldap.DN dn)
      Retrieves the specified entry from the underlying data provider.
      DataProviderStatus getStatus​(org.forgerock.opendj.ldap.DN baseDN)
      Returns the current status of the provided base DN in the underlying data provider.
      Set<String> getSupportedControls​(org.forgerock.opendj.ldap.DN baseDN)
      Returns an unmodifiable set containing the OIDs of the controls that may be supported by the provided base DN in the underlying data provider.
      Set<String> getSupportedFeatures​(org.forgerock.opendj.ldap.DN baseDN)
      Returns an unmodifiable set containing the OIDs of the features that may be supported by the provided base DN in the underlying data provider.
      void registerEventListener​(DataProviderEventListener listener)
      Registers an event listener with the underlying data provider.
      boolean supportsChangeNotification​(org.forgerock.opendj.ldap.DN baseDN)
      Indicates whether the provided base DN in the underlying data provider supports change notification.

      • Methods inherited from interface org.forgerock.opendj.ldap.RequestHandler

        handleAdd, handleBind, handleCompare, handleDelete, handleExtendedRequest, handleModify, handleModifyDN, handleSearch

    • Method Detail

      • close

        void close()
        Closes this data provider connection. When this method returns the connection can no longer be used.

      • containsEntry

        boolean containsEntry​(org.forgerock.opendj.ldap.DN dn)
               throws org.forgerock.opendj.ldap.LdapException
        Indicates whether the underlying data provider contains the specified entry.
        Parameters:
        dn - The DN of the entry.
        Returns:
        true if the underlying data provider contains the specified entry, or false if it does not.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If a problem occurs while trying to make the determination, or if dn is not a DN equal to or subordinate to one of the base DNs managed by the underlying data provider.

      • deregisterEventListener

        void deregisterEventListener​(DataProviderEventListener listener)
        Deregisters an event listener from the underlying data provider.
        Parameters:
        listener - The event listener.

      • getBaseDNs

        Set<org.forgerock.opendj.ldap.DN> getBaseDNs()
        Returns an unmodifiable set containing the base DNs of the sub-trees which the underlying data provider contains.
        Returns:
        An unmodifiable set containing the base DNs of the sub-trees which the underlying data provider contains.

      • getEntry

        org.forgerock.opendj.ldap.Entry getEntry​(org.forgerock.opendj.ldap.DN dn)
                                  throws org.forgerock.opendj.ldap.LdapException
        Retrieves the specified entry from the underlying data provider.
        Parameters:
        dn - The DN of the entry.
        Returns:
        The requested entry, or null if the underlying data provider does not contain the specified entry.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If a problem occurs while trying to retrieve the entry, or if dn is not a DN equal to or subordinate to one of the base DNs managed by the underlying data provider.

      • getStatus

        DataProviderStatus getStatus​(org.forgerock.opendj.ldap.DN baseDN)
                      throws org.forgerock.opendj.ldap.LdapException
        Returns the current status of the provided base DN in the underlying data provider.
        Parameters:
        baseDN - The base DN in the underlying data provider.
        Returns:
        The current status of the provided base DN in the underlying data provider.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If baseDN is not one of the base DNs managed by the underlying data provider.

      • getSupportedControls

        Set<String> getSupportedControls​(org.forgerock.opendj.ldap.DN baseDN)
                          throws org.forgerock.opendj.ldap.LdapException
        Returns an unmodifiable set containing the OIDs of the controls that may be supported by the provided base DN in the underlying data provider.
        Parameters:
        baseDN - The base DN in the underlying data provider.
        Returns:
        An unmodifiable set containing the OIDs of the controls that may be supported by the provided base DN in the underlying data provider.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If baseDN is not one of the base DNs managed by the underlying data provider.

      • getSupportedFeatures

        Set<String> getSupportedFeatures​(org.forgerock.opendj.ldap.DN baseDN)
                          throws org.forgerock.opendj.ldap.LdapException
        Returns an unmodifiable set containing the OIDs of the features that may be supported by the provided base DN in the underlying data provider.
        Parameters:
        baseDN - The base DN in the underlying data provider.
        Returns:
        An unmodifiable set containing the OIDs of the features that may be supported by the provided base DN in the underlying data provider.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If baseDN is not one of the base DNs managed by the underlying data provider.

      • registerEventListener

        void registerEventListener​(DataProviderEventListener listener)
        Registers an event listener with the underlying data provider.
        Parameters:
        listener - The event listener.

      • supportsChangeNotification

        boolean supportsChangeNotification​(org.forgerock.opendj.ldap.DN baseDN)
                            throws org.forgerock.opendj.ldap.LdapException
        Indicates whether the provided base DN in the underlying data provider supports change notification.
        Parameters:
        baseDN - The base DN in the underlying data provider.
        Returns:
        true if the provided base DN in the underlying data provider supports change notification.
        Throws:
        org.forgerock.opendj.ldap.LdapException - If baseDN is not one of the base DNs managed by the underlying data provider.