Package tigase.db.comp
Interface ComponentRepository<Item extends RepositoryItem>
- Type Parameters:
Item- An element stored in the component repository.
- All Superinterfaces:
Iterable<Item>,Repository
- All Known Subinterfaces:
ComponentRepositoryDataSourceAware<Item,,DS> ConfigRepositoryIfc,VHostComponentRepository,VHostComponentRepositoryDataSourceAware<DS>
- All Known Implementing Classes:
AbstractCompDBRepository,AbstractSDComponentRepositoryBean,CertificateRepository,ClConConfigRepository,ClConDirRepository,ClConSQLRepository,ClusterConnectionManager.DefClConRepositoryBean,CompCompDBRepository,CompConfigRepository,CompSQLRepository,ConfigRepository,ConfigSQLRepository,ConfigurationCache,ConfigXMLRepository,ExtServiceDiscoveryUserRepoRepository,ManagerCompDBRepository,ServerCompDBRepository,TaskConfigItemJDBCRepository,UserRepoRepository,VHostJDBCRepository,VHostManager.DefVHostRepositoryBean
public interface ComponentRepository<Item extends RepositoryItem>
extends Iterable<Item>, Repository
A convenience interface for a unified access to component specific repository data. This is not intended to keep huge
number of elements. Rather then it is more like for storing Component dynamic configuration data. In simple cases
this data can be stored in configuration file, in more complex cases it can be a database represented by
UserRepository or even something else.
The repository is intended to store elements of a single type only. Each element is identified by a unique key. All elements are cached in memory for a fast retrieval so this kind of repository is recommended for small data only when you need very fast and efficient access to all the information.
Some implementations however may behave differently and not cache all the repository items in memory.
Created: Oct 3, 2009 1:46:25 PM
The repository is intended to store elements of a single type only. Each element is identified by a unique key. All elements are cached in memory for a fast retrieval so this kind of repository is recommended for small data only when you need very fast and efficient access to all the information.
Some implementations however may behave differently and not cache all the repository items in memory.
Created: Oct 3, 2009 1:46:25 PM
- Author:
- Artur Hefczyc
-
Nested Class Summary
Nested classes/interfaces inherited from interface tigase.db.Repository
Repository.Meta, Repository.SchemaId -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidThe method adds a new or updates existing Item in the repository.voidaddItemNoStore(Item item) The method adds a new or updates existing Item.voidaddRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener) Adds a listener for repository Item change.allItems()Returns a collection with all items stored in the repository.booleanThe method checks whether the item is stored in the repository.voiddestroy()Method destroys this instance of ComponentRepository releasing resources allocated for this instance of ComponentRepository if possiblevoidDeprecated.The method returns all item configuration parameters for a key ornullif the item does not exist in the repository.Creates a new, uninitialized instance of the repository Item.voidreload()This method is called to reload items from the database or other permanent storage.voidremoveItem(String key) The method is called to remove given Item from the memory cache and permanent storage.voidremoveItemNoStore(String key) voidremoveRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener) Removes a listener for repository Item change.voidsetAutoloadTimer(long delay) Sets autoload task to periodically reload data from database.voidsetProperties(Map<String, Object> properties) Deprecated.intsize()The method returns number of items in the repository.voidstore()The method is called to store all data in the database.validateItem(Item item) Performs Item validation to check whether it meets the repository policy.Methods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface tigase.db.Repository
initRepository
-
Field Details
-
COMP_REPO_BIND
- See Also:
-
-
Method Details
-
addRepoChangeListener
Adds a listener for repository Item change. -
removeRepoChangeListener
Removes a listener for repository Item change. -
addItem
The method adds a new or updates existing Item in the repository. It needs to have all fields set correctly. After this method call is finished a new added item must be available in the component repository. The method adds the item to memory cache and permanent storage.- Parameters:
item- aItemwith all it's configuration parameters.- Throws:
TigaseDBException
-
addItemNoStore
The method adds a new or updates existing Item. It needs to have all fields set correctly. After this method call is finished a new added item must be available in the component repository. The method adds the item to memory cache but not to a permanent storage.- Parameters:
item- aItemwith all it's configuration parameters.
-
allItems
Returns a collection with all items stored in the repository.- Throws:
TigaseDBException
-
contains
The method checks whether the item is stored in the repository.- Parameters:
key- aStringwith key to search for.- Returns:
- a
booleanvaluetrueif the item exists in the repository orfalseof it does not.
-
destroy
void destroy()Method destroys this instance of ComponentRepository releasing resources allocated for this instance of ComponentRepository if possible -
getDefaults
Deprecated.The method is called to obtain default configuration settings if there are any for this repository implementation The configuration settings are implementation dependent and there are no defaults set by the server. Default settings returned by this method are then saved in the configuration file and presented to the admin for further adjustments.- Parameters:
defs- is aMapcollection where all repository configuration defaults must be put.params- is aMapcollection with some preset properties for the server. These settings can be used to adjust repository defaults, for example they can contain database connection URL or initial list of virtual domains.
-
getItem
The method returns all item configuration parameters for a key ornullif the item does not exist in the repository.- Parameters:
key- aStringwith item identifier to search for.- Returns:
- a
Itemfor a given key ornullif the item is not in the repository.
-
getItemInstance
Item getItemInstance()Creates a new, uninitialized instance of the repository Item.- Returns:
- a new, uninitialized instance of the repository Item.
-
reload
This method is called to reload items from the database or other permanent storage. It is possible that items list is modified externally by third-party system. When all modifications are done this method is called to refresh the class cache. Whether the implementation load whole list or just last modifications is implementation dependent.- Throws:
TigaseDBException
-
removeItem
The method is called to remove given Item from the memory cache and permanent storage. After this method is completed the item should no longer be available in the component repository.- Parameters:
key- aStringwith domain name to remove.- Throws:
TigaseDBException
-
removeItemNoStore
-
setProperties
Deprecated.The method is called to set configuration for this repository implementation. The configuration is repository implementation dependent. There are no default settings for the repository.- Parameters:
properties- aMapwith configuration settings. Content of thisMapmust not be modified. This read-only collection.
-
size
int size()The method returns number of items in the repository.- Returns:
- an
intvalue with number of items in the repository.
-
store
The method is called to store all data in the database. It is used when the repository has been changed in some way and the changes have to be put to a permanent storage for later retrieval.- Throws:
TigaseDBException
-
validateItem
Performs Item validation to check whether it meets the repository policy. If validation is successful the method returnsnull, otherwise it returns an error description.- Parameters:
item- is anItemobject to perform validation checking upon.- Returns:
nullon success and an error message otherwise.
-
setAutoloadTimer
void setAutoloadTimer(long delay) Sets autoload task to periodically reload data from database.- Parameters:
delay- in seconds between each database reload.
-