fr.paris.lutece.portal.service.datastore

Class DatastoreService

java.lang.Object

fr.paris.lutece.portal.service.datastore.DatastoreService

public final class DatastoreService
extends Object

Datastore Service

Field Summary

Fields

Modifier and Type	Field and Description
static String	VALUE_FALSE
static String	VALUE_TRUE

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	existsInstanceKey(String strKey) Check if a key is available in the datastore depending the current web app instance
static boolean	existsKey(String strKey) Check if a key is available in the datastore
static ReferenceList	getDataByPrefix(String strPrefix) Gets a list of key/value where keys are matching a given prefix
static String	getDataValue(String strKey, String strDefault) Get entity
static ReferenceList	getInstanceDataByPrefix(String strPrefix) Gets a list of key/value where keys are matching a given prefix depending the current web app instance
static String	getInstanceDataValue(String strKey, String strDefault) Get entity depending the current web app instance
static void	init() initialize the service
static void	removeData(String strKey) Remove a give key
static void	removeDataByPrefix(String strPrefix) Remove all data where keys begin with a given prefix
static void	removeInstanceData(String strKey) Remove a give key depending the current web app instance
static void	removeInstanceDataByPrefix(String strPrefix) Remove all data where keys begin with a given prefix depending the current web app instance
static String	replaceKeys(String strSource) This method replace keys by their value into a given content
static void	setDataValue(String strKey, String strValue) Set entity
static void	setInstanceDataValue(String strKey, String strValue) Set entity depending the current web app instance
static void	startCache() Start cache.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_TRUE

public static final String VALUE_TRUE

See Also:

Constant Field Values

VALUE_FALSE

public static final String VALUE_FALSE

See Also:

Constant Field Values

Method Detail

init

public static void init()

initialize the service

getDataValue

public static String getDataValue(String strKey,
                  String strDefault)

Get entity

Parameters:

strKey - The entity's key

strDefault - The default value

Returns:

The value

getInstanceDataValue

public static String getInstanceDataValue(String strKey,
                          String strDefault)

Get entity depending the current web app instance

Parameters:

strKey - The entity's key

strDefault - The default value

Returns:

The value

setDataValue

public static void setDataValue(String strKey,
                String strValue)

Set entity

Parameters:

strKey - The entity's key

strValue - The value

setInstanceDataValue

public static void setInstanceDataValue(String strKey,
                        String strValue)

Set entity depending the current web app instance

Parameters:

strKey - The entity's key

strValue - The value

removeData

public static void removeData(String strKey)

Remove a give key

Parameters:

strKey - The key

removeInstanceData

public static void removeInstanceData(String strKey)

Remove a give key depending the current web app instance

Parameters:

strKey - The key

removeDataByPrefix

public static void removeDataByPrefix(String strPrefix)

Remove all data where keys begin with a given prefix

Parameters:

strPrefix - The prefix

removeInstanceDataByPrefix

public static void removeInstanceDataByPrefix(String strPrefix)

Remove all data where keys begin with a given prefix depending the current web app instance

Parameters:

strPrefix - The prefix

getDataByPrefix

public static ReferenceList getDataByPrefix(String strPrefix)

Gets a list of key/value where keys are matching a given prefix

Parameters:

strPrefix - The prefix

Returns:

The list

getInstanceDataByPrefix

public static ReferenceList getInstanceDataByPrefix(String strPrefix)

Gets a list of key/value where keys are matching a given prefix depending the current web app instance

Parameters:

strPrefix - The prefix

Returns:

The list

replaceKeys

public static String replaceKeys(String strSource)

This method replace keys by their value into a given content

Parameters:

strSource - The string that contains datastore keys

Returns:

The string with keys replaced

existsKey

public static boolean existsKey(String strKey)

Check if a key is available in the datastore

Parameters:

strKey - The key

Returns:

True if the key is found otherwise false

existsInstanceKey

public static boolean existsInstanceKey(String strKey)

Check if a key is available in the datastore depending the current web app instance

Parameters:

strKey - The key

Returns:

True if the key is found otherwise false

startCache

public static void startCache()

Start cache. NB : Cache can't be created at DataStore creation because CacheService uses DatastoreService (Circular reference)