tigase.db.comp
Class ConfigRepository<Item extends RepositoryItem>

java.lang.Object
  tigase.db.comp.ConfigRepository<Item>

Type Parameters:

Item -

All Implemented Interfaces:

java.lang.Iterable<Item>, ComponentRepository<Item>

Direct Known Subclasses:

CompConfigRepository, UserRepoRepository, VhostConfigRepository

public abstract class ConfigRepository<Item extends RepositoryItem>
extends java.lang.Object
implements ComponentRepository<Item>

Created: Oct 3, 2009 2:58:41 PM

Version:

$Rev: 1985 $

Author:

Artur Hefczyc

Field Summary

protected java.util.LinkedHashMap<java.lang.String,Item>

items

Fields inherited from interface tigase.db.ComponentRepository

COMP_REPO_BIND

Constructor Summary

ConfigRepository()

Method Summary

void	addItem(Item item) The method adds a new or updates existing Item in the repository.
java.util.Collection<Item>	allItems() Retuns a collection with all items stored in the repository.
boolean	contains(java.lang.String key) The method checks whether the item is stored in the repository.
abstract java.lang.String	getConfigKey()
abstract java.lang.String[]	getDefaultPropetyItems()
void	getDefaults(java.util.Map<java.lang.String,java.lang.Object> defs, java.util.Map<java.lang.String,java.lang.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(java.lang.String key) The method returns all item configuration parameters for a key or null if the item does not exist in the repository.
abstract java.lang.String	getPropertyKey()
java.util.Iterator<Item>	iterator()
void	reload() This method is called to reload items from the database or other permanent storage.
void	removeItem(java.lang.String key) The method is called to remove given Item from the memory cache and permanent storage.
void	setProperties(java.util.Map<java.lang.String,java.lang.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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tigase.db.ComponentRepository

getItemInstance

Field Detail

items

protected java.util.LinkedHashMap<java.lang.String,Item extends RepositoryItem> items

Constructor Detail

ConfigRepository

public ConfigRepository()

Method Detail

getDefaultPropetyItems

public abstract java.lang.String[] getDefaultPropetyItems()

getPropertyKey

public abstract java.lang.String getPropertyKey()

getConfigKey

public abstract java.lang.String getConfigKey()

getDefaults

public void getDefaults(java.util.Map<java.lang.String,java.lang.Object> defs,
                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: ComponentRepository

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. Default settings returned by this method are then saved in the configuration file and presented to the admin for further adjustements.

Specified by:

getDefaults in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

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.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Description copied from interface: ComponentRepository

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.

Specified by:

setProperties in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

properties - a Map with configuration settings. Content of this Map must not be modified. This read-only collection.

getItem

public Item getItem(java.lang.String key)

Description copied from interface: ComponentRepository

The method returns all item configuration parameters for a key or null if the item does not exist in the repository.

Specified by:

getItem in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

key - a String with item identifier to search for.

Returns:

a Item for a given key or null if the item is not in the repository.

contains

public boolean contains(java.lang.String key)

Description copied from interface: ComponentRepository

The method checks whether the item is stored in the repository.

Specified by:

contains in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

key - a String with key to search for.

Returns:

a boolean value true if the item exists in the repository or false of it does not.

reload

public void reload()

Description copied from interface: ComponentRepository

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.

Specified by:

reload in interface ComponentRepository<Item extends RepositoryItem>

store

public void store()

Description copied from interface: ComponentRepository

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.

Specified by:

store in interface ComponentRepository<Item extends RepositoryItem>

size

public int size()

Description copied from interface: ComponentRepository

The method returns number of itens in the repository.

Specified by:

size in interface ComponentRepository<Item extends RepositoryItem>

Returns:

an int value with number of items in the repository.

addItem

public void addItem(Item item)

Description copied from interface: ComponentRepository

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 permamnent storage.

Specified by:

addItem in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

item - a Item with all it's configuration parameters.

removeItem

public void removeItem(java.lang.String key)

Description copied from interface: ComponentRepository

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 availble in the component repository.

Specified by:

removeItem in interface ComponentRepository<Item extends RepositoryItem>

Parameters:

key - a String with domain name to remove.

allItems

public java.util.Collection<Item> allItems()

Description copied from interface: ComponentRepository

Retuns a collection with all items stored in the repository.

Specified by:

allItems in interface ComponentRepository<Item extends RepositoryItem>

Returns:

iterator

public java.util.Iterator<Item> iterator()

Specified by:

iterator in interface java.lang.Iterable<Item extends RepositoryItem>