|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Partition
An interfaces that bridges between underlying JNDI entries and JNDI
Context
API. DIT (Directory Information Tree) consists one or
above Partition
s whose parent is PartitionNexus
,
and all of them are mapped to different
base suffix. Each partition contains entries whose name ends with that
base suffix.
Field Summary | |
---|---|
static int |
DEFAULT_CACHE_SIZE
the default entry cache size to use for a partition |
static java.lang.String |
DEFAULT_PARTITION_IMPLEMENTATION
default partition implementation class |
static java.lang.String |
SYSTEM_PARTITION_NAME
The name of reserved system partition |
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()
Deinitialized this partition. |
int |
getCacheSize()
Gets the entry cache size for this partition. |
java.lang.String |
getId()
Gets the unique identifier for this partition. |
java.lang.String |
getSuffix()
Gets the non-normalized suffix for this Partition as a string. |
org.apache.directory.shared.ldap.name.LdapDN |
getSuffixDn()
Gets the distinguished/absolute name of the suffix for all entries stored within this ContextPartition. |
org.apache.directory.shared.ldap.name.LdapDN |
getUpSuffixDn()
Gets the distinguished/absolute name of the suffix for all entries stored within this ContextPartition. |
boolean |
hasEntry(EntryOperationContext opContext)
Fast operation to check and see if a particular entry exists. |
void |
init(DirectoryService core)
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(java.lang.Long id)
|
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 |
setCacheSize(int cacheSize)
Used to specify the entry cache size for a Partition. |
void |
setId(java.lang.String id)
Sets the unique identifier for this partition. |
void |
setSuffix(java.lang.String suffix)
Sets the non-normalized 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. |
Field Detail |
---|
static final java.lang.String SYSTEM_PARTITION_NAME
static final java.lang.String DEFAULT_PARTITION_IMPLEMENTATION
static final int DEFAULT_CACHE_SIZE
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)
suffix
- the suffix string for this Partition.void setCacheSize(int cacheSize)
cacheSize
- the size of the cacheint getCacheSize()
void init(DirectoryService core) throws java.lang.Exception
core
- the directory core for the server.
java.lang.Exception
- if initialization fails in any wayvoid 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 diskorg.apache.directory.shared.ldap.name.LdapDN getSuffixDn() throws java.lang.Exception
java.lang.Exception
- if access or suffix parsing failsorg.apache.directory.shared.ldap.name.LdapDN getUpSuffixDn() throws java.lang.Exception
java.lang.Exception
- if access or suffix parsing failsvoid 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 contetx containin 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 problemsClonedServerEntry lookup(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
boolean 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 |