|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Partition
Interface for entry stores containing a part of the DIB (Directory Information Base). Partitions are associated with a specific suffix, and all entries contained in the them have the same DN suffix in common.
Method Summary | |
---|---|
void |
add(AddOperationContext opContext)
Adds an entry to this ContextPartition. |
void |
bind(BindOperationContext opContext)
Represents a bind operation issued to authenticate a client. |
void |
delete(DeleteOperationContext opContext)
Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children. |
void |
destroy()
Instructs this Partition to synchronize with it's persistent store, and destroy all held resources, in preparation for a shutdown event. |
java.lang.String |
getId()
Gets the unique identifier for this partition. |
org.apache.directory.shared.ldap.schema.SchemaManager |
getSchemaManager()
Gets the schema manager assigned to this Partition. |
java.lang.String |
getSuffix()
Gets the user provided suffix for this Partition as a String. |
org.apache.directory.shared.ldap.name.DN |
getSuffixDn()
Gets the normalized suffix as an DN for this Partition after it has been initialized. |
boolean |
hasEntry(EntryOperationContext opContext)
Fast operation to check and see if a particular entry exists. |
void |
initialize()
Initializes this partition. |
boolean |
isInitialized()
Checks to see if this partition is initialized or not. |
EntryFilteringCursor |
list(ListOperationContext opContext)
A specialized form of one level search used to return a minimal set of information regarding child entries under a base. |
ClonedServerEntry |
lookup(LookupOperationContext lookupContext)
Looks up an entry by distinguished/absolute name. |
void |
modify(ModifyOperationContext opContext)
Modifies an entry by adding, removing or replacing a set of attributes. |
void |
move(MoveOperationContext opContext)
Transplants a child entry, to a position in the namespace under a new parent entry. |
void |
moveAndRename(MoveAndRenameOperationContext opContext)
Transplants a child entry, to a position in the namespace under a new parent entry and changes the RN of the child entry which can optionally have its old RN attributes removed. |
void |
rename(RenameOperationContext opContext)
Modifies an entry by changing its relative name. |
EntryFilteringCursor |
search(SearchOperationContext opContext)
Conducts a search against this ContextPartition. |
void |
setId(java.lang.String id)
Sets the unique identifier for this partition. |
void |
setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
Sets the schema manager assigned to this Partition. |
void |
setSuffix(java.lang.String suffix)
Sets the user provided suffix for this Partition as a String. |
void |
sync()
Flushes any changes made to this partition now. |
void |
unbind(UnbindOperationContext opContext)
Represents an unbind operation issued by an authenticated client. |
Method Detail |
---|
java.lang.String getId()
void setId(java.lang.String id)
id
- the unique identifier for this partitionjava.lang.String getSuffix()
void setSuffix(java.lang.String suffix) throws org.apache.directory.shared.ldap.exception.LdapInvalidDnException
suffix
- the suffix String for this Partition.
org.apache.directory.shared.ldap.exception.LdapInvalidDnException
- if the suffix does not conform to LDAP DN syntaxorg.apache.directory.shared.ldap.schema.SchemaManager getSchemaManager()
void setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
registries
- the manager to assign to this Partition.void initialize() throws java.lang.Exception
java.lang.Exception
- if initialization fails in any wayorg.apache.directory.shared.ldap.name.DN getSuffixDn()
java.lang.IllegalStateException
- if the Partition has not been initializedvoid destroy() throws java.lang.Exception
java.lang.Exception
boolean isInitialized()
void sync() throws java.lang.Exception
java.lang.Exception
- if buffers cannot be flushed to diskvoid delete(DeleteOperationContext opContext) throws java.lang.Exception
opContext
- the context of the entry to
delete from this ContextPartition.
java.lang.Exception
- if there are any problemsvoid add(AddOperationContext opContext) throws java.lang.Exception
opContext
- the context used to add and entry to this ContextPartition
java.lang.Exception
- if there are any problemsvoid modify(ModifyOperationContext opContext) throws java.lang.Exception
opContext
- The context containing the modification operation
to perform on the entry which is one of constants specified by the
DirContext interface:
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
.
java.lang.Exception
- if there are any problemsDirContext
,
DirContext.ADD_ATTRIBUTE
,
DirContext.REMOVE_ATTRIBUTE
,
DirContext.REPLACE_ATTRIBUTE
EntryFilteringCursor list(ListOperationContext opContext) throws java.lang.Exception
opContext
- the context containing the distinguished/absolute name for the search/listing
ServerSearchResult
java.lang.Exception
- if there are any problemsEntryFilteringCursor search(SearchOperationContext opContext) throws java.lang.Exception
opContext
- The context containing the information used by the operation
java.lang.Exception
- if there are any problemsClonedServerEntry lookup(LookupOperationContext lookupContext) throws java.lang.Exception
lookupContext
- The context containing the parameters
java.lang.Exception
- if there are any problemsboolean hasEntry(EntryOperationContext opContext) throws java.lang.Exception
opContext
- The context used to pass informations
java.lang.Exception
- if there are any problemsvoid rename(RenameOperationContext opContext) throws java.lang.Exception
opContext
- the modify DN context
java.lang.Exception
- if there are any problemsvoid move(MoveOperationContext opContext) throws java.lang.Exception
opContext
- The context containing the DNs to move
java.lang.Exception
- if there are any problemsvoid moveAndRename(MoveAndRenameOperationContext opContext) throws java.lang.Exception
opContext
- The context contain all the information about
the modifyDN operation
java.lang.Exception
- if there are any problemsvoid bind(BindOperationContext opContext) throws java.lang.Exception
opContext
- the bind context, containing all the needed informations to bind
java.lang.Exception
- if something goes wrongvoid unbind(UnbindOperationContext opContext) throws java.lang.Exception
opContext
- the context used to unbind
java.lang.Exception
- if something goes wrong
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |