|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface to a store for JNDI Attributes within a hierarchical namespace. Currently we only have a BackingStore designed for managing LDAP/X.500 namespaces although foreseeably other hierarchical namespaces (directories) can have BackingStore's implemented for them. A BackingStore contains the set of operations that can be performed on a JNDI Attributes.
Method Summary | |
void |
add(java.lang.String upName,
javax.naming.Name normName,
javax.naming.directory.Attributes entry)
Adds an entry to this BackingStore. |
void |
close()
Closes or shuts down this BackingStore. |
void |
delete(javax.naming.Name name)
Deletes a leaf entry from this BackingStore: non-leaf entries cannot be deleted until this operation has been applied to their children. |
boolean |
hasEntry(javax.naming.Name name)
Fast operation to check and see if a particular entry exists. |
boolean |
isClosed()
Checks to see if this BackingStore has been closed or shut down. |
boolean |
isSuffix(javax.naming.Name name)
Checks to see if name is a context suffix. |
javax.naming.NamingEnumeration |
list(javax.naming.Name base)
A specialized form of one level search used to return a minimal set of information regarding child entries under a base. |
javax.naming.directory.Attributes |
lookup(javax.naming.Name name)
Looks up an entry by distinguished/absolute name. |
javax.naming.directory.Attributes |
lookup(javax.naming.Name dn,
java.lang.String[] attrIds)
Looks up an entry by distinguished name. |
void |
modify(javax.naming.Name name,
int modOp,
javax.naming.directory.Attributes mods)
Modifies an entry by adding, removing or replacing a set of attributes. |
void |
modify(javax.naming.Name name,
javax.naming.directory.ModificationItem[] mods)
Modifies an entry by using a combination of adds, removes or replace operations using a set of ModificationItems. |
void |
modifyRn(javax.naming.Name name,
java.lang.String newRn,
boolean deleteOldRn)
Modifies an entry by changing its relative name. |
void |
move(javax.naming.Name oriChildName,
javax.naming.Name newParentName)
Transplants a child entry, to a position in the namespace under a new parent entry. |
void |
move(javax.naming.Name oriChildName,
javax.naming.Name newParentName,
java.lang.String newRn,
boolean deleteOldRn)
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. |
javax.naming.NamingEnumeration |
search(javax.naming.Name base,
java.util.Map env,
org.apache.ldap.common.filter.ExprNode filter,
javax.naming.directory.SearchControls searchCtls)
Conducts a search against this BackingStore. |
void |
sync()
Cue to BackingStores with caches to flush entry and index changes to disk. |
Method Detail |
public void delete(javax.naming.Name name) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the entry to
delete from this BackingStore.
javax.naming.NamingException
- if there are any problemspublic void add(java.lang.String upName, javax.naming.Name normName, javax.naming.directory.Attributes entry) throws javax.naming.NamingException
upName
- the user provided distinguished/absolute name of the entrynormName
- the normalized distinguished/absolute name of the entryentry
- the entry to add to this BackingStore
javax.naming.NamingException
- if there are any problemspublic void modify(javax.naming.Name name, int modOp, javax.naming.directory.Attributes mods) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the entry to
modifymodOp
- the modification operation to perform on the entry which
is one of constants specified by the DirContext interface:
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
.mods
- the attributes and their values used to affect the
modification with.
javax.naming.NamingException
- if there are any problemsDirContext
,
DirContext.ADD_ATTRIBUTE
,
DirContext.REMOVE_ATTRIBUTE
,
DirContext.REPLACE_ATTRIBUTE
public void modify(javax.naming.Name name, javax.naming.directory.ModificationItem[] mods) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the entry to modifymods
- the ModificationItems used to affect the modification with
javax.naming.NamingException
- if there are any problemsModificationItem
public javax.naming.NamingEnumeration list(javax.naming.Name base) throws javax.naming.NamingException
base
- the base distinguished/absolute name for the search/listing
DbSearchResult
javax.naming.NamingException
- if there are any problemspublic javax.naming.NamingEnumeration search(javax.naming.Name base, java.util.Map env, org.apache.ldap.common.filter.ExprNode filter, javax.naming.directory.SearchControls searchCtls) throws javax.naming.NamingException
base
- the normalized distinguished/absolute name of the search baseenv
- the environment under which operation occursfilter
- the root node of the filter expression treesearchCtls
- the search controls
javax.naming.NamingException
- if there are any problemspublic javax.naming.directory.Attributes lookup(javax.naming.Name name) throws javax.naming.NamingException
name
- the normalized distinguished name of the object to lookup
javax.naming.NamingException
- if there are any problemspublic javax.naming.directory.Attributes lookup(javax.naming.Name dn, java.lang.String[] attrIds) throws javax.naming.NamingException
dn
- the normalized distinguished name of the object to lookupattrIds
- the set of attributes to return
javax.naming.NamingException
- if there are any problemspublic boolean hasEntry(javax.naming.Name name) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the object to
check for existance
javax.naming.NamingException
- if there are any problemspublic boolean isSuffix(javax.naming.Name name) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the context
javax.naming.NamingException
- if there are any problemspublic void modifyRn(javax.naming.Name name, java.lang.String newRn, boolean deleteOldRn) throws javax.naming.NamingException
name
- the normalized distinguished/absolute name of the entry to
modify the RN of.newRn
- the new RN of the entry specified by namedeleteOldRn
- boolean flag which removes the old RN attribute
from the entry if set to true, and has no affect if set to false
javax.naming.NamingException
- if there are any problemspublic void move(javax.naming.Name oriChildName, javax.naming.Name newParentName) throws javax.naming.NamingException
newParentName
- the normalized distinguished/absolute name of the
new parent to move the target entry tooriChildName
- the normalized distinguished/absolute name of the
original child name representing the child entry to move
javax.naming.NamingException
- if there are any problemspublic void move(javax.naming.Name oriChildName, javax.naming.Name newParentName, java.lang.String newRn, boolean deleteOldRn) throws javax.naming.NamingException
oriChildName
- the normalized distinguished/absolute name of the
original child name representing the child entry to movenewParentName
- the normalized distinguished/absolute name of the
new parent to move the targeted entry tonewRn
- the new RN of the entrydeleteOldRn
- boolean flag which removes the old RN attribute
from the entry if set to true, and has no affect if set to false
javax.naming.NamingException
- if there are any problemspublic void sync() throws javax.naming.NamingException
javax.naming.NamingException
- if there are problems flushing cachespublic void close() throws javax.naming.NamingException
javax.naming.NamingException
- if there are problems shutting downpublic boolean isClosed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |