com.communote.server.core.property

Class PropertyAccessor<O extends Propertyable,P extends Property,V>

java.lang.Object

com.communote.server.core.property.PropertyAccessor<O,P,V>

Type Parameters:

O - The type that got the properties

P - The type of property

V - The type of the value the property will handle

Direct Known Subclasses:

BinaryPropertyAccessor, StringPropertyAccessor

public abstract class PropertyAccessor<O extends Propertyable,P extends Property,V>
extends Object

The Property Accessor provides means for setting and retrieving properties. The accessor implementations shouldn't be used directly. They are intended to be registered at the PropertyManagement instead.

Author:

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

Constructor Summary

Constructors

Constructor and Description
PropertyAccessor(EventDispatcher eventDispatcher)

Method Summary

Modifier and Type	Method and Description
void	addToFilterDefinition(String keyGroup, String key) Add a combination of a property key group and property key to the accessible properties.
protected O	assertLoadObject(Long id, boolean writeAccess) Load and check the existence of the object.
protected abstract void	assertReadAccess(O object) Asserts valid read access for the given object.
protected boolean	assertValidForCreateAndUpdate(String keyGroup, String key) Check that the group and key are both set and that the filters allow setting the property
protected abstract void	assertWriteAccess(O object) Method to assert, that the current user has write access to the given object.
protected PropertyAccessorFilterDefinition	getFilterDefintion()
P	getGlobalObjectProperty(Long objectId, String key) Get an global property, that is one with no key group (internal the key group will be global however).
protected abstract Long	getObjectId(O object)
P	getObjectProperty(Long objectId, String keyGroup, String key) Get an object property for the given group and key
P	getObjectPropertyUnfiltered(Long objectId, String keyGroup, String key) Get an object property for the given group and key.
abstract PropertyType	getPropertyType()
protected abstract P	handleCreateNewProperty(O object) Create a new property and associate it with the object
protected abstract P	handleGetObjectPropertyUnfiltered(O object, String keyGroup, String key) Get an object property for the given group and key
protected void	handleRemoveObjectProperty(O object, String keyGroup, String key) Removes the property of an object
protected P	handleSetObjectProperty(O object, String keyGroup, String key, V value) Adds a new, modifies or deletes an existing property.
protected P	handleSetObjectPropertyUnfiltered(O object, String keyGroup, String key, V value) Adds a new, modifies or deletes an existing property.
protected abstract O	load(Long id)
void	removeFromFilterDefinition(String keyGroup, String key) Remove a combination of a property key group and property key from the accessible properties.
void	removeObjectProperty(Long objectId, String keyGroup, String key) Removes the property of an object
P	setGlobalObjectProperty(Long objectId, String key, V value) Add a new, modify or delete an existing global property
P	setObjectProperty(Long objectId, String keyGroup, String key, V value) Add a new, modify or delete an existing property.
P	setObjectPropertyUnfiltered(Long objectId, String keyGroup, String key, V value) Adds a new, modifies or deletes an existing property.
protected abstract void	setPropertyValue(P property, V value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyAccessor

public PropertyAccessor(EventDispatcher eventDispatcher)

Parameters:

eventDispatcher - the event dispatcher for dispatching event on property changes

Method Detail

addToFilterDefinition

public void addToFilterDefinition(String keyGroup,
                                  String key)

Add a combination of a property key group and property key to the accessible properties.

Parameters:

keyGroup - the key group of the property that should be read and writable

key - the key of the property that should be read and writable

assertLoadObject

protected O assertLoadObject(Long id,
                             boolean writeAccess)
                      throws NotFoundException,
                             AuthorizationException

Load and check the existence of the object. Also checks for valid read or write access.

Parameters:

id - the ID of the object

writeAccess - true if the current user needs to have write access to the object and its properties, false if only read access is required

Returns:

the object

Throws:

NotFoundException - in case the object has not been found

AuthorizationException - in case the current user has not the requested access level to the object

assertReadAccess

protected abstract void assertReadAccess(O object)
                                  throws AuthorizationException,
                                         NotFoundException

Asserts valid read access for the given object.

Parameters:

object - The object.

Throws:

AuthorizationException - Thrown, when the read access to the object was denied.

NotFoundException

assertValidForCreateAndUpdate

protected boolean assertValidForCreateAndUpdate(String keyGroup,
                                                String key)

Check that the group and key are both set and that the filters allow setting the property

Parameters:

keyGroup - the key group of the property

key - the key of the property

Returns:

true if group and key are valid, false otherwise

assertWriteAccess

protected abstract void assertWriteAccess(O object)
                                   throws AuthorizationException,
                                          NotFoundException

Method to assert, that the current user has write access to the given object.

Parameters:

object - The object to assert write access for.

Throws:

AuthorizationException - Thrown, when the current user is not allowed to write to the given object.

NotFoundException

getFilterDefintion

protected PropertyAccessorFilterDefinition getFilterDefintion()

Returns:

the filter definition of this accessor

getGlobalObjectProperty

public final P getGlobalObjectProperty(Long objectId,
                                       String key)
                                throws NotFoundException,
                                       AuthorizationException

Get an global property, that is one with no key group (internal the key group will be global however).

Parameters:

objectId - the id of the object to get the property of

key - the key of the property

Returns:

the property or null if the property does not exists or cannot be read because of a filter definition

Throws:

NotFoundException - in case there is not object to the given id.

AuthorizationException - Thrown, when the user is not allowed to access.

getObjectId

protected abstract Long getObjectId(O object)

Parameters:

object - the object the property is / will be assigned to

Returns:

the id of this object

getObjectProperty

public final P getObjectProperty(Long objectId,
                                 String keyGroup,
                                 String key)
                          throws NotFoundException,
                                 AuthorizationException

Get an object property for the given group and key

Parameters:

objectId - the id of the object to get the property of

keyGroup - the key group of the property to get

key - the key of the property

Returns:

the property or null if no such property exists or cannot be read because of a filter definition

Throws:

NotFoundException - in case there is not object to the given id.

AuthorizationException - Thrown, when the user is not allowed to access.

getObjectPropertyUnfiltered

public final P getObjectPropertyUnfiltered(Long objectId,
                                           String keyGroup,
                                           String key)
                                    throws NotFoundException,
                                           AuthorizationException

Get an object property for the given group and key. The filter definition will not be checked.

Parameters:

objectId - the id of the object to get the property of

keyGroup - the key group of the property to get

key - the key of the property

Returns:

the property or null if no such property exists

Throws:

NotFoundException - in case there is not object to the given id.

AuthorizationException - Thrown, when the user is not allowed to access.

getPropertyType

public abstract PropertyType getPropertyType()

Returns:

the property type this accessor is handling

handleCreateNewProperty

protected abstract P handleCreateNewProperty(O object)

Create a new property and associate it with the object

Parameters:

object - the object to add a new property to

Returns:

the property created

handleGetObjectPropertyUnfiltered

protected abstract P handleGetObjectPropertyUnfiltered(O object,
                                                       String keyGroup,
                                                       String key)
                                                throws AuthorizationException

Get an object property for the given group and key

Parameters:

object - the object to get the property of

keyGroup - the key group of the property to get

key - the key of the propert no such property exists

Returns:

the property or null if no such property exists

Throws:

AuthorizationException - Thrown, when the user is not allowed to access the property.

handleRemoveObjectProperty

protected void handleRemoveObjectProperty(O object,
                                          String keyGroup,
                                          String key)
                                   throws AuthorizationException

Removes the property of an object

Parameters:

object - object to get the property of

keyGroup - the key group of the property to get

key - the key of the property

Throws:

AuthorizationException - Thrown, when the user is not allowed to access.

handleSetObjectProperty

protected final P handleSetObjectProperty(O object,
                                          String keyGroup,
                                          String key,
                                          V value)
                                   throws AuthorizationException

Adds a new, modifies or deletes an existing property.

Parameters:

object - the object for which the properties should be modified

keyGroup - the key group of the property to set

key - the key of the property

value - the value of the property, can be null to delete the property

Returns:

the changed or created property. Null will be returned if the property did not exist and the provided value was null.

Throws:

AuthorizationException - Thrown, when the user is not allowed to access the object.

handleSetObjectPropertyUnfiltered

protected P handleSetObjectPropertyUnfiltered(O object,
                                              String keyGroup,
                                              String key,
                                              V value)
                                       throws AuthorizationException

Adds a new, modifies or deletes an existing property. The filter definition will not be checked.

Parameters:

object - the object for which the properties should be modified

keyGroup - the key group of the property to set

key - the key of the property

value - the value of the property, can be null to delete the property

Returns:

the changed or created property. Null will be returned if the property did not exist and the provided value was null.

Throws:

AuthorizationException - Thrown, when the user is not allowed to access the object.

load

protected abstract O load(Long id)

Parameters:

id - the id of the object

Returns:

the loaded object or null if it does not exist

removeFromFilterDefinition

public void removeFromFilterDefinition(String keyGroup,
                                       String key)

Remove a combination of a property key group and property key from the accessible properties.

Parameters:

keyGroup - the key group of the property

key - the key of the property

removeObjectProperty

public final void removeObjectProperty(Long objectId,
                                       String keyGroup,
                                       String key)
                                throws NotFoundException,
                                       AuthorizationException

Removes the property of an object

Parameters:

objectId - the id of the object to get the property of

keyGroup - the key group of the property to get

key - the key of the property

Throws:

NotFoundException - in case there is not object to the given id.

AuthorizationException - Thrown, when the user is not allowed to access.

setGlobalObjectProperty

public final P setGlobalObjectProperty(Long objectId,
                                       String key,
                                       V value)
                                throws NotFoundException,
                                       AuthorizationException

Add a new, modify or delete an existing global property

Parameters:

objectId - the object to set the property on

key - the key of the property

value - the value of the property

Returns:

the changed or created property. Null will be returned if the property did not exist and the provided value was null.

Throws:

NotFoundException - in case there is not object to the given id.

AuthorizationException - Thrown, when the user is not allowed to access.

setObjectProperty

public final P setObjectProperty(Long objectId,
                                 String keyGroup,
                                 String key,
                                 V value)
                          throws NotFoundException,
                                 AuthorizationException

Add a new, modify or delete an existing property. If the key group and key refer to a property that is not in the filter definition the property won't be stored.

Parameters:

objectId - the id of the object for which the properties should be modified

keyGroup - the key group of the property to set

key - the key of the property

value - the value of the property, can be null to delete the property

Returns:

the changed or created property. Null will be returned if the property did not exist and the provided value was null.

Throws:

NotFoundException - in case there is no object for the given ID

AuthorizationException - Thrown, when the user is not allowed to modify the object.

setObjectPropertyUnfiltered

public final P setObjectPropertyUnfiltered(Long objectId,
                                           String keyGroup,
                                           String key,
                                           V value)
                                    throws NotFoundException,
                                           AuthorizationException

Adds a new, modifies or deletes an existing property. The filter definition will not be checked.

Parameters:

objectId - the id of the object for which the properties should be modified

keyGroup - the key group of the property to set

key - the key of the property

value - the value of the property, can be null to delete the property

Returns:

the changed or created property. Null will be returned if the property did not exist and the provided value was null.

Throws:

NotFoundException - in case there is no object for the given ID

AuthorizationException - Thrown, when the user is not allowed to modify the object.

setPropertyValue

protected abstract void setPropertyValue(P property,
                                         V value)

Parameters:

property - The property.

value - The value.