Item
- An element stored in the component repository.public interface ComponentRepository<Item extends RepositoryItem> extends Iterable<Item>, Repository
Repository.Meta, Repository.SchemaId
Modifier and Type | Field and Description |
---|---|
static String |
COMP_REPO_BIND |
Modifier and Type | Method and Description |
---|---|
void |
addItem(Item item)
The method adds a new or updates existing Item in the repository.
|
void |
addItemNoStore(Item item)
The method adds a new or updates existing Item.
|
void |
addRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener)
Adds a listener for repository Item change.
|
Collection<Item> |
allItems()
Returns 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 |
destroy()
Method destroys this instance of ComponentRepository releasing resources allocated for this instance of
ComponentRepository if possible
|
void |
getDefaults(Map<String,Object> defs,
Map<String,Object> params)
Deprecated.
|
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 |
removeItemNoStore(String key) |
void |
removeRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener)
Removes a listener for repository Item change.
|
void |
setAutoloadTimer(long delay)
Sets autoload task to periodically reload data from database.
|
void |
setProperties(Map<String,Object> properties)
Deprecated.
|
int |
size()
The method returns number of items in the repository.
|
void |
store()
The method is called to store all data in the database.
|
String |
validateItem(Item item)
Performs Item validation to check whether it meets the repository policy.
|
forEach, iterator, spliterator
initRepository
static final String COMP_REPO_BIND
void addRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener)
void removeRepoChangeListener(RepositoryChangeListenerIfc<Item> repoChangeListener)
void addItem(Item item) throws TigaseDBException
item
- a Item
with all it's configuration parameters.TigaseDBException
void addItemNoStore(Item item)
item
- a Item
with all it's configuration parameters.Collection<Item> allItems() throws TigaseDBException
TigaseDBException
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 destroy()
@Deprecated 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.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.Item getItemInstance()
void reload() throws TigaseDBException
TigaseDBException
void removeItem(String key) throws TigaseDBException
key
- a String
with domain name to remove.TigaseDBException
void removeItemNoStore(String key)
@Deprecated void setProperties(Map<String,Object> properties)
properties
- a Map
with configuration settings. Content of this Map
must not be
modified. This read-only collection.int size()
int
value with number of items in the repository.void store() throws TigaseDBException
TigaseDBException
String validateItem(Item item)
null
, otherwise it returns an error description.item
- is an Item
object to perform validation checking upon.null
on success and an error message otherwise.void setAutoloadTimer(long delay)
delay
- in seconds between each database reload.Copyright © 2004–2019 "Tigase, Inc.". All rights reserved.