org.tentackle.persist

Class DbPreferencesFactory

java.lang.Object

org.tentackle.persist.DbPreferencesFactory

All Implemented Interfaces:

PreferencesFactory, PersistedPreferencesFactory

@Service(value=org.tentackle.prefs.PersistedPreferencesFactory.class)
public class DbPreferencesFactory
extends Object
implements PersistedPreferencesFactory

Implementation of a PersistedPreferencesFactory.

Constructor Summary

Constructors

Constructor and Description
DbPreferencesFactory() Creates the factory.

Method Summary

Modifier and Type	Method and Description
void	addKey(DbPreferencesKey key) Adds a key/value pair.
void	addPreferences(DbPreferences prefs) Adds a preferences node the maps.
DbPreferencesKey	createKey() Creates a new DbPreferencesKey.
DbPreferencesNode	createNode() Creates a new DbPreferencesNode. All nodes are created through this method.
DbPreferences	createPreferences(boolean userMode) Creates a DbPreferences instance.
DbPreferences	createPreferences(DbPreferences parent, DbPreferencesNode node) Creates a DbPreferences instance from a parent and a node.
DbPreferences	createPreferences(DbPreferences parent, String name) Creates a DbPreferences instance from a parent and a name.
void	expireKeys(long maxSerial) Expire the preferences keys. Invoked from the ModificationTracker (registered in DbPreferencesKey)
void	expireNodes(long maxSerial) Expires the preferences nodes. Invoked from the ModificationTracker (registered in DbPreferencesNode).
DbPreferences	getPreferences(long nodeId) Gets the cached preferences by node id.
DbPreferences	getPreferences(String user, String path) Gets the cached preferences by user and node path.
Session	getSession() Gets the session for a persistence operation.
PersistedPreferences	getSystemRoot()
PersistedPreferences	getUserRoot()
void	importPreferences(InputStream is)
boolean	isAutoSync()
boolean	isReadOnly()
boolean	isSystemOnly()
protected static String	nodeName(Class<?> clazz) Returns the absolute path name of the node corresponding to the package of the specified object.
void	removeKey(DbPreferencesKey key) Removes a key.
void	removeNode(DbPreferencesNode node) Removes a node.
void	setAutoSync(boolean autoSync)
void	setReadOnly(boolean readOnly)
void	setSystemOnly(boolean systemOnly)
DbPreferences	systemNodeForPackage(Class<?> c)
DbPreferences	systemRoot()
void	updateKeyTableSerial(long newTableSerial) Updates the highest keys table serial.
void	updateNodeTableSerial(long newTableSerial) Updates the highest node table serial.
DbPreferences	userNodeForPackage(Class<?> c)
DbPreferences	userRoot()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.prefs.PersistedPreferencesFactory

getInstance

Constructor Detail

DbPreferencesFactory

public DbPreferencesFactory()

Creates the factory.

Method Detail

getSession

public Session getSession()

Gets the session for a persistence operation.

Returns:

the session

updateNodeTableSerial

public void updateNodeTableSerial(long newTableSerial)

Updates the highest node table serial.

Parameters:

newTableSerial - the new serial

updateKeyTableSerial

public void updateKeyTableSerial(long newTableSerial)

Updates the highest keys table serial.

Parameters:

newTableSerial - the new serial

addPreferences

public void addPreferences(DbPreferences prefs)

Adds a preferences node the maps.

Parameters:

prefs - the preferences node

removeNode

public void removeNode(DbPreferencesNode node)

Removes a node.

Parameters:

node - the node

getPreferences

public DbPreferences getPreferences(long nodeId)

Gets the cached preferences by node id.

Parameters:

nodeId - the node id

Returns:

the preferences, null if not in cache

getPreferences

public DbPreferences getPreferences(String user,
                                    String path)

Gets the cached preferences by user and node path.

Parameters:

user - the user

path - the node path

Returns:

the preferences, null if not in cache

addKey

public void addKey(DbPreferencesKey key)

Adds a key/value pair.

Parameters:

key - the key

removeKey

public void removeKey(DbPreferencesKey key)

Removes a key.

Parameters:

key - the key

expireKeys

public void expireKeys(long maxSerial)

Expire the preferences keys.
Invoked from the ModificationTracker (registered in DbPreferencesKey)

Parameters:

maxSerial - is the current tableserial

expireNodes

public void expireNodes(long maxSerial)

Expires the preferences nodes.
Invoked from the ModificationTracker (registered in DbPreferencesNode).

Parameters:

maxSerial - is the current tableserial

userRoot

public DbPreferences userRoot()

Specified by:

userRoot in interface PreferencesFactory

getUserRoot

public PersistedPreferences getUserRoot()

Specified by:

getUserRoot in interface PersistedPreferencesFactory

systemRoot

public DbPreferences systemRoot()

Specified by:

systemRoot in interface PreferencesFactory

getSystemRoot

public PersistedPreferences getSystemRoot()

Specified by:

getSystemRoot in interface PersistedPreferencesFactory

isAutoSync

public boolean isAutoSync()

Specified by:

isAutoSync in interface PersistedPreferencesFactory

setAutoSync

public void setAutoSync(boolean autoSync)

Specified by:

setAutoSync in interface PersistedPreferencesFactory

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface PersistedPreferencesFactory

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface PersistedPreferencesFactory

isSystemOnly

public boolean isSystemOnly()

Specified by:

isSystemOnly in interface PersistedPreferencesFactory

setSystemOnly

public void setSystemOnly(boolean systemOnly)

Specified by:

setSystemOnly in interface PersistedPreferencesFactory

userNodeForPackage

public DbPreferences userNodeForPackage(Class<?> c)

Specified by:

userNodeForPackage in interface PersistedPreferencesFactory

systemNodeForPackage

public DbPreferences systemNodeForPackage(Class<?> c)

Specified by:

systemNodeForPackage in interface PersistedPreferencesFactory

importPreferences

public void importPreferences(InputStream is)
                       throws IOException,
                              InvalidPreferencesFormatException

Specified by:

importPreferences in interface PersistedPreferencesFactory

Throws:

IOException

InvalidPreferencesFormatException

createPreferences

public DbPreferences createPreferences(boolean userMode)

Creates a DbPreferences instance.

Parameters:

userMode - true if user mode

Returns:

the preferences instance

createPreferences

public DbPreferences createPreferences(DbPreferences parent,
                                       String name)

Creates a DbPreferences instance from a parent and a name.

Parameters:

parent - the parent preferences node

name - the name of the child node

Returns:

the preferences instance

createPreferences

public DbPreferences createPreferences(DbPreferences parent,
                                       DbPreferencesNode node)
                                throws BackingStoreException

Creates a DbPreferences instance from a parent and a node. Protected scope!

Parameters:

parent - the parent preferences

node - the node

Returns:

the preferences instance

Throws:

BackingStoreException - if creation failed

createNode

public DbPreferencesNode createNode()

Creates a new DbPreferencesNode.
All nodes are created through this method. This allows replacing the concrete implementation by overriding the method.

Returns:

the new node within the current db

createKey

public DbPreferencesKey createKey()

Creates a new DbPreferencesKey. All keys are created through this method. This allows replacing the concrete implementation by overriding the method.

Returns:

the new key within the current db

nodeName

protected static String nodeName(Class<?> clazz)

Returns the absolute path name of the node corresponding to the package of the specified object.

Parameters:

clazz - the class

Returns:

the path name

Throws:

IllegalArgumentException - if the package has node preferences node associated with it.