|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A database for storing attributes.
Field Summary | |
static java.lang.String |
ALIAS_ATTRIBUTE
The aliased Dn attribute name: aliasedObjectName for LDAP and aliasedEntryName or X.500. |
static java.lang.String |
ALIAS_OBJECT
The objectClass name for aliases: 'alias' |
Method Summary | |
void |
add(java.lang.String updn,
javax.naming.Name dn,
javax.naming.directory.Attributes entry)
TODO Document me! |
void |
addIndexOn(org.apache.ldap.common.schema.AttributeType attribute)
TODO Document me! |
void |
close()
TODO Document me! |
int |
count()
Gets the count of the total number of entries in the database. |
void |
delete(java.math.BigInteger id)
TODO Document me! |
Index |
getAliasIndex()
Gets the system index defined on the ALIAS_ATTRIBUTE which for LDAP would be the aliasedObjectName and for X.500 would be aliasedEntryName. |
int |
getChildCount(java.math.BigInteger id)
TODO Document me! |
java.lang.String |
getEntryDn(java.math.BigInteger id)
TODO Document me! |
java.math.BigInteger |
getEntryId(java.lang.String dn)
TODO Document me! |
java.lang.String |
getEntryUpdn(java.math.BigInteger id)
Gets the user provided distinguished name. |
java.lang.String |
getEntryUpdn(java.lang.String dn)
Gets the user provided distinguished name. |
Index |
getExistanceIndex()
Gets the Index mapping the names of attributes as Strings to the BigInteger primary keys of entries containing one or more values of those attributes. |
Index |
getHierarchyIndex()
Gets the Index mapping the BigInteger primary keys of parents to the BigInteger primary keys of their children. |
javax.naming.directory.Attributes |
getIndices(java.math.BigInteger id)
TODO Document me! |
Index |
getNdnIndex()
Gets the Index mapping the normalized distinguished names of entries as Strings to the BigInteger primary keys of entries. |
Index |
getOneAliasIndex()
Gets the alias index mapping parent entries with scope expanding aliases children one level below them; this system index is used to dereference aliases on one/single level scoped searches. |
java.math.BigInteger |
getParentId(java.math.BigInteger childId)
TODO Document me! |
java.math.BigInteger |
getParentId(java.lang.String dn)
TODO Document me! |
java.lang.String |
getProperty(java.lang.String key)
TODO Document me! |
Index |
getSubAliasIndex()
Gets the alias index mapping relative entries with scope expanding alias descendents; this system index is used to dereference aliases on subtree scoped searches. |
javax.naming.Name |
getSuffix()
|
javax.naming.directory.Attributes |
getSuffixEntry()
TODO Document me! |
Index |
getSystemIndex(java.lang.String attribute)
TODO Document me! |
java.util.Iterator |
getSystemIndices()
TODO Document me! |
Index |
getUpdnIndex()
Gets the Index mapping user provided distinguished names of entries as Strings to the BigInteger primary keys of entries. |
Index |
getUserIndex(java.lang.String attribute)
TODO Document me! |
java.util.Iterator |
getUserIndices()
TODO Document me! |
boolean |
hasSystemIndexOn(java.lang.String attribute)
TODO Document me! |
boolean |
hasUserIndexOn(java.lang.String attribute)
TODO Document me! |
boolean |
isClosed()
Checks to see if this BackingStore has been closed or shut down. |
javax.naming.NamingEnumeration |
list(java.math.BigInteger id)
TODO Document me! |
javax.naming.directory.Attributes |
lookup(java.math.BigInteger id)
TODO Document me! |
void |
modify(javax.naming.Name dn,
int modOp,
javax.naming.directory.Attributes mods)
TODO Document me! |
void |
modify(javax.naming.Name dn,
javax.naming.directory.ModificationItem[] mods)
TODO Document me! |
void |
modifyRdn(javax.naming.Name dn,
java.lang.String newRdn,
boolean deleteOldRdn)
TODO Document me! |
void |
move(javax.naming.Name oldChildDn,
javax.naming.Name newParentDn)
TODO Document me! |
void |
move(javax.naming.Name oldChildDn,
javax.naming.Name newParentDn,
java.lang.String newRdn,
boolean deleteOldRdn)
Moves a child from one location to another while changing the Rdn attribute used in the new location and optionally deleting the old Rdn attribute value pair. |
void |
setAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the system index defined on the ALIAS_ATTRIBUTE which for LDAP would be the aliasedObjectName and for X.500 would be aliasedEntryName. |
void |
setExistanceIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the attribute existance Index. |
void |
setHierarchyIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the hierarchy Index. |
void |
setNdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the normalized distinguished name Index. |
void |
setOneAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the alias index mapping parent entries with scope expanding aliases children one level below them; this system index is used to dereference aliases on one/single level scoped searches. |
void |
setProperty(java.lang.String key,
java.lang.String value)
TODO Document me! |
void |
setSubAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the alias index mapping relative entries with scope expanding alias descendents; this system index is used to dereference aliases on subtree scoped searches. |
void |
setUpdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType)
Sets the user provided distinguished name Index. |
void |
sync()
TODO Document me! |
Field Detail |
public static final java.lang.String ALIAS_OBJECT
public static final java.lang.String ALIAS_ATTRIBUTE
Method Detail |
public void addIndexOn(org.apache.ldap.common.schema.AttributeType attribute) throws javax.naming.NamingException
attribute
- TODO
javax.naming.NamingException
- TODOpublic boolean hasUserIndexOn(java.lang.String attribute)
attribute
- TODO
public boolean hasSystemIndexOn(java.lang.String attribute)
attribute
- TODO
public Index getExistanceIndex()
public Index getHierarchyIndex()
public Index getUpdnIndex()
public Index getNdnIndex()
public Index getOneAliasIndex()
public Index getSubAliasIndex()
public Index getAliasIndex()
public void setAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- the index on the ALIAS_ATTRIBUTE
javax.naming.NamingException
public void setExistanceIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- the attribute existance Index
javax.naming.NamingException
public void setHierarchyIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- the hierarchy Index
javax.naming.NamingException
public void setUpdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- the updn Index
javax.naming.NamingException
public void setNdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- the ndn Index
javax.naming.NamingException
public void setOneAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- a one level alias index
javax.naming.NamingException
public void setSubAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
attrType
- a subtree alias index
javax.naming.NamingException
public Index getUserIndex(java.lang.String attribute) throws IndexNotFoundException
attribute
- TODO
IndexNotFoundException
- TODOpublic Index getSystemIndex(java.lang.String attribute) throws IndexNotFoundException
attribute
- TODO
IndexNotFoundException
- TODOpublic java.math.BigInteger getEntryId(java.lang.String dn) throws javax.naming.NamingException
dn
- TODO
javax.naming.NamingException
- TODOpublic java.lang.String getEntryDn(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic java.math.BigInteger getParentId(java.lang.String dn) throws javax.naming.NamingException
dn
- TODO
javax.naming.NamingException
- TODOpublic java.math.BigInteger getParentId(java.math.BigInteger childId) throws javax.naming.NamingException
childId
- TODO
javax.naming.NamingException
- TODOpublic java.lang.String getEntryUpdn(java.math.BigInteger id) throws javax.naming.NamingException
id
- the entry id
javax.naming.NamingException
- if the updn index cannot be accessedpublic java.lang.String getEntryUpdn(java.lang.String dn) throws javax.naming.NamingException
dn
- the normalized distinguished name
javax.naming.NamingException
- if the updn and ndn indices cannot be accessedpublic void add(java.lang.String updn, javax.naming.Name dn, javax.naming.directory.Attributes entry) throws javax.naming.NamingException
updn
- the user provided distinguished name of the entrydn
- TODOentry
- TODO
javax.naming.NamingException
- TODOpublic javax.naming.directory.Attributes lookup(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic void delete(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic javax.naming.NamingEnumeration list(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic int getChildCount(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic javax.naming.Name getSuffix()
public javax.naming.directory.Attributes getSuffixEntry() throws javax.naming.NamingException
javax.naming.NamingException
- TODOpublic void sync() throws javax.naming.NamingException
javax.naming.NamingException
- TODOpublic void close() throws javax.naming.NamingException
javax.naming.NamingException
- TODOpublic boolean isClosed()
public void setProperty(java.lang.String key, java.lang.String value) throws javax.naming.NamingException
key
- TODOvalue
- TODO
javax.naming.NamingException
- TODOpublic java.lang.String getProperty(java.lang.String key) throws javax.naming.NamingException
key
- TODO
javax.naming.NamingException
- TODOpublic java.util.Iterator getUserIndices()
public java.util.Iterator getSystemIndices()
public javax.naming.directory.Attributes getIndices(java.math.BigInteger id) throws javax.naming.NamingException
id
- TODO
javax.naming.NamingException
- TODOpublic void modify(javax.naming.Name dn, int modOp, javax.naming.directory.Attributes mods) throws javax.naming.NamingException
dn
- TODOmodOp
- TODOmods
- TODO
javax.naming.NamingException
- TODOpublic void modify(javax.naming.Name dn, javax.naming.directory.ModificationItem[] mods) throws javax.naming.NamingException
dn
- TODOmods
- TODO
javax.naming.NamingException
- TODOpublic void modifyRdn(javax.naming.Name dn, java.lang.String newRdn, boolean deleteOldRdn) throws javax.naming.NamingException
dn
- TODOnewRdn
- TODOdeleteOldRdn
- TODO
javax.naming.NamingException
- TODOpublic void move(javax.naming.Name oldChildDn, javax.naming.Name newParentDn) throws javax.naming.NamingException
oldChildDn
- TODOnewParentDn
- TODO
javax.naming.NamingException
- TODOpublic void move(javax.naming.Name oldChildDn, javax.naming.Name newParentDn, java.lang.String newRdn, boolean deleteOldRdn) throws javax.naming.NamingException
oldChildDn
- the normalized child dn to movenewParentDn
- the normalized new parent dn to move the child tonewRdn
- the new rdn of the child at its new locationdeleteOldRdn
- switch to remove the old rdn attribute/value pair
javax.naming.NamingException
- if a database failure resultspublic int count() throws javax.naming.NamingException
javax.naming.NamingException
- if there is a failure to read the count
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |