|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Store<E>
Represents an entry store based on the Table, Index, and MasterTable database structure.
Field Summary | |
---|---|
static java.lang.String |
ALIAS
Private OID (1.3.6.1.4.1.18060.0.4.1.2.7) for apacheAlias index |
static java.lang.String |
NDN
Private OID (1.3.6.1.4.1.18060.0.4.1.2.1) for apacheNdn op attrib |
static java.lang.String |
ONEALIAS
Private OID (1.3.6.1.4.1.18060.0.4.1.2.5) for apacheOneAlias index |
static java.lang.String |
ONELEVEL
Private OID (1.3.6.1.4.1.18060.0.4.1.2.4) for apacheOneLevel op attrib |
static java.lang.String |
PRESENCE
Private OID (1.3.6.1.4.1.18060.0.4.1.2.3) for apachePresence op attrib |
static java.lang.String |
SUBALIAS
Private OID (1.3.6.1.4.1.18060.0.4.1.2.6) for apacheSubAlias index |
static java.lang.String |
SUBLEVEL
Private OID (1.3.6.1.4.1.18060.0.4.1.2.43) for apacheSubLevel index |
static java.lang.String |
UPDN
Private OID (1.3.6.1.4.1.18060.0.4.1.2.2) for apacheUpdn op attrib |
Method Summary | |
---|---|
void |
add(org.apache.directory.shared.ldap.name.LdapDN normName,
ServerEntry entry)
|
void |
addIndex(Index<?,E> index)
|
int |
count()
|
void |
delete(java.lang.Long id)
|
void |
destroy()
Close the parttion : we have to close all the userIndices and the master table. |
Index<java.lang.String,E> |
getAliasIndex()
|
int |
getCacheSize()
|
int |
getChildCount(java.lang.Long id)
|
java.lang.String |
getEntryDn(java.lang.Long id)
|
java.lang.Long |
getEntryId(java.lang.String dn)
|
java.lang.String |
getEntryUpdn(java.lang.Long id)
|
java.lang.String |
getEntryUpdn(java.lang.String dn)
|
java.lang.String |
getName()
|
Index<java.lang.String,E> |
getNdnIndex()
|
Index<java.lang.Long,E> |
getOneAliasIndex()
|
Index<java.lang.Long,E> |
getOneLevelIndex()
|
java.lang.Long |
getParentId(java.lang.Long childId)
|
java.lang.Long |
getParentId(java.lang.String dn)
Gets the Long id of an entry's parent using the child entry's normalized dn. |
Index<java.lang.String,E> |
getPresenceIndex()
|
java.lang.String |
getProperty(java.lang.String propertyName)
|
Index<java.lang.Long,E> |
getSubAliasIndex()
|
Index<java.lang.Long,E> |
getSubLevelIndex()
|
org.apache.directory.shared.ldap.name.LdapDN |
getSuffix()
|
java.lang.String |
getSuffixDn()
|
Index<?,E> |
getSystemIndex(java.lang.String id)
|
Index<java.lang.String,E> |
getUpdnIndex()
|
org.apache.directory.shared.ldap.name.LdapDN |
getUpSuffix()
|
Index<?,E> |
getUserIndex(java.lang.String id)
|
java.util.Set<Index<?,E>> |
getUserIndices()
|
java.io.File |
getWorkingDirectory()
|
boolean |
hasSystemIndexOn(java.lang.String id)
|
boolean |
hasUserIndexOn(java.lang.String id)
|
void |
init(Registries registries)
Initialize the JDBM storage system. |
void |
initRegistries(Registries registries)
|
boolean |
isInitialized()
Gets whether the store is initialized. |
boolean |
isSyncOnWrite()
|
IndexCursor<java.lang.Long,E> |
list(java.lang.Long id)
Gets an IndexEntry Cursor over the child nodes of an entry. |
ServerEntry |
lookup(java.lang.Long id)
|
void |
modify(org.apache.directory.shared.ldap.name.LdapDN dn,
java.util.List<org.apache.directory.shared.ldap.entry.Modification> mods)
|
void |
modify(org.apache.directory.shared.ldap.name.LdapDN dn,
org.apache.directory.shared.ldap.entry.ModificationOperation modOp,
ServerEntry mods)
|
void |
move(org.apache.directory.shared.ldap.name.LdapDN oldChildDn,
org.apache.directory.shared.ldap.name.LdapDN newParentDn)
|
void |
move(org.apache.directory.shared.ldap.name.LdapDN oldChildDn,
org.apache.directory.shared.ldap.name.LdapDN newParentDn,
org.apache.directory.shared.ldap.name.Rdn newRdn,
boolean deleteOldRdn)
|
void |
rename(org.apache.directory.shared.ldap.name.LdapDN dn,
org.apache.directory.shared.ldap.name.Rdn newRdn,
boolean deleteOldRdn)
Changes the relative distinguished name of an entry specified by a distinguished name with the optional removal of the old Rdn attribute value from the entry. |
void |
setAliasIndex(Index<java.lang.String,E> index)
|
void |
setCacheSize(int cacheSize)
|
void |
setName(java.lang.String name)
|
void |
setNdnIndex(Index<java.lang.String,E> index)
|
void |
setOneAliasIndex(Index<java.lang.Long,E> index)
|
void |
setOneLevelIndex(Index<java.lang.Long,E> index)
|
void |
setPresenceIndex(Index<java.lang.String,E> index)
|
void |
setProperty(java.lang.String propertyName,
java.lang.String propertyValue)
|
void |
setSubAliasIndex(Index<java.lang.Long,E> index)
|
void |
setSubLevelIndex(Index<java.lang.Long,E> index)
|
void |
setSuffixDn(java.lang.String suffixDn)
|
void |
setSyncOnWrite(boolean isSyncOnWrite)
|
void |
setUpdnIndex(Index<java.lang.String,E> index)
|
void |
setUserIndices(java.util.Set<Index<?,E>> userIndices)
|
void |
setWorkingDirectory(java.io.File workingDirectory)
|
void |
sync()
This method is called when the synch thread is waking up, to write the modified data. |
java.util.Iterator<java.lang.String> |
systemIndices()
|
java.util.Iterator<java.lang.String> |
userIndices()
|
Field Detail |
---|
static final java.lang.String NDN
static final java.lang.String UPDN
static final java.lang.String ONEALIAS
static final java.lang.String SUBALIAS
static final java.lang.String ALIAS
static final java.lang.String SUBLEVEL
static final java.lang.String PRESENCE
static final java.lang.String ONELEVEL
Method Detail |
---|
void setWorkingDirectory(java.io.File workingDirectory)
java.io.File getWorkingDirectory()
void setUserIndices(java.util.Set<Index<?,E>> userIndices)
java.util.Set<Index<?,E>> getUserIndices()
void setSuffixDn(java.lang.String suffixDn)
java.lang.String getSuffixDn()
void setSyncOnWrite(boolean isSyncOnWrite)
boolean isSyncOnWrite()
void setCacheSize(int cacheSize)
int getCacheSize()
void setName(java.lang.String name)
java.lang.String getName()
void init(Registries registries) throws java.lang.Exception
registries
- the schema registries
java.lang.Exception
- on failure to lookup elements in registries
java.lang.Exception
- on failure to create database filesvoid destroy() throws java.lang.Exception
java.lang.Exception
- lazily thrown on any closer failures to avoid leaving
open filesboolean isInitialized()
void sync() throws java.lang.Exception
java.lang.Exception
- on failures to sync database files to diskvoid addIndex(Index<?,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.String,E> getPresenceIndex()
void setPresenceIndex(Index<java.lang.String,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.Long,E> getOneLevelIndex()
void setOneLevelIndex(Index<java.lang.Long,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.Long,E> getSubLevelIndex()
void setSubLevelIndex(Index<java.lang.Long,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.String,E> getAliasIndex()
void setAliasIndex(Index<java.lang.String,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.Long,E> getOneAliasIndex()
void setOneAliasIndex(Index<java.lang.Long,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.Long,E> getSubAliasIndex()
void setSubAliasIndex(Index<java.lang.Long,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.String,E> getUpdnIndex()
void setUpdnIndex(Index<java.lang.String,E> index) throws java.lang.Exception
java.lang.Exception
Index<java.lang.String,E> getNdnIndex()
void setNdnIndex(Index<java.lang.String,E> index) throws java.lang.Exception
java.lang.Exception
java.util.Iterator<java.lang.String> userIndices()
java.util.Iterator<java.lang.String> systemIndices()
boolean hasUserIndexOn(java.lang.String id) throws java.lang.Exception
java.lang.Exception
boolean hasSystemIndexOn(java.lang.String id) throws java.lang.Exception
java.lang.Exception
Index<?,E> getUserIndex(java.lang.String id) throws IndexNotFoundException
IndexNotFoundException
Index<?,E> getSystemIndex(java.lang.String id) throws IndexNotFoundException
IndexNotFoundException
java.lang.Long getEntryId(java.lang.String dn) throws java.lang.Exception
java.lang.Exception
java.lang.String getEntryDn(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
java.lang.Long getParentId(java.lang.String dn) throws java.lang.Exception
dn
- the normalized distinguished name of the child
java.lang.Exception
- on failures to access the underlying storejava.lang.Long getParentId(java.lang.Long childId) throws java.lang.Exception
java.lang.Exception
java.lang.String getEntryUpdn(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
java.lang.String getEntryUpdn(java.lang.String dn) throws java.lang.Exception
java.lang.Exception
int count() throws java.lang.Exception
java.lang.Exception
void add(org.apache.directory.shared.ldap.name.LdapDN normName, ServerEntry entry) throws java.lang.Exception
java.lang.Exception
ServerEntry lookup(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
void delete(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
IndexCursor<java.lang.Long,E> list(java.lang.Long id) throws java.lang.Exception
id
- the id of the parent entry
java.lang.Exception
- on failures to access the underlying storeint getChildCount(java.lang.Long id) throws java.lang.Exception
java.lang.Exception
org.apache.directory.shared.ldap.name.LdapDN getSuffix()
org.apache.directory.shared.ldap.name.LdapDN getUpSuffix()
void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws java.lang.Exception
java.lang.Exception
java.lang.String getProperty(java.lang.String propertyName) throws java.lang.Exception
java.lang.Exception
void modify(org.apache.directory.shared.ldap.name.LdapDN dn, org.apache.directory.shared.ldap.entry.ModificationOperation modOp, ServerEntry mods) throws java.lang.Exception
java.lang.Exception
void modify(org.apache.directory.shared.ldap.name.LdapDN dn, java.util.List<org.apache.directory.shared.ldap.entry.Modification> mods) throws java.lang.Exception
java.lang.Exception
void rename(org.apache.directory.shared.ldap.name.LdapDN dn, org.apache.directory.shared.ldap.name.Rdn newRdn, boolean deleteOldRdn) throws java.lang.Exception
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
java.lang.Exception
- if there are any errors propagating the name changesvoid move(org.apache.directory.shared.ldap.name.LdapDN oldChildDn, org.apache.directory.shared.ldap.name.LdapDN newParentDn, org.apache.directory.shared.ldap.name.Rdn newRdn, boolean deleteOldRdn) throws java.lang.Exception
java.lang.Exception
void move(org.apache.directory.shared.ldap.name.LdapDN oldChildDn, org.apache.directory.shared.ldap.name.LdapDN newParentDn) throws java.lang.Exception
java.lang.Exception
void initRegistries(Registries registries)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |