|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Item
- An element stored in the component repository.public interface ComponentRepository<Item extends RepositoryItem>
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.
Field Summary | |
---|---|
static String |
COMP_REPO_BIND
|
Method Summary | |
---|---|
void |
addItem(Item item)
The method adds a new or updates existing Item in the repository. |
Collection<Item> |
allItems()
Retuns a collection with all items stored in the repository. |
boolean |
contains(String key)
The method checks whether the item is stored in the repository. |
void |
getDefaults(Map<String,Object> defs,
Map<String,Object> params)
The method is called to obtain defualt 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. |
Item |
getItem(String key)
The method returns all item configuration parameters for a key or null if the item does not exist in the repository. |
Item |
getItemInstance()
Creates a new, uninitialized instance of the repository Item. |
void |
reload()
This method is called to reload items from the database or other permanent storage. |
void |
removeItem(String key)
The method is called to remove given Item from the memory cache and permanent storage. |
void |
setProperties(Map<String,Object> properties)
The method is called to set configuration for this repository implementation. |
int |
size()
The method returns number of itens in the repository. |
void |
store()
The method is called to store all data in the database. |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Field Detail |
---|
static final String COMP_REPO_BIND
Method Detail |
---|
void getDefaults(Map<String,Object> defs, Map<String,Object> params)
defs
- is a Map
collection where all repository
configuration defaults must be put.params
- is a Map
collection 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.void setProperties(Map<String,Object> properties)
properties
- a Map
with configuration settings. Content
of this Map
must not be modified. This read-only collection.void removeItem(String key) throws TigaseDBException
key
- a String
with domain name to remove.
TigaseDBException
void addItem(Item item) throws TigaseDBException
item
- a Item
with all it's configuration parameters.
TigaseDBException
Item getItem(String key)
null
if the item does not exist in the repository.
key
- a String
with item identifier to search for.
Item
for a given key or null
if the item is not in the repository.boolean contains(String key)
key
- a String
with key to search for.
boolean
value true
if the item exists in
the repository or false
of it does not.void reload() throws TigaseDBException
TigaseDBException
void store() throws TigaseDBException
TigaseDBException
int size()
int
value with number of items in the
repository.Collection<Item> allItems() throws TigaseDBException
TigaseDBException
Item getItemInstance()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |