com.communote.server.core.plugin

Class PluginPropertyManagement

java.lang.Object

com.communote.server.core.plugin.PluginPropertyManagement

@Service
 @Transactional(propagation=REQUIRED)
public class PluginPropertyManagement
extends Object

Service for accessing plugin properties.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
PluginPropertyManagement()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAllApplicationProperties(String symbolicName) Returns all application properties for the given bundle.
Map<String,String>	getAllClientProperties(String symbolicName) Returns all client properties for the given bundle.
String	getApplicationProperty(String symbolicName, String propertyKey) Returns an application property for a specific bundle.
String	getApplicationProperty(String symbolicName, String propertyKey, String defaultValue) Returns an application property for a specific bundle with default value.
String	getApplicationPropertyUncached(String symbolicName, String propertyKey) Returns an application property for a specific bundle bypassing the cache.
String	getClientProperty(String symbolicName, String propertyKey) Returns a property within the current clients scope for the given bundle.
String	getClientProperty(String symbolicName, String propertyKey, String defaultValue) Returns a property within the current clients scope for the given bundle.
<T extends Serializable> T	getClientPropertyAsObject(String symbolicName, String propertyKey, Class<T> clazz) Returns a property within the current clients scope for the given bundle.
void	init() Lazy initialization.
void	setApplicationProperty(String symbolicName, String propertyKey, String propertyValue) Sets an application property.
void	setClientProperty(String symbolicName, String propertyKey, String propertyValue) Sets a client property.
void	setClientPropertyAsObject(String symbolicName, String propertyKey, Object propertyValue) Sets a client property from an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPropertyManagement

public PluginPropertyManagement()

Method Detail

getAllApplicationProperties

public Map<String,String> getAllApplicationProperties(String symbolicName)

Returns all application properties for the given bundle.

Parameters:

symbolicName - Symbolic name of the bundle.

Returns:

A map of all properties for the bundle.

getAllClientProperties

public Map<String,String> getAllClientProperties(String symbolicName)

Returns all client properties for the given bundle.

Parameters:

symbolicName - Symbolic name of the bundle.

Returns:

A map of all properties for the bundle.

getApplicationProperty

@Transactional(readOnly=true,
               propagation=SUPPORTS)
public String getApplicationProperty(String symbolicName,
                                                                                                        String propertyKey)
                                                                                                 throws PluginPropertyManagementException

Returns an application property for a specific bundle.

Parameters:

symbolicName - Symbolic name of the bundle, the property should be read from.

propertyKey - The key of the property.

Returns:

The properties value or null, if not set.

Throws:

PluginPropertyManagementException - Exception.

getApplicationProperty

@Transactional(readOnly=true,
               propagation=SUPPORTS)
public String getApplicationProperty(String symbolicName,
                                                                                                        String propertyKey,
                                                                                                        String defaultValue)
                                                                                                 throws PluginPropertyManagementException

Returns an application property for a specific bundle with default value.

Parameters:

symbolicName - Symbolic name of the bundle.

propertyKey - The key of the property.

defaultValue - The default value.

Returns:

The value or the default value if no value is set.

Throws:

PluginPropertyManagementException - Exception.

getApplicationPropertyUncached

@Transactional(readOnly=true,
               propagation=SUPPORTS)
public String getApplicationPropertyUncached(String symbolicName,
                                                                                                                String propertyKey)
                                                                                                         throws PluginPropertyManagementException

Returns an application property for a specific bundle bypassing the cache. This is especially useful for large properties that do not need to be cached, because they are seldom used, are cached by other means (e.g. on client or as a file on the server).

Parameters:

symbolicName - Symbolic name of the bundle, the property should be read from.

propertyKey - The key of the property.

Returns:

The properties value or null, if not set.

Throws:

PluginPropertyManagementException - Exception.

getClientProperty

@Transactional(readOnly=true)
public String getClientProperty(String symbolicName,
                                                              String propertyKey)

Returns a property within the current clients scope for the given bundle.

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

Returns:

The value or null, if no value is set.

getClientProperty

@Transactional(readOnly=true)
public String getClientProperty(String symbolicName,
                                                              String propertyKey,
                                                              String defaultValue)

Returns a property within the current clients scope for the given bundle.

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

defaultValue - The default value.

Returns:

The value or the default value, if no value is set.

getClientPropertyAsObject

@Transactional(readOnly=true)
public <T extends Serializable> T getClientPropertyAsObject(String symbolicName,
                                                                                          String propertyKey,
                                                                                          Class<T> clazz)
                                                                                   throws PluginPropertyManagementException

Returns a property within the current clients scope for the given bundle. This de-serializes the property value stored as JSON.

Type Parameters:

T - Type of the value. If the type implements com.communote.server.core.common.time.LastModificationAware the last modification date of the result will be set from the last modification date of the property. The getters and setters must be ignored from JSON serialization.

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

clazz - containing the type.

Returns:

The value as object or null, if no value is set.

Throws:

PluginPropertyManagementException - Exception.

init

@PostConstruct
public void init()

Lazy initialization.

setApplicationProperty

public void setApplicationProperty(String symbolicName,
                                   String propertyKey,
                                   String propertyValue)
                            throws AuthorizationException

Sets an application property.

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

propertyValue - The value of the property.

Throws:

AuthorizationException - in case the current client is not the global client

setClientProperty

public void setClientProperty(String symbolicName,
                              String propertyKey,
                              String propertyValue)

Sets a client property.

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

propertyValue - The value. Set this to "null" to delete the property.

setClientPropertyAsObject

public void setClientPropertyAsObject(String symbolicName,
                                      String propertyKey,
                                      Object propertyValue)
                               throws PluginPropertyManagementException

Sets a client property from an object.

Internally the property value will be stored as the serialized object in JSON format in combination with the class name, for instance: com.example.Property={"count":"42"}

Parameters:

symbolicName - Symbolic name of the bundle to use.

propertyKey - The key of the property.

propertyValue - The value. Set this to "null" to delete the property.

Throws:

PluginPropertyManagementException - Exception.