com.goldencode.p2j.ui.client

Class UserPreferences

java.lang.Object

com.goldencode.p2j.ui.client.UserPreferences

All Implemented Interfaces:

KeyValueStorage

public class UserPreferences
extends java.lang.Object
implements KeyValueStorage

Implements the user's key and value storage based on java user preferences API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPreferences.Chunk Represents a chunk of a string data.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fwdUser The current session FWD user.
private static java.lang.String	HEAD_KEY The head key
private static CentralLogger	LOG Logger
private static int	MAXIMAL_STRING_LENGTH The maximal string length for values
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper Maps an object into its json presentation and back
private java.util.prefs.Preferences	preferences The Preferences node as root
private java.lang.String	storageId The unique in-app user storage id.

Constructor Summary

Constructors

Constructor and Description
UserPreferences(java.lang.String storageId, java.lang.String fwdUser) Public constructor.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	collectChunks(java.util.prefs.Preferences node, UserPreferences.Chunk head) Collect stored chunks into the string value of the given key.
void	delete(java.lang.String key) Deletes the given key and its value from this storage.
private void	flushChanges() Flushes the current changes into this storage backend.
private java.lang.String	formUniqueUserKey(java.lang.String originalKey) Returns the key with FWD user name and storageId in the prefix.
java.lang.Boolean	getBoolean(java.lang.String key) Retrieves the boolean value of the given key from this storage.
private UserPreferences.Chunk	getChunk(java.util.prefs.Preferences node, java.lang.String chunkKey) Retrieves the next chunk of stored data.
private int	getMaximalValueSize() Returns the maximal value size that can be stored into this storage backend.
private java.lang.String	getNextChunkKey(UserPreferences.Chunk head, int chunkNumber) Returns the next chunk key.
java.lang.Number	getNumber(java.lang.String key) Retrieves the value of the given key from this storage.
private java.util.prefs.Preferences	getPreferencesFor(java.lang.String key) Returns the node assigned for the given key.
java.lang.String	getStorageId() Returns the storage id for the logged in user.
java.lang.String	getString(java.lang.String key) Retrieves the string value for the given key from this storage.
private UserPreferences.Chunk	retrieveSimpleValue(java.lang.String key) Returns the chunk with the simple value (Boolean or Number) for the given key.
private void	saveByChunks(java.lang.String key, java.lang.String value) Saves the string value of this key in this storage by splitting it into chunks in order to fit value capacity limits of this storage backend.
private void	saveHeadChunk(java.util.prefs.Preferences headNode, java.lang.String key, UserPreferences.Chunk head) Stores the head chunk with the given key within this storage backend.
private void	saveSimpleValue(java.lang.String key, UserPreferences.Chunk chunk) Saves a simple value (Boolean or Number) under the given key.
void	setBoolean(java.lang.String key, java.lang.Boolean value) Saves the boolean value of this key in this storage.
void	setNumber(java.lang.String key, java.lang.Number value) Saves the number value of this key in this storage.
void	setString(java.lang.String key, java.lang.String value) Saves the string value for this key in this storage.
private void	setUniqueHeadName(UserPreferences.Chunk head) Sets the unique name to the given head chunk.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

HEAD_KEY

private static final java.lang.String HEAD_KEY

The head key

See Also:

Constant Field Values

MAXIMAL_STRING_LENGTH

private static final int MAXIMAL_STRING_LENGTH

The maximal string length for values

See Also:

Constant Field Values

preferences

private final java.util.prefs.Preferences preferences

The Preferences node as root

objectMapper

private final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Maps an object into its json presentation and back

storageId

private final java.lang.String storageId

The unique in-app user storage id.

fwdUser

private final java.lang.String fwdUser

The current session FWD user.

Constructor Detail

UserPreferences

public UserPreferences(java.lang.String storageId,
                       java.lang.String fwdUser)

Public constructor.

Parameters:

storageId - The unique in-app user storage id

fwdUser - The FWD user name.

Method Detail

getNumber

public java.lang.Number getNumber(java.lang.String key)

Retrieves the value of the given key from this storage.

Specified by:

getNumber in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The number value of the given key

setNumber

