com.communote.plugins.core.services.impl

Class PluginPropertyServiceImpl

java.lang.Object

com.communote.plugins.core.services.impl.PluginPropertyServiceImpl

All Implemented Interfaces:

PluginPropertyService

public class PluginPropertyServiceImpl
extends Object
implements PluginPropertyService

Implementation of PluginPropertyService

Author:

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

Constructor Summary

Constructors

Constructor and Description
PluginPropertyServiceImpl(String symbolicName) Constructor.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAllApplicationProperties() Returns all application properties for this bundle.
Map<String,String>	getAllApplicationProperties(String symbolicName) Returns all application properties for the given bundle.
Map<String,String>	getAllClientProperties() Returns all client properties for this bundle.
Map<String,String>	getAllClientProperties(String symbolicName) Returns all client properties for the given bundle.
String	getApplicationProperty(String key) Returns an application property for this bundle.
String	getApplicationProperty(String symbolicName, String key) Returns an application property for a specific bundle.
String	getApplicationPropertyWithDefault(String key, String defaultValue) Returns an application property for this bundle.
String	getApplicationPropertyWithDefault(String symbolicName, String key, String defaultValue) Returns an application property for a specific bundle with default value.
String	getClientProperty(String key) Returns a property within the current clients scope.
String	getClientProperty(String symbolicName, String key) Returns a property within the current clients scope for the given bundle.
<T extends Serializable> T	getClientPropertyAsObject(String key, Class<T> clazz) Returns an instance of the given object.
<T extends Serializable> T	getClientPropertyAsObject(String symbolicName, String key, Class<T> clazz) Returns a property within the current clients scope for the given bundle.
String	getClientPropertyWithDefault(String key, String defaultValue) * Returns a property within the current clients scope.
String	getClientPropertyWithDefault(String symbolicName, String key, String defaultValue) Returns a property within the current clients scope for the given bundle.
void	setApplicationProperty(String key, String value) Sets an application property.
void	setClientProperty(String key, String value) Sets a client property.
void	setClientPropertyAsObject(String key, Serializable value) 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

PluginPropertyServiceImpl

public PluginPropertyServiceImpl(String symbolicName)

Constructor.

Parameters:

symbolicName - Symbolic name for the concrete service.

Method Detail

getAllApplicationProperties

public Map<String,String> getAllApplicationProperties()

Returns all application properties for this bundle.

Specified by:

getAllApplicationProperties in interface PluginPropertyService

Returns:

A map of all properties for the bundle.

getAllApplicationProperties

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

Returns all application properties for the given bundle.

Specified by:

getAllApplicationProperties in interface PluginPropertyService

Parameters:

symbolicName - Symbolic name of the bundle.

Returns:

A map of all properties for the bundle.

getAllClientProperties

public Map<String,String> getAllClientProperties()

Returns all client properties for this bundle.

Specified by:

getAllClientProperties in interface PluginPropertyService

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.

Specified by:

getAllClientProperties in interface PluginPropertyService

Parameters:

symbolicName - Symbolic name of the bundle.

Returns:

A map of all properties for the bundle.

getApplicationProperty

public String getApplicationProperty(String key)
                              throws PluginPropertyServiceException

Description copied from interface: PluginPropertyService

Returns an application property for this bundle.

Specified by:

getApplicationProperty in interface PluginPropertyService

Parameters:

key - The key of the property.

Returns:

The properties value or null, if not set.

Throws:

PluginPropertyServiceException - Exception.

getApplicationProperty

public String getApplicationProperty(String symbolicName,
                                     String key)
                              throws PluginPropertyServiceException

Returns an application property for a specific bundle.

Specified by:

getApplicationProperty in interface PluginPropertyService

Parameters:

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

key - The key of the property.

Returns:

The properties value or null, if not set.

Throws:

PluginPropertyServiceException

getApplicationPropertyWithDefault

public String getApplicationPropertyWithDefault(String key,
                                                String defaultValue)
                                         throws PluginPropertyServiceException

Returns an application property for this bundle.

Specified by:

getApplicationPropertyWithDefault in interface PluginPropertyService

Parameters:

key - The key of the property.

defaultValue - The default value.

Returns:

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

Throws:

PluginPropertyServiceException

getApplicationPropertyWithDefault

public String getApplicationPropertyWithDefault(String symbolicName,
                                                String key,
                                                String defaultValue)
                                         throws PluginPropertyServiceException

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

Specified by:

getApplicationPropertyWithDefault in interface PluginPropertyService

Parameters:

symbolicName - Symbolic name of the bundle.

key - The key of the property.

defaultValue - The default value.

Returns:

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

Throws:

PluginPropertyServiceException - Exception.

getClientProperty

public String getClientProperty(String key)

Returns a property within the current clients scope.

Specified by:

getClientProperty in interface PluginPropertyService

Parameters:

key - The key of the property.

Returns:

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

getClientProperty

public String getClientProperty(String symbolicName,
                                String key)

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

Specified by:

getClientProperty in interface PluginPropertyService

Parameters:

symbolicName - Symbolic name of the bundle to use.

key - The key of the property.

Returns:

The value or null, if no value is set.

getClientPropertyAsObject

public <T extends Serializable> T getClientPropertyAsObject(String key,
                                                            Class<T> clazz)
                                                     throws PluginPropertyServiceException

Returns an instance of the given object.

Specified by:

getClientPropertyAsObject in interface PluginPropertyService

Type Parameters:

T - Type of the value.

Parameters:

key - The key of the property.

clazz - Class containing the result type.

Returns:

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

Throws:

PluginPropertyServiceException - Exception.

getClientPropertyAsObject

public <T extends Serializable> T getClientPropertyAsObject(String symbolicName,
                                                            String key,
                                                            Class<T> clazz)
                                                     throws PluginPropertyServiceException

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

Specified by:

getClientPropertyAsObject in interface PluginPropertyService

Type Parameters:

T - Type of the value.

Parameters:

symbolicName - Symbolic name of the bundle to use.

key - The key of the property.

clazz - Class containing the result type.

Returns:

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

Throws:

PluginPropertyServiceException - Exception..

getClientPropertyWithDefault

public String getClientPropertyWithDefault(String key,
                                           String defaultValue)

* Returns a property within the current clients scope.

Specified by:

getClientPropertyWithDefault in interface PluginPropertyService

Parameters:

key - The key of the property.

defaultValue - The default value.

Returns:

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

getClientPropertyWithDefault

public String getClientPropertyWithDefault(String symbolicName,
                                           String key,
                                           String defaultValue)

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

Specified by:

getClientPropertyWithDefault in interface PluginPropertyService

Parameters:

symbolicName - Symbolic name of the bundle to use.

key - The key of the property.

defaultValue - The default value.

Returns:

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

setApplicationProperty

public void setApplicationProperty(String key,
                                   String value)
                            throws AuthorizationException

Description copied from interface: PluginPropertyService

Sets an application property.

Specified by:

setApplicationProperty in interface PluginPropertyService

Parameters:

key - The key of the property.

value - The value of the property.

Throws:

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

setClientProperty

public void setClientProperty(String key,
                              String value)

Sets a client property.

Specified by:

setClientProperty in interface PluginPropertyService

Parameters:

key - The key of the property.

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

setClientPropertyAsObject

public void setClientPropertyAsObject(String key,
                                      Serializable value)
                               throws PluginPropertyServiceException

Sets a client property from an object.

Specified by:

setClientPropertyAsObject in interface PluginPropertyService

Parameters:

key - The key of the property.

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

Throws:

PluginPropertyServiceException - Exception.