@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface BackendContext
Modifier and Type | Method and Description |
---|---|
boolean |
entryExists(java.lang.String dn)
Indicates whether the specified entry exists in the backend.
|
java.lang.String |
getBackendID()
Retrieves the backend ID for this backend.
|
java.lang.String[] |
getBaseDNs()
Retrieves the set of base DNs handled by the backend.
|
Entry |
getEntry(java.lang.String dn)
Retrieves the specified entry from the backend.
|
long |
getEntryCount()
Retrieves the total number of entries contained in this backend,
if that information is available.
|
BackendContext |
getParentBackend()
Retrieves information about the parent for the associated backend, if any.
|
BackendContext[] |
getSubordinateBackends()
Retrieves information about any backends which are immediately subordinate
to the associated backend.
|
WritabilityMode |
getWritabilityMode()
Retrieves the
WritabilityMode for the backend. |
boolean |
handlesEntry(java.lang.String dn)
Indicates whether this backend should contain the entry with the specified
DN.
|
boolean |
isExplicitlyIndexed(java.lang.String attributeType,
IndexType indexType)
Indicates whether the backend has been explicitly configured with an
index for the specified attribute type and index type.
|
boolean |
isIndexed(Filter filter)
Indicates whether the backend may consider a search with the provided
filter as indexed.
|
boolean |
isIndexed(java.lang.String attributeType,
IndexType indexType)
Indicates whether the backend considers filter components involving the
specified attribute type and index type indexed.
|
boolean |
isLocal()
Indicates whether the backend is considered local (i.e., holds data in a
repository that is local to and entirely managed by the server).
|
boolean |
isPrivateBackend()
Indicates whether the backend is considered a private backend (with data
generated and/or maintained by the server) rather than a public backend
(with user data provided and managed by clients).
|
java.lang.String getBackendID()
java.lang.String[] getBaseDNs()
long getEntryCount()
boolean isLocal()
true
if the backend should be considered local, or
false
if the data may be held in some external repository.boolean isPrivateBackend()
true
if the backend is considered a private backend within
the server, or false
if it is a public backend.WritabilityMode getWritabilityMode()
WritabilityMode
for the backend.WritabilityMode
for the backend.boolean isIndexed(java.lang.String attributeType, IndexType indexType)
attributeType
- The name or OID of the attribute type for which to
make the determination. It must not be
null
.indexType
- The IndexType
for which to make the
determination. It must not be null
.true
if the specified attribute type is indexed for the
given type of matching, or false
if not.boolean isExplicitlyIndexed(java.lang.String attributeType, IndexType indexType)
attributeType
- The name or OID of the attribute type for which to
make the determination. It must not be
null
.indexType
- The IndexType
for which to make the
determination. It must not be null
.true
if the specified attribute type is indexed for the
given type of matching, or false
if not.boolean isIndexed(Filter filter)
filter
- The Filter
for which to make the determination.
It must not be null
.true
if a search with the provided filter may be
considered indexed in the backend, or false
if not.boolean entryExists(java.lang.String dn) throws LDAPException
dn
- The DN for which to make the determination. It must not be
null
.true
if the specified entry exists in the backend, or
false
if not.LDAPException
- If the provided string cannot be parsed as a valid
DN or if a problem is encountered while making the
determination.Entry getEntry(java.lang.String dn) throws LDAPException
dn
- The DN for which to make the determination. It must not be
null
.null
if the entry does
not exist in the backend.LDAPException
- If the provided string cannot be parsed as a valid
DN or if a problem is encountered while attempting
to retrieve it.boolean handlesEntry(java.lang.String dn) throws LDAPException
dn
- The DN of the entry for which to make the determination.true
if this backend handles operations for the
provided entry, or false
if it does not.LDAPException
- If the provided string cannot be parsed as a valid
DN or if a problem is encountered while making the
determination.BackendContext getParentBackend()
null
if the backend does not have a parent.BackendContext[] getSubordinateBackends()