public void setNumber(java.lang.String key,
                      java.lang.Number value)

Saves the number value of this key in this storage.

Specified by:

setNumber in interface KeyValueStorage

Parameters:

key - The given key

value - The value of the given key

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Retrieves the boolean value of the given key from this storage.

Specified by:

getBoolean in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The boolean value of the given key

setBoolean

public void setBoolean(java.lang.String key,
                       java.lang.Boolean value)

Saves the boolean value of this key in this storage.

Specified by:

setBoolean in interface KeyValueStorage

Parameters:

key - The given key

value - The value of the given key

getString

public java.lang.String getString(java.lang.String key)

Retrieves the string value for the given key from this storage.

Specified by:

getString in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The string value of the given key

setString

public void setString(java.lang.String key,
                      java.lang.String value)

Saves the string value for this key in this storage.

Specified by:

setString in interface KeyValueStorage

Parameters:

key - The given key

value - The string value of the given key

delete

public void delete(java.lang.String key)

Deletes the given key and its value from this storage.

Specified by:

delete in interface KeyValueStorage

Parameters:

key - The given key

getStorageId

public java.lang.String getStorageId()

Returns the storage id for the logged in user. Available with SSO enabled.

Specified by:

getStorageId in interface KeyValueStorage

Returns:

The storage id for the logged in user.

retrieveSimpleValue

private UserPreferences.Chunk retrieveSimpleValue(java.lang.String key)

Returns the chunk with the simple value (Boolean or Number) for the given key.

Parameters:

key - The given key

Returns:

The value for the given key

saveSimpleValue

private void saveSimpleValue(java.lang.String key,
                             UserPreferences.Chunk chunk)

Saves a simple value (Boolean or Number) under the given key.

Parameters:

key - The given key

chunk - The chunk to be saved

collectChunks

private java.lang.String collectChunks(java.util.prefs.Preferences node,
                                       UserPreferences.Chunk head)

Collect stored chunks into the string value of the given key.

Parameters:

node - The Preferences node for the key

head - The first chunk

Returns:

The string value of the given key

saveByChunks

private void saveByChunks(java.lang.String key,
                          java.lang.String value)

Saves the string value of this key in this storage by splitting it into chunks in order to fit value capacity limits of this storage backend.

Parameters:

key - The given key

value - The string value of the given key

setUniqueHeadName

private void setUniqueHeadName(UserPreferences.Chunk head)

Sets the unique name to the given head chunk.

Parameters:

head - The first chunk

getNextChunkKey

private java.lang.String getNextChunkKey(UserPreferences.Chunk head,
                                         int chunkNumber)

Returns the next chunk key.

Parameters:

head - A chunk of the stored data value

chunkNumber - The current chunk number

Returns:

The next chunk key;

saveHeadChunk

private void saveHeadChunk(java.util.prefs.Preferences headNode,
                           java.lang.String key,
                           UserPreferences.Chunk head)
                    throws com.fasterxml.jackson.core.JsonProcessingException

Stores the head chunk with the given key within this storage backend.

Parameters:

headNode - The Preferences node for the head key

key - The given key

head - The first chunk

Throws:

com.fasterxml.jackson.core.JsonProcessingException

flushChanges

private void flushChanges()

Flushes the current changes into this storage backend.

getMaximalValueSize

private int getMaximalValueSize()

Returns the maximal value size that can be stored into this storage backend.

Returns:

The maximal value size

getChunk

private UserPreferences.Chunk getChunk(java.util.prefs.Preferences node,
                                       java.lang.String chunkKey)

Retrieves the next chunk of stored data.

Parameters:

node - The preferences node

chunkKey - The chunk key

Returns:

The chunk

getPreferencesFor

private java.util.prefs.Preferences getPreferencesFor(java.lang.String key)

Returns the node assigned for the given key.

Parameters:

key - The given key

Returns:

The assigned node

formUniqueUserKey

private java.lang.String formUniqueUserKey(java.lang.String originalKey)

Returns the key with FWD user name and storageId in the prefix.

Parameters:

originalKey - The key to be processed.

Returns:

The key with FWD user name and storageId in the prefix.