com.communote.server.core.external

Class ExternalObjectManagementBase

java.lang.Object

com.communote.server.core.external.ExternalObjectManagementBase

All Implemented Interfaces:

ExternalObjectManagement

Direct Known Subclasses:

ExternalObjectManagementImpl

@Transactional
public abstract class ExternalObjectManagementBase
extends Object
implements ExternalObjectManagement

Spring Service base class for ExternalObjectManagementException, provides access to all services and entities referenced by this service.

Author:

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

See Also:

ExternalObjectManagementException

Constructor Summary

Constructors

Constructor and Description
ExternalObjectManagementBase()

Method Summary

Modifier and Type	Method and Description
ExternalObject	assignExternalObject(Long blogId, ExternalObject externalObject) Assign an external object to a topic.
void	assignOrUpdateExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Assign or update a collection of external objects.
Collection<ExternalObject>	getExternalObjects(Long blogId) Return the external objects that are assigned to the given blog.
protected abstract ExternalObject	handleAssignExternalObject(Long blogId, ExternalObject externalObject) Performs the core logic for assignExternalObject(Long, ExternalObject)
protected abstract void	handleAssignOrUpdateExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Performs the core logic for assignOrUpdateExternalObjects(Long, Collection)
protected abstract Collection<ExternalObject>	handleGetExternalObjects(Long blogId) Performs the core logic for getExternalObjects(Long)
protected abstract boolean	handleIsExternalObjectAssigned(Long blogId, String externalSystemId, String externalObjectId) Check if a external object is assigned to a blog
protected abstract void	handleRemoveExternalObject(Long externalObjectId) Performs the core logic for removeExternalObject(Long)
protected abstract void	handleRemoveExternalObject(Long blogId, String externalSystemId, String externalObjectId) Performs the core logic for removeExternalObject(Long, String, String)
protected abstract void	handleRemoveExternalObjectTrusted(Long externalObjectId) Performs the core logic for removeExternalObjectTrusted(Long)
protected abstract void	handleReplaceExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Performs the core logic for replaceExternalObjects(Long, Collection)
protected abstract ExternalObject	handleUpdateExternalObject(Long blogId, ExternalObject externalObject) Performs the core logic for updateExternalObject(Long, ExternalObject)
boolean	isExternalObjectAssigned(Long blogId, String externalSystemId, String externalObjectId) Check if a external object is assigned to a blog
void	removeExternalObject(Long externalObjectId) Remove the external object with the given ID.
void	removeExternalObject(Long blogId, String externalSystemId, String externalObjectId) Remove an external object from a blog.
void	removeExternalObjectTrusted(Long externalObjectId) Remove the external object from the blog it is assigned to.
void	replaceExternalObjects(Long blogId, Collection<ExternalObject> externalObjects) Replace the external objects assigned to a blog with the provided ones.
ExternalObject	updateExternalObject(Long blogId, ExternalObject externalObject) Update an existing external object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.external.ExternalObjectManagement

getExternalObject, hasExternalObjects, registerExternalObjectSource, unregisterExternalObjectSource

Constructor Detail

ExternalObjectManagementBase

public ExternalObjectManagementBase()

Method Detail

assignExternalObject

public ExternalObject assignExternalObject(Long blogId,
                                           ExternalObject externalObject)
                                    throws BlogNotFoundException,
                                           BlogAccessException,
                                           ExternalObjectAlreadyAssignedException,
                                           TooManyExternalObjectsPerTopicException,
                                           ExternalSystemNotConfiguredException

Description copied from interface: ExternalObjectManagement

Assign an external object to a topic. If the external object is already assigned to the topic nothing will happen. If it is assigned to another topic an exception will be thrown. If it is not assigned it is created, the provided properties are added and it is assigned to the topic.

Specified by:

assignExternalObject in interface ExternalObjectManagement

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 blog 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 - in case there are already assignments for the external source and topic and the configuration does not allow more assignments

ExternalSystemNotConfiguredException - in case the externalSystemId of the external object does not belong to a registered or active external object source. A source is considered active if it provides a valid configuration.

assignOrUpdateExternalObjects

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

Description copied from interface: ExternalObjectManagement

Assign or update a collection of external objects. If one of the provided external objects is already assigned to the blog it will be updated. If it is not assigned it will be added. The update works as ExternalObjectManagement.updateExternalObject(Long, ExternalObject) and the assign like ExternalObjectManagement.assignExternalObject(Long, ExternalObject)

Specified by:

assignOrUpdateExternalObjects in interface ExternalObjectManagement

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 - in case the configuration does not allow that many assignments

ExternalSystemNotConfiguredException - in case the externalSystemId of the external object does not belong to a registered or active external object source. A source is considered active if it provides a valid configuration.

getExternalObjects

public Collection<ExternalObject> getExternalObjects(Long blogId)
                                              throws BlogNotFoundException,
                                                     BlogAccessException

Description copied from interface: ExternalObjectManagement

Return the external objects that are assigned to the given blog. The properties will not be loaded. Use the property management to get them.

Specified by:

getExternalObjects in interface ExternalObjectManagement

Parameters:

blogId - 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

handleAssignExternalObject

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

Performs the core logic for assignExternalObject(Long, ExternalObject)

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

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

handleAssignOrUpdateExternalObjects

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

Performs the core logic for assignOrUpdateExternalObjects(Long, Collection)

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

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

handleGetExternalObjects

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

Performs the core logic for getExternalObjects(Long)

Parameters:

blogId - 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 abstract boolean handleIsExternalObjectAssigned(Long blogId,
                                                          String externalSystemId,
                                                          String externalObjectId)
                                                   throws BlogAccessException,
                                                          BlogNotFoundException

Check if a external object is assigned to a blog

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:

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

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

handleRemoveExternalObject

protected abstract void handleRemoveExternalObject(Long externalObjectId)
                                            throws BlogAccessException,
                                                   NotFoundException

Performs the core logic for removeExternalObject(Long)

Parameters:

externalObjectId - the ID of the external object to remove

Throws:

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

NotFoundException - in case the external object does not exist

handleRemoveExternalObject

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

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

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 abstract void handleRemoveExternalObjectTrusted(Long externalObjectId)
                                                   throws NotFoundException,
                                                          AuthorizationException

Performs the core logic for removeExternalObjectTrusted(Long)

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 abstract void handleReplaceExternalObjects(Long blogId,
                                                     Collection<ExternalObject> externalObjects)
                                              throws BlogNotFoundException,
                                                     BlogAccessException,
                                                     ExternalObjectAlreadyAssignedException,
                                                     TooManyExternalObjectsPerTopicException,
                                                     ExternalSystemNotConfiguredException

Performs the core logic for replaceExternalObjects(Long, Collection)

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

ExternalSystemNotConfiguredException

TooManyExternalObjectsPerTopicException

handleUpdateExternalObject

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

Performs the core logic for updateExternalObject(Long, ExternalObject)

Parameters:

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

externalObject - 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

isExternalObjectAssigned

public boolean isExternalObjectAssigned(Long blogId,
                                        String externalSystemId,
                                        String externalObjectId)
                                 throws BlogNotFoundException,
                                        BlogAccessException

Description copied from interface: ExternalObjectManagement

Check if a external object is assigned to a blog

Specified by:

isExternalObjectAssigned in interface ExternalObjectManagement

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

removeExternalObject

public void removeExternalObject(Long externalObjectId)
                          throws BlogAccessException,
                                 NotFoundException

Description copied from interface: ExternalObjectManagement

Remove the external object with the given ID. If the removed external object is the last of the external system, the blog access rights added for that external system will be removed too.

Specified by:

removeExternalObject in interface ExternalObjectManagement

Parameters:

externalObjectId - the ID of the external object to remove

Throws:

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

NotFoundException - in case the external object does not exist

removeExternalObject

public void removeExternalObject(Long blogId,
                                 String externalSystemId,
                                 String externalObjectId)
                          throws BlogNotFoundException,
                                 BlogAccessException

Description copied from interface: ExternalObjectManagement

Remove an external object from a blog. If the removed external object is the last of the external system, the blog access rights added for that external system will be removed too.

Specified by:

removeExternalObject in interface ExternalObjectManagement

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

removeExternalObjectTrusted

public void removeExternalObjectTrusted(Long externalObjectId)
                                 throws NotFoundException,
                                        AuthorizationException

Description copied from interface: ExternalObjectManagement

Remove the external object from the blog it is assigned to. If the removed external object is the last of the external system, the blog access rights added for that external system will be removed too.

Similar to the 'trusted' methods of BlogRightsManagement this method requires that the current user is client manager.

Specified by:

removeExternalObjectTrusted in interface ExternalObjectManagement

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

replaceExternalObjects

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

Description copied from interface: ExternalObjectManagement

Replace the external objects assigned to a blog with the provided ones. This method works like ExternalObjectManagement.assignOrUpdateExternalObjects(Long, Collection) but additionally removes any assigned external object that is not in the provided external objects.

Specified by:

replaceExternalObjects in interface ExternalObjectManagement

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

updateExternalObject

public ExternalObject updateExternalObject(Long blogId,
                                           ExternalObject externalObject)
                                    throws BlogNotFoundException,
                                           NotFoundException,
                                           BlogAccessException,
                                           ExternalObjectAlreadyAssignedException

Description copied from interface: ExternalObjectManagement

Update an existing external object. This covers modification of the name and the properties. The properties handling is as follows: If a property key and group combination does not exist, the property is created. If the property key and group combination exists, the value is updated. In case the value is null, the property is removed.

Specified by:

updateExternalObject in interface ExternalObjectManagement

Parameters:

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

externalObject - object with details about the external object which are used to resolve the assigned object and update its data. To find the existing external object the external ID and the external system ID members are used if set otherwise the ID member is used.

Returns:

the updated external object

Throws:

BlogNotFoundException - in case the blog does not exist

NotFoundException - in case the external object does not exist

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

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