public interface DataProviderConnection extends RequestHandler<Operation>
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this data provider connection.
|
boolean |
containsEntry(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<DN> |
getBaseDNs()
Returns an unmodifiable set containing the base DNs of the sub-trees
which the underlying data provider contains.
|
Entry |
getEntry(DN dn)
Retrieves the specified entry from the underlying data provider.
|
DataProviderStatus |
getStatus(DN baseDN)
Returns the current status of the provided base DN in the underlying data
provider.
|
Set<String> |
getSupportedControls(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(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(DN baseDN)
Indicates whether the provided base DN in the underlying data
provider supports change notification.
|
handleAdd, handleBind, handleCompare, handleDelete, handleExtendedRequest, handleModify, handleModifyDN, handleSearch
void close()
boolean containsEntry(DN dn) throws LdapException
dn
- The DN of the entry.true
if the underlying data provider contains the
specified entry, or false
if it does not.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.void deregisterEventListener(DataProviderEventListener listener)
listener
- The event listener.Set<DN> getBaseDNs()
Entry getEntry(DN dn) throws LdapException
dn
- The DN of the entry.null
if the underlying data
provider does not contain the specified entry.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.DataProviderStatus getStatus(DN baseDN) throws LdapException
baseDN
- The base DN in the underlying data provider.LdapException
- If baseDN
is not one of the base DNs managed by the
underlying data provider.Set<String> getSupportedControls(DN baseDN) throws LdapException
baseDN
- The base DN in the underlying data provider.LdapException
- If baseDN
is not one of the base DNs managed by the
underlying data provider.Set<String> getSupportedFeatures(DN baseDN) throws LdapException
baseDN
- The base DN in the underlying data provider.LdapException
- If baseDN
is not one of the base DNs managed by the
underlying data provider.void registerEventListener(DataProviderEventListener listener)
listener
- The event listener.boolean supportsChangeNotification(DN baseDN) throws LdapException
baseDN
- The base DN in the underlying data provider.true
if the provided base DN in the underlying data
provider supports change notification.LdapException
- If baseDN
is not one of the base DNs managed by the
underlying data provider.Copyright 2010-2017 ForgeRock AS.