com.communote.server.core.external

Class ExternalObjectManagementImpl

java.lang.Object

com.communote.server.core.external.ExternalObjectManagementBase

com.communote.server.core.external.ExternalObjectManagementImpl

All Implemented Interfaces:

ExternalObjectManagement

@Service(value="externalObjectManagement")
public class ExternalObjectManagementImpl
extends ExternalObjectManagementBase

Author:

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

Constructor Summary

Constructors

Constructor and Description
ExternalObjectManagementImpl()

Method Summary

Modifier and Type	Method and Description
<T> T	getExternalObject(Long topicId, Long externalObjectId, Converter<Pair<Blog,ExternalObject>,T> converter) Get an external object which is identified by the given ID and is assigned to the given topic.
protected ExternalObject	handleAssignExternalObject(Long blogId, ExternalObject externalObject) Performs the core logic for ExternalObjectManagementBase.assignExternalObject(Long, ExternalObject)
protected void	handleAssignOrUpdateExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Performs the core logic for ExternalObjectManagementBase.assignOrUpdateExternalObjects(Long, Collection)
protected Collection<ExternalObject>	handleGetExternalObjects(Long topicId) Performs the core logic for ExternalObjectManagementBase.getExternalObjects(Long)
protected boolean	handleIsExternalObjectAssigned(Long blogId, String externalSystemId, String externalObjectId) Check if a external object is assigned to a blog
protected void	handleRemoveExternalObject(Long externalObjectId) Performs the core logic for ExternalObjectManagementBase.removeExternalObject(Long)
protected void	handleRemoveExternalObject(Long blogId, String externalSystemId, String externalObjectId) Performs the core logic for ExternalObjectManagementBase.removeExternalObject(Long, String, String)
protected void	handleRemoveExternalObjectTrusted(Long externalObjectId) Performs the core logic for ExternalObjectManagementBase.removeExternalObjectTrusted(Long)
protected void	handleReplaceExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Performs the core logic for ExternalObjectManagementBase.replaceExternalObjects(Long, Collection)
protected ExternalObject	handleUpdateExternalObject(Long blogId, ExternalObject newExternalObject) Performs the core logic for ExternalObjectManagementBase.updateExternalObject(Long, ExternalObject)
boolean	hasExternalObjects(Long blogId) Return whether a given blog has external objects.
void	registerExternalObjectSource(ExternalObjectSource source) Register an external object source.
void	unregisterExternalObjectSource(ExternalObjectSource source) Remove an external object source that was registered with ExternalObjectManagement.registerExternalObjectSource(ExternalObjectSource).

Methods inherited from class com.communote.server.core.external.ExternalObjectManagementBase

assignExternalObject, assignOrUpdateExternalObjects, getExternalObjects, isExternalObjectAssigned, removeExternalObject, removeExternalObject, removeExternalObjectTrusted, replaceExternalObjects, updateExternalObject

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalObjectManagementImpl

public ExternalObjectManagementImpl()

Method Detail

getExternalObject

public <T> T getExternalObject(Long topicId,
                               Long externalObjectId,
                               Converter<Pair<Blog,ExternalObject>,T> converter)
                        throws BlogAccessException,
                               BlogNotFoundException

Description copied from interface: ExternalObjectManagement

Get an external object which is identified by the given ID and is assigned to the given topic.

Parameters:

topicId - the ID of the topic

externalObjectId - the internal ID of the external object

converter - the converter to transform the external object in the result object

Returns:

the converted result or null if the external object does not exist

Throws:

BlogAccessException - in case the current user has no access to the given topic

BlogNotFoundException - in case the topic does not exist

handleAssignExternalObject

protected ExternalObject handleAssignExternalObject(Long blogId,
                                                    ExternalObject externalObject)
                                             throws BlogNotFoundException,
                                                    BlogAccessException,
                                                    ExternalObjectAlreadyAssignedException,
                                                    TooManyExternalObjectsPerTopicException,
                                                    ExternalSystemNotConfiguredException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.assignExternalObject(Long, ExternalObject)

Specified by:

handleAssignExternalObject in class ExternalObjectManagementBase

Parameters:

blogId - the ID of the blog to assign the external object to

externalObject - object describing the external object to assign

Returns:

the assigned external object

Throws:

BlogNotFoundException - in case the topic was not found

BlogAccessException - in case the user is not a manager of the blog

ExternalObjectAlreadyAssignedException - in case the external object is assigned to another blog than the provided one

TooManyExternalObjectsPerTopicException

ExternalSystemNotConfiguredException

handleAssignOrUpdateExternalObjects

protected void handleAssignOrUpdateExternalObjects(Long blogId,
                                                   Collection<ExternalObject> externalObjects)
                                            throws BlogNotFoundException,
                                                   BlogAccessException,
                                                   ExternalObjectAlreadyAssignedException,
                                                   TooManyExternalObjectsPerTopicException,
                                                   ExternalSystemNotConfiguredException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.assignOrUpdateExternalObjects(Long, Collection)

Specified by:

handleAssignOrUpdateExternalObjects in class ExternalObjectManagementBase

Parameters:

blogId - the ID of the blog to assign the external objects to

externalObjects - objects describing the external objects to assign or update. To find an existing external object the external ID and the external system ID members are used if set otherwise the ID member is used.

Throws:

BlogNotFoundException - in case the blog was not found

BlogAccessException - in case the user is not a manager of the blog

ExternalObjectAlreadyAssignedException - in case one of the external objects is assigned to another blog than the provided one

TooManyExternalObjectsPerTopicException

ExternalSystemNotConfiguredException

handleGetExternalObjects

protected Collection<ExternalObject> handleGetExternalObjects(Long topicId)
                                                       throws BlogNotFoundException,
                                                              BlogAccessException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.getExternalObjects(Long)

Specified by:

handleGetExternalObjects in class ExternalObjectManagementBase

Parameters:

topicId - the ID of the blog

Returns:

the external objects of the topic. The collection will be empty if the blog has no external objects.

Throws:

BlogNotFoundException - in case the blog does not exist

BlogAccessException - in case the current user has no read access to the blog

handleIsExternalObjectAssigned

protected boolean handleIsExternalObjectAssigned(Long blogId,
                                                 String externalSystemId,
                                                 String externalObjectId)
                                          throws BlogNotFoundException,
                                                 BlogAccessException

Description copied from class: ExternalObjectManagementBase

Check if a external object is assigned to a blog

Specified by:

handleIsExternalObjectAssigned in class ExternalObjectManagementBase

Parameters:

blogId - the ID of the blog the external object is checked for beeing assigned to

externalSystemId - the ID of the external system

externalObjectId - the ID that identifies the external object within the external system

Returns:

true if the object is assigned, false otherwise

Throws:

BlogNotFoundException - in case there is no blog for the given ID

BlogAccessException - in case the current user has no read access to the blog

handleRemoveExternalObject

protected void handleRemoveExternalObject(Long externalObjectId)
                                   throws NotFoundException,
                                          BlogAccessException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.removeExternalObject(Long)

Specified by:

handleRemoveExternalObject in class ExternalObjectManagementBase

Parameters:

externalObjectId - the ID of the external object to remove

Throws:

NotFoundException - in case the external object does not exist

BlogAccessException - in case the current user is not manager of the blog

handleRemoveExternalObject

protected void handleRemoveExternalObject(Long blogId,
                                          String externalSystemId,
                                          String externalObjectId)
                                   throws BlogNotFoundException,
                                          BlogAccessException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.removeExternalObject(Long, String, String)

Specified by:

handleRemoveExternalObject in class ExternalObjectManagementBase

Parameters:

blogId - ID of the blog

externalSystemId - identifier of the external system

externalObjectId - identifier of the external object in the external system

Throws:

BlogNotFoundException - in case the blog does not exist

BlogAccessException - in case the current user is not manager of the blog

handleRemoveExternalObjectTrusted

protected void handleRemoveExternalObjectTrusted(Long externalObjectId)
                                          throws NotFoundException,
                                                 AuthorizationException

Performs the core logic for ExternalObjectManagementBase.removeExternalObjectTrusted(Long)

Specified by:

handleRemoveExternalObjectTrusted in class ExternalObjectManagementBase

Parameters:

externalObjectId - ID of the external object *

Throws:

NotFoundException - in case the external object does not exist

AuthorizationException - in case the current user is not client manager

handleReplaceExternalObjects

protected void handleReplaceExternalObjects(Long blogId,
                                            Collection<ExternalObject> externalObjects)
                                     throws BlogNotFoundException,
                                            BlogAccessException,
                                            ExternalObjectAlreadyAssignedException,
                                            TooManyExternalObjectsPerTopicException,
                                            ExternalSystemNotConfiguredException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.replaceExternalObjects(Long, Collection)

Specified by:

handleReplaceExternalObjects in class ExternalObjectManagementBase

Parameters:

blogId - the ID of the blog whose external objects should be replaced

externalObjects - the new external objects to replace the existing with

Throws:

BlogNotFoundException - in case the blog does not exist

BlogAccessException - in case the current user is not manager of the blog

ExternalObjectAlreadyAssignedException - in case one of the external objects is assigned to another blog than the provided one

TooManyExternalObjectsPerTopicException

ExternalSystemNotConfiguredException

handleUpdateExternalObject

protected ExternalObject handleUpdateExternalObject(Long blogId,
                                                    ExternalObject newExternalObject)
                                             throws BlogNotFoundException,
                                                    BlogAccessException,
                                                    NotFoundException,
                                                    ExternalObjectAlreadyAssignedException

Description copied from class: ExternalObjectManagementBase

Performs the core logic for ExternalObjectManagementBase.updateExternalObject(Long, ExternalObject)

Specified by:

handleUpdateExternalObject in class ExternalObjectManagementBase

Parameters:

blogId - the ID of the blog the external object is assigned to

newExternalObject - object with details about the external object which are used to resolve the assigned object and update its data

Returns:

the updated external object

Throws:

BlogNotFoundException - in case the blog does not exist

BlogAccessException - in case the current user is not manager of the blog

NotFoundException - in case the external object does not exist

ExternalObjectAlreadyAssignedException - in case the external object is already assigned to another blog than the provided one

hasExternalObjects

@Transactional(readOnly=true)
public boolean hasExternalObjects(Long blogId)
                                                         throws BlogNotFoundException,
                                                                BlogAccessException

Description copied from interface: ExternalObjectManagement

Return whether a given blog has external objects.

Parameters:

blogId - the ID of the blog

Returns:

true if there is at least one external object, false otherwise

Throws:

BlogNotFoundException - in case the blog does not exist

BlogAccessException - in case the current user has no read access to the blog

registerExternalObjectSource

@Transactional(propagation=NEVER)
public void registerExternalObjectSource(ExternalObjectSource source)
                                                                    throws ExternalObjectSourceAlreadyExistsException

Description copied from interface: ExternalObjectManagement

Register an external object source. After registering a source external objects with the ID of the source can be linked to topics.

Parameters:

source - the source to register

Throws:

ExternalObjectSourceAlreadyExistsException - in case there is already a source with the same ID

unregisterExternalObjectSource

@Transactional(propagation=NEVER)
public void unregisterExternalObjectSource(ExternalObjectSource source)

Description copied from interface: ExternalObjectManagement

Remove an external object source that was registered with ExternalObjectManagement.registerExternalObjectSource(ExternalObjectSource). If the source was not registered the call is ignored

Parameters:

source - the source to remove