|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ldap.server.db.jdbm.JdbmDatabase
A Database implementation based on JDBM B+Tree implementation.
Field Summary |
Fields inherited from interface org.apache.ldap.server.db.Database |
ALIAS_ATTRIBUTE, ALIAS_OBJECT |
Constructor Summary | |
JdbmDatabase(javax.naming.Name upSuffix,
javax.naming.Name normSuffix,
java.lang.String wkdirPath)
Creates a Databased based on JDBM B+Trees. |
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 spec)
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 propertyName)
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 indexName)
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)
Changes the relative distinuished name of an entry specified by a distinguished name with the optional removal of the old Rdn attribute value from the entry. |
void |
move(javax.naming.Name oldChildDn,
javax.naming.Name newParentDn)
Moves an entry under a new parent. |
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 propertyName,
java.lang.String propertyValue)
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! |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public JdbmDatabase(javax.naming.Name upSuffix, javax.naming.Name normSuffix, java.lang.String wkdirPath) throws javax.naming.NamingException
upSuffix
- the user provided suffix namenormSuffix
- the normalized suffix namewkdirPath
- the path to the working directory where the db resides
javax.naming.NamingException
- if db cannot be createdMethod Detail |
public void addIndexOn(org.apache.ldap.common.schema.AttributeType spec) throws javax.naming.NamingException
Database
addIndexOn
in interface Database
spec
- TODO
javax.naming.NamingException
- TODODatabase.addIndexOn(AttributeType)
public Index getExistanceIndex()
Database
getExistanceIndex
in interface Database
Database.getExistanceIndex()
public void setExistanceIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setExistanceIndexOn
in interface Database
attrType
- the attribute existance Index
javax.naming.NamingException
Database.setExistanceIndexOn(AttributeType)
public Index getHierarchyIndex()
Database
getHierarchyIndex
in interface Database
Database.getHierarchyIndex()
public void setHierarchyIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setHierarchyIndexOn
in interface Database
attrType
- the hierarchy Index
javax.naming.NamingException
Database.setExistanceIndexOn(AttributeType)
public Index getAliasIndex()
Database
getAliasIndex
in interface Database
Database.getAliasIndex()
public void setAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setAliasIndexOn
in interface Database
attrType
- the index on the ALIAS_ATTRIBUTE
javax.naming.NamingException
Database.setAliasIndexOn(AttributeType)
public Index getOneAliasIndex()
Database
getOneAliasIndex
in interface Database
Database.getOneAliasIndex()
public void setOneAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setOneAliasIndexOn
in interface Database
attrType
- a one level alias index
javax.naming.NamingException
Database.setOneAliasIndexOn(AttributeType)
public Index getSubAliasIndex()
Database
getSubAliasIndex
in interface Database
Database.getSubAliasIndex()
public void setSubAliasIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setSubAliasIndexOn
in interface Database
attrType
- a subtree alias index
javax.naming.NamingException
Database.setSubAliasIndexOn(AttributeType)
public Index getUpdnIndex()
Database
getUpdnIndex
in interface Database
Database.getUpdnIndex()
public void setUpdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setUpdnIndexOn
in interface Database
attrType
- the updn Index
javax.naming.NamingException
Database.setUpdnIndexOn(AttributeType)
public Index getNdnIndex()
Database
getNdnIndex
in interface Database
Database.getNdnIndex()
public void setNdnIndexOn(org.apache.ldap.common.schema.AttributeType attrType) throws javax.naming.NamingException
Database
setNdnIndexOn
in interface Database
attrType
- the ndn Index
javax.naming.NamingException
Database.setNdnIndexOn(AttributeType)
public java.util.Iterator getUserIndices()
Database
getUserIndices
in interface Database
Database.getUserIndices()
public java.util.Iterator getSystemIndices()
Database
getSystemIndices
in interface Database
Database.getSystemIndices()
public boolean hasUserIndexOn(java.lang.String attribute)
Database
hasUserIndexOn
in interface Database
attribute
- TODO
Database.hasUserIndexOn(String)
public boolean hasSystemIndexOn(java.lang.String attribute)
Database
hasSystemIndexOn
in interface Database
attribute
- TODO
Database.hasSystemIndexOn(String)
public Index getUserIndex(java.lang.String attribute) throws IndexNotFoundException
Database
getUserIndex
in interface Database
attribute
- TODO
IndexNotFoundException
- TODODatabase.getUserIndex(String)
public Index getSystemIndex(java.lang.String indexName) throws IndexNotFoundException
Database
getSystemIndex
in interface Database
indexName
- TODO
IndexNotFoundException
- TODODatabase.getEntryId(String)
public java.math.BigInteger getEntryId(java.lang.String dn) throws javax.naming.NamingException
Database
getEntryId
in interface Database
dn
- TODO
javax.naming.NamingException
- TODODatabase.getEntryId(String)
public java.lang.String getEntryDn(java.math.BigInteger id) throws javax.naming.NamingException
Database
getEntryDn
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.getEntryDn(java.math.BigInteger)
public java.math.BigInteger getParentId(java.lang.String dn) throws javax.naming.NamingException
Database
getParentId
in interface Database
dn
- TODO
javax.naming.NamingException
- TODODatabase.getParentId(String)
public java.math.BigInteger getParentId(java.math.BigInteger childId) throws javax.naming.NamingException
Database
getParentId
in interface Database
childId
- TODO
javax.naming.NamingException
- TODODatabase.getParentId(BigInteger)
public java.lang.String getEntryUpdn(java.math.BigInteger id) throws javax.naming.NamingException
Database
getEntryUpdn
in interface Database
id
- the entry id
javax.naming.NamingException
- if the updn index cannot be accessedDatabase.getEntryUpdn(BigInteger)
public java.lang.String getEntryUpdn(java.lang.String dn) throws javax.naming.NamingException
Database
getEntryUpdn
in interface Database
dn
- the normalized distinguished name
javax.naming.NamingException
- if the updn and ndn indices cannot be accessedDatabase.getEntryUpdn(String)
public int count() throws javax.naming.NamingException
Database
count
in interface Database
javax.naming.NamingException
- if there is a failure to read the countDatabase.count()
public void add(java.lang.String updn, javax.naming.Name dn, javax.naming.directory.Attributes entry) throws javax.naming.NamingException
Database
add
in interface Database
updn
- the user provided distinguished name of the entrydn
- TODOentry
- TODO
javax.naming.NamingException
- TODODatabase.add(String,Name,Attributes)
public javax.naming.directory.Attributes lookup(java.math.BigInteger id) throws javax.naming.NamingException
Database
lookup
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.lookup(BigInteger)
public void delete(java.math.BigInteger id) throws javax.naming.NamingException
Database
delete
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.delete(BigInteger)
public javax.naming.NamingEnumeration list(java.math.BigInteger id) throws javax.naming.NamingException
Database
list
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.list(java.math.BigInteger)
public int getChildCount(java.math.BigInteger id) throws javax.naming.NamingException
Database
getChildCount
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.getChildCount(java.math.BigInteger)
public javax.naming.Name getSuffix()
getSuffix
in interface Database
Database.getSuffix()
public javax.naming.directory.Attributes getSuffixEntry() throws javax.naming.NamingException
Database
getSuffixEntry
in interface Database
javax.naming.NamingException
- TODODatabase.getSuffixEntry()
public void sync() throws javax.naming.NamingException
Database
sync
in interface Database
javax.naming.NamingException
- TODODatabase.sync()
public void close() throws javax.naming.NamingException
Database
close
in interface Database
javax.naming.NamingException
- TODODatabase.close()
public boolean isClosed()
Database
isClosed
in interface Database
Database.isClosed()
public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws javax.naming.NamingException
Database
setProperty
in interface Database
propertyName
- TODOpropertyValue
- TODO
javax.naming.NamingException
- TODODatabase.setProperty(String, String)
public java.lang.String getProperty(java.lang.String propertyName) throws javax.naming.NamingException
Database
getProperty
in interface Database
propertyName
- TODO
javax.naming.NamingException
- TODODatabase.getProperty(String)
public javax.naming.directory.Attributes getIndices(java.math.BigInteger id) throws javax.naming.NamingException
Database
getIndices
in interface Database
id
- TODO
javax.naming.NamingException
- TODODatabase.getIndices(java.math.BigInteger)
public void modify(javax.naming.Name dn, int modOp, javax.naming.directory.Attributes mods) throws javax.naming.NamingException
Database
modify
in interface Database
dn
- TODOmodOp
- TODOmods
- TODO
javax.naming.NamingException
- TODODatabase.modify(javax.naming.Name, int,
javax.naming.directory.Attributes)
public void modify(javax.naming.Name dn, javax.naming.directory.ModificationItem[] mods) throws javax.naming.NamingException
Database
modify
in interface Database
dn
- TODOmods
- TODO
javax.naming.NamingException
- TODODatabase.modify(javax.naming.Name,
javax.naming.directory.ModificationItem[])
public void modifyRdn(javax.naming.Name dn, java.lang.String newRdn, boolean deleteOldRdn) throws javax.naming.NamingException
modifyRdn
in interface Database
dn
- the normalized distinguished name of the entry to alternewRdn
- the new Rdn to setdeleteOldRdn
- whether or not to remove the old Rdn attr/val
javax.naming.NamingException
- if there are any errors propagating the name
changes.Database.modifyRdn(javax.naming.Name,
String, boolean)
public void move(javax.naming.Name oldChildDn, javax.naming.Name newParentDn, java.lang.String newRdn, boolean deleteOldRdn) throws javax.naming.NamingException
Database
move
in interface Database
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 resultsDatabase.move(javax.naming.Name,
javax.naming.Name, String, boolean)
public void move(javax.naming.Name oldChildDn, javax.naming.Name newParentDn) throws javax.naming.NamingException
move
in interface Database
oldChildDn
- the normalized dn of the child to be movednewParentDn
- the normalized dn of the new parent for the child
javax.naming.NamingException
- if something goes wrongDatabase.move(javax.naming.Name,
javax.naming.Name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |