public final class SchemaPartition extends AbstractPartition
initialized
Constructor and Description |
---|
SchemaPartition() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected void |
doDestroy()
Override this method to put your initialization code.
|
protected void |
doInit()
Override this method to put your initialization code.
|
String |
getId()
Get's the ID which is fixed: 'schema'.
|
org.apache.directory.shared.ldap.schema.SchemaManager |
getSchemaManager()
Gets the schema manager assigned to this Partition.
|
String |
getSuffix()
Always returns
ServerDNConstants#OU_SCHEMA_DN : 'ou=schema'. |
org.apache.directory.shared.ldap.name.DN |
getSuffixDn()
Always returns
ServerDNConstants#OU_SCHEMA_DN_NORMALIZED : '2.5.4.11=schema'. |
Partition |
getWrappedPartition()
Gets the
Partition being wrapped. |
boolean |
hasEntry(EntryOperationContext entryContext)
This method calls
Partition.lookup(LookupOperationContext) and return true
if it returns an entry by default. |
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)
This method calls
Partition.lookup(LookupOperationContext)
with null attributeIds by default. |
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(String id)
Has no affect: the id is fixed at
ID : 'schema'. |
void |
setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
Sets the schema manager assigned to this Partition.
|
void |
setSuffix(String suffix)
Has no affect: just logs a warning.
|
void |
setWrappedPartition(Partition wrapped)
Sets the wrapped
Partition which must be supplied or
Partition.initialize() will fail with a NullPointerException. |
void |
sync()
This method does nothing by default.
|
String |
toString() |
void |
unbind(UnbindOperationContext opContext)
Represents an unbind operation issued by an authenticated client.
|
destroy, initialize, isInitialized
public void setWrappedPartition(Partition wrapped)
Partition
which must be supplied or
Partition.initialize()
will fail with a NullPointerException.wrapped
- the Partition being wrappedpublic Partition getWrappedPartition()
Partition
being wrapped.public final String getId()
public final void setId(String id)
ID
: 'schema'.
A warning is logged.id
- the unique identifier for this partitionpublic final org.apache.directory.shared.ldap.name.DN getSuffixDn()
ServerDNConstants#OU_SCHEMA_DN_NORMALIZED
: '2.5.4.11=schema'.public final String getSuffix()
ServerDNConstants#OU_SCHEMA_DN
: 'ou=schema'.public final void setSuffix(String suffix)
suffix
- the suffix String for this Partition.public void sync() throws Exception
AbstractPartition
sync
in interface Partition
sync
in class AbstractPartition
Exception
- if buffers cannot be flushed to diskprotected void doInit() throws Exception
AbstractPartition
doInit
in class AbstractPartition
Exception
protected void doDestroy()
AbstractPartition
doDestroy
in class AbstractPartition
public void add(AddOperationContext opContext) throws Exception
opContext
- the context used to add and entry to this ContextPartitionException
- if there are any problemspublic void bind(BindOperationContext opContext) throws Exception
Partition
opContext
- the bind context, containing all the needed informations to bindException
- if something goes wrongpublic void delete(DeleteOperationContext opContext) throws Exception
Partition
opContext
- the context of the entry to
delete from this ContextPartition.Exception
- if there are any problemspublic EntryFilteringCursor list(ListOperationContext opContext) throws Exception
Partition
opContext
- the context containing the distinguished/absolute name for the search/listingServerSearchResult
Exception
- if there are any problemspublic boolean hasEntry(EntryOperationContext entryContext) throws Exception
Partition.lookup(LookupOperationContext)
and return true
if it returns an entry by default. Please override this method if
there is more effective way for your implementation.hasEntry
in interface Partition
hasEntry
in class AbstractPartition
entryContext
- The context used to pass informationsException
- if there are any problemspublic void modify(ModifyOperationContext opContext) throws 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
.Exception
- if there are any problemsDirContext
,
DirContext.ADD_ATTRIBUTE
,
DirContext.REMOVE_ATTRIBUTE
,
DirContext.REPLACE_ATTRIBUTE
public void move(MoveOperationContext opContext) throws Exception
Partition
opContext
- The context containing the DNs to moveException
- if there are any problemspublic void moveAndRename(MoveAndRenameOperationContext opContext) throws Exception
Partition
opContext
- The context contain all the information about
the modifyDN operationException
- if there are any problemspublic void rename(RenameOperationContext opContext) throws Exception
opContext
- the modify DN contextException
- if there are any problemspublic EntryFilteringCursor search(SearchOperationContext opContext) throws Exception
Partition
opContext
- The context containing the information used by the operationException
- if there are any problemspublic void unbind(UnbindOperationContext opContext) throws Exception
Partition
opContext
- the context used to unbindException
- if something goes wrongpublic ClonedServerEntry lookup(LookupOperationContext lookupContext) throws Exception
AbstractPartition
Partition.lookup(LookupOperationContext)
with null attributeIds by default. Please override
this method if there is more effective way for your implementation.lookup
in interface Partition
lookup
in class AbstractPartition
lookupContext
- The context containing the parametersException
- if there are any problemspublic void setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
Partition
schemaManager
- the SchemaManager to setpublic org.apache.directory.shared.ldap.schema.SchemaManager getSchemaManager()
Partition
public String toString()
toString
in class Object
Object.toString()
Copyright © 2003–2015 The Apache Software Foundation. All rights reserved.