com.communote.server.core.property

Class UserNotePropertyAccessor

java.lang.Object

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

com.communote.server.core.property.StringPropertyAccessor<Note,UserNoteProperty>

com.communote.server.core.property.UserNotePropertyAccessor

public class UserNotePropertyAccessor
extends StringPropertyAccessor<Note,UserNoteProperty>

Property accessor for users, don't construct it, use it from the PropertyManagement

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserNotePropertyAccessor(EventDispatcher eventDispatcher) Don't construct it from the outside packages.

Method Summary

Modifier and Type	Method and Description
protected void	assertReadAccess(Note note) Checks, that the current user is allowed to read the topic the note is in.
protected void	assertWriteAccess(Note note) Method to assert, that the current user has write access to the given object.
protected Long	getObjectId(Note object)
PropertyType	getPropertyType()
<T> Collection<T>	getUsersOfProperty(Long noteId, String keyGroup, String key, String value, Converter<User,T> converter) Return the users that a given property for a note.
protected UserNoteProperty	handleCreateNewProperty(Note note) Create a new property and associate it with the object
protected Set<StringPropertyTO>	handleGetAllObjectProperties(Note note) Get all properties of the object.
protected UserNoteProperty	handleGetObjectPropertyUnfiltered(Note note, String keyGroup, String propertyKey) Get an object property for the given group and key
protected void	handleRemoveObjectProperty(Note note, String keyGroup, String key) Removes the property of an object
boolean	hasProperty(Long noteId, String keyGroup, String key, String value) Test whether the current user has a given property for a note
protected Note	load(Long id)
protected void	setPropertyValue(UserNoteProperty property, String value)

Methods inherited from class com.communote.server.core.property.StringPropertyAccessor

getAllObjectProperties, setObjectProperties

Methods inherited from class com.communote.server.core.property.PropertyAccessor

addToFilterDefinition, assertLoadObject, assertValidForCreateAndUpdate, getFilterDefintion, getGlobalObjectProperty, getObjectProperty, getObjectPropertyUnfiltered, handleSetObjectProperty, handleSetObjectPropertyUnfiltered, removeFromFilterDefinition, removeObjectProperty, setGlobalObjectProperty, setObjectProperty, setObjectPropertyUnfiltered

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotePropertyAccessor

protected UserNotePropertyAccessor(EventDispatcher eventDispatcher)

Don't construct it from the outside packages.

Parameters:

eventDispatcher - the event dispatcher to use for firing events

Method Detail

assertReadAccess

protected void assertReadAccess(Note note)
                         throws AuthorizationException

Checks, that the current user is allowed to read the topic the note is in. Asserts valid read access for the given object.

Specified by:

assertReadAccess in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

note - The object.

Throws:

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

assertWriteAccess

protected void assertWriteAccess(Note note)
                          throws AuthorizationException

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

Does it by calling assertReadAccess(Note).

Specified by:

assertWriteAccess in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

note - The object to assert write access for.

Throws:

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

getObjectId

protected Long getObjectId(Note object)

Specified by:

getObjectId in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

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

Returns:

the id of this object

getPropertyType

public PropertyType getPropertyType()

Specified by:

getPropertyType in class PropertyAccessor<Note,UserNoteProperty,String>

Returns:

the property type this accessor is handling

getUsersOfProperty

public <T> Collection<T> getUsersOfProperty(Long noteId,
                                            String keyGroup,
                                            String key,
                                            String value,
                                            Converter<User,T> converter)
                                     throws NotFoundException,
                                            AuthorizationException

Return the users that a given property for a note. The found users are converted into the target type of the provided converter. Deleted users won't be included.

Type Parameters:

T - the target type of the conversion

Parameters:

noteId - the ID of the note for which the users that have the property should be returned

keyGroup - the group key of the searched property

key - the group of the searched property

value - the value of the searched property

converter - the converter to convert the found users

Returns:

the found users or an empty list

Throws:

NotFoundException - in case the note does not exist

AuthorizationException - in case the current user is not allowed to read the property

handleCreateNewProperty

protected UserNoteProperty handleCreateNewProperty(Note note)

Create a new property and associate it with the object

Specified by:

handleCreateNewProperty in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

note - the object to add a new property to

Returns:

the property created

handleGetAllObjectProperties

protected Set<StringPropertyTO> handleGetAllObjectProperties(Note note)
                                                      throws AuthorizationException

Description copied from class: StringPropertyAccessor

Get all properties of the object. The result set will be filtered by the filter definition of the accessor

Overrides:

handleGetAllObjectProperties in class StringPropertyAccessor<Note,UserNoteProperty>

Parameters:

note - the object

Returns:

the properties

Throws:

AuthorizationException - in case the user is not allowed to access the properties of the object

handleGetObjectPropertyUnfiltered

protected UserNoteProperty handleGetObjectPropertyUnfiltered(Note note,
                                                             String keyGroup,
                                                             String propertyKey)
                                                      throws AuthorizationException

Description copied from class: PropertyAccessor

Get an object property for the given group and key

Specified by:

handleGetObjectPropertyUnfiltered in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

note - the object to get the property of

keyGroup - the key group of the property to get

propertyKey - 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(Note note,
                                          String keyGroup,
                                          String key)
                                   throws AuthorizationException

Description copied from class: PropertyAccessor

Removes the property of an object

Overrides:

handleRemoveObjectProperty in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

note - 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.

hasProperty

public boolean hasProperty(Long noteId,
                           String keyGroup,
                           String key,
                           String value)
                    throws NotFoundException,
                           AuthorizationException

Test whether the current user has a given property for a note

Parameters:

noteId - the ID of the note for which the existence of the property should be checked

keyGroup - the group key of the searched property

key - the group of the searched property

value - the value of the searched property

Returns:

true if the user has the property otherwise false

Throws:

AuthorizationException - in case the current user is not allowed to read the property

NotFoundException - in case the note does not exist

load

protected Note load(Long id)

Specified by:

load in class PropertyAccessor<Note,UserNoteProperty,String>

Parameters:

id - the id of the object

Returns:

the loaded object or null if it does not exist

setPropertyValue

protected void setPropertyValue(UserNoteProperty property,
                                String value)

Overrides:

setPropertyValue in class StringPropertyAccessor<Note,UserNoteProperty>

Parameters:

property - The property.

value - The value.