com.communote.server.core.blog

Class BlogManagementBase

java.lang.Object

com.communote.server.core.blog.BlogManagementBase

All Implemented Interfaces:

BlogManagement

Direct Known Subclasses:

BlogManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class BlogManagementBase
extends Object
implements BlogManagement

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

Author:

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

See Also:

BlogManagement

Field Summary

Fields inherited from interface com.communote.server.api.core.blog.BlogManagement

PROPERTY_KEY_PERSONAL_TOPIC_USER_ID

Constructor Summary

Constructors

Constructor and Description
BlogManagementBase()

Method Summary

Modifier and Type	Method and Description
Blog	createBlog(CreationBlogTO blogDetails) Create a new blog and set the user referenced in the transfer object as its manager.
void	deleteBlog(Long blogId, Long newBlogId) Delete a blog with all its notes
void	deleteBlogs(Long[] blogIds) Delete a selection of blogs.
Blog	findBlogByIdentifier(String identifier) Retrieve a blog by its alias.
Blog	findBlogByIdentifierWithoutAuthorizationCheck(String alias) Retrieve a blog by its alias.
Blog	findBlogByIdWithoutAuthorizationCheck(Long blogId) Retrieve a blog by its ID.
List<Blog>	findBlogsById(Long[] blogIds) Return the blogs for the given IDs.
long	getBlogCount()
List<BlogData>	getMostUsedBlogs(int numberOfMaxResults, boolean sortByTitle) Retrieve a collection of writable blogs the current user has written to.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
protected abstract Blog	handleCreateBlog(CreationBlogTO blogDetails) Performs the core logic for createBlog(CreationBlogTO)
protected abstract void	handleDeleteBlog(Long blogId, Long newBlogId) Performs the core logic for deleteBlog(Long, Long)
protected abstract void	handleDeleteBlogs(Long[] blogIds) Performs the core logic for deleteBlogs(Long[])
protected abstract Blog	handleFindBlogByIdentifier(String identifier) Performs the core logic for findBlogByIdentifier(String)
protected abstract Blog	handleFindBlogByIdentifierWithoutAuthorizationCheck(String alias) Performs the core logic for findBlogByIdentifierWithoutAuthorizationCheck(String)
protected abstract Blog	handleFindBlogByIdWithoutAuthorizationCheck(Long blogId) Retrieves a blog by its ID.
protected abstract List<Blog>	handleFindBlogsById(Long[] blogIds) Performs the core logic for findBlogsById(Long[])
protected abstract long	handleGetBlogCount() Performs the core logic for getBlogCount()
protected abstract List<BlogData>	handleGetMostUsedBlogs(int numberOfMaxResults, boolean sortByTitle) Performs the core logic for getMostUsedBlogs(int,boolean )
protected abstract Blog	handleUpdateBlog(Long blogId, BlogTO blog) Performs the core logic for updateBlog(Long, BlogTO)
Blog	updateBlog(Long blogId, BlogTO blog) Update the blog data including title, description alias, tags and properties but not access rights.

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.api.core.blog.BlogManagement

createDefaultBlog, generateUniqueBlogAlias, getBlogByAlias, getBlogById, getBlogById, getBlogId, getLastUsedBlogs, getMinimalBlogInfo, resetGlobalPermissions

Constructor Detail

BlogManagementBase

public BlogManagementBase()

Method Detail

createBlog

public Blog createBlog(CreationBlogTO blogDetails)
                throws NonUniqueBlogIdentifierException,
                       BlogIdentifierValidationException,
                       BlogNotFoundException,
                       BlogAccessException

Create a new blog and set the user referenced in the transfer object as its manager. The all-can access rights will set if the client configuration allows this.

Specified by:

createBlog in interface BlogManagement

Parameters:

blogDetails - transfer object holding the details of the blog to be created

Throws:

NonUniqueBlogIdentifierException - in case the blog alias is not unique

BlogIdentifierValidationException - in case the blog alias is not valid

BlogNotFoundException - in case the topic to be added as the parent topic does not exist

BlogAccessException - in case the current user is not manager of the topic that should be added as the parent topic

deleteBlog

public void deleteBlog(Long blogId,
                       Long newBlogId)
                throws NoteManagementAuthorizationException,
                       BlogNotFoundException

Description copied from interface: BlogManagement

Delete a blog with all its notes

Specified by:

deleteBlog in interface BlogManagement

Parameters:

blogId - The ID of the blog to delete

newBlogId - An optional ID of a blog to move the notes to before deleting the blog

Throws:

NoteManagementAuthorizationException - if the current user is not manager of the blog to delete

BlogNotFoundException - if the blog to delete does not exist

See Also:

BlogManagement.deleteBlog(Long, Long)

deleteBlogs

public void deleteBlogs(Long[] blogIds)
                 throws AuthorizationException

Description copied from interface: BlogManagement

Delete a selection of blogs. The current user must be client manager or manager of all the blogs for this operation to succeed.

Specified by:

deleteBlogs in interface BlogManagement

Parameters:

blogIds - The IDs of the blogs to delete

Throws:

AuthorizationException - if the current user is not client manager or the manager of all the blogs

See Also:

BlogManagement.deleteBlogs(Long[])

findBlogByIdentifier

@Transactional(readOnly=true)
public Blog findBlogByIdentifier(String identifier)
                                                        throws BlogAccessException

Retrieve a blog by its alias. Throws an authorization exception if the current user does not have read access to the blog.

Specified by:

findBlogByIdentifier in interface BlogManagement

Parameters:

identifier - the name identifier/alias of the blog

Returns:

the blog or null if there is no such blog

Throws:

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

findBlogByIdentifierWithoutAuthorizationCheck

@Transactional(readOnly=true)
public Blog findBlogByIdentifierWithoutAuthorizationCheck(String alias)

Retrieve a blog by its alias. It is not checked whether the current user has read access to the blog.

Specified by:

findBlogByIdentifierWithoutAuthorizationCheck in interface BlogManagement

Parameters:

alias - the name identifier/alias of the blog

Returns:

the blog or null if there is no such blog

findBlogByIdWithoutAuthorizationCheck

@Transactional(readOnly=true)
public Blog findBlogByIdWithoutAuthorizationCheck(Long blogId)

Retrieve a blog by its ID. It is not checked whether the current user has read access to the blog.

Specified by:

findBlogByIdWithoutAuthorizationCheck in interface BlogManagement

Parameters:

blogId - the ID of the blog

Returns:

the blog or null if there is no such blog

findBlogsById

@Transactional(readOnly=true)
public List<Blog> findBlogsById(Long[] blogIds)

Description copied from interface: BlogManagement

Return the blogs for the given IDs. Topics that do not exist or the user is not allowed to read will be ignored.

Specified by:

findBlogsById in interface BlogManagement

Parameters:

blogIds - the IDs of the blogs to retrieve

Returns:

the found blogs

See Also:

BlogManagement.findBlogsById(Long[])

getBlogCount

@Transactional(readOnly=true)
public long getBlogCount()

Specified by:

getBlogCount in interface BlogManagement

Returns:

the number of blogs

See Also:

BlogManagement.getBlogCount()

getMostUsedBlogs

@Transactional(readOnly=true)
public List<BlogData> getMostUsedBlogs(int numberOfMaxResults,
                                                                     boolean sortByTitle)

Description copied from interface: BlogManagement

Retrieve a collection of writable blogs the current user has written to. The collection is sorted by the number of created notes in descending order.

Specified by:

getMostUsedBlogs in interface BlogManagement

Parameters:

numberOfMaxResults - The maximal number of blogs to return

sortByTitle - If true, the result will be sorted by title.

Returns:

the collection of blogs

See Also:

BlogManagement#getMostUsedBlogs(com.communote.server.core.filter.ResultSpecification)

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

handleCreateBlog

protected abstract Blog handleCreateBlog(CreationBlogTO blogDetails)
                                  throws NonUniqueBlogIdentifierException,
                                         BlogIdentifierValidationException,
                                         BlogNotFoundException,
                                         BlogAccessException

Performs the core logic for createBlog(CreationBlogTO)

Throws:

BlogAccessException - in case the current user is not manager of the topic that should be added as the parent topic

BlogNotFoundException - in case the topic to be added as the parent topic does not exist

NonUniqueBlogIdentifierException

BlogIdentifierValidationException

handleDeleteBlog

protected abstract void handleDeleteBlog(Long blogId,
                                         Long newBlogId)
                                  throws NoteManagementAuthorizationException,
                                         BlogNotFoundException

Performs the core logic for deleteBlog(Long, Long)

Throws:

NoteManagementAuthorizationException

BlogNotFoundException

handleDeleteBlogs

protected abstract void handleDeleteBlogs(Long[] blogIds)
                                   throws AuthorizationException

Performs the core logic for deleteBlogs(Long[])

Throws:

AuthorizationException

handleFindBlogByIdentifier

protected abstract Blog handleFindBlogByIdentifier(String identifier)
                                            throws BlogAccessException

Performs the core logic for findBlogByIdentifier(String)

Throws:

BlogAccessException

handleFindBlogByIdentifierWithoutAuthorizationCheck

protected abstract Blog handleFindBlogByIdentifierWithoutAuthorizationCheck(String alias)

Performs the core logic for findBlogByIdentifierWithoutAuthorizationCheck(String)

handleFindBlogByIdWithoutAuthorizationCheck

protected abstract Blog handleFindBlogByIdWithoutAuthorizationCheck(Long blogId)

Retrieves a blog by its ID. It is not checked whether the current user has read access to the blog.

Parameters:

blogId - the ID of the blog

Returns:

the blog or null if there is no such blog

handleFindBlogsById

protected abstract List<Blog> handleFindBlogsById(Long[] blogIds)

Performs the core logic for findBlogsById(Long[])

handleGetBlogCount

protected abstract long handleGetBlogCount()

Performs the core logic for getBlogCount()

handleGetMostUsedBlogs

protected abstract List<BlogData> handleGetMostUsedBlogs(int numberOfMaxResults,
                                                         boolean sortByTitle)

Performs the core logic for getMostUsedBlogs(int,boolean )

handleUpdateBlog

protected abstract Blog handleUpdateBlog(Long blogId,
                                         BlogTO blog)
                                  throws NonUniqueBlogIdentifierException,
                                         BlogIdentifierValidationException,
                                         BlogAccessException

Performs the core logic for updateBlog(Long, BlogTO)

Parameters:

blogId - ID of the blog to update

blog - transfer object holding the details of the blog to be updated

Returns:

the updated blog

Throws:

NonUniqueBlogIdentifierException - in case the new blog alias is not unique

BlogIdentifierValidationException - in case the new blog alias is not valid

BlogAccessException - in case the current user has not the required permission to update the blog

updateBlog

public Blog updateBlog(Long blogId,
                       BlogTO blog)
                throws NonUniqueBlogIdentifierException,
                       BlogIdentifierValidationException,
                       BlogAccessException

Description copied from interface: BlogManagement

Update the blog data including title, description alias, tags and properties but not access rights. If the blog to update does not exist nothing will happen.

Specified by:

updateBlog in interface BlogManagement

Parameters:

blogId - ID of the blog to update

blog - transfer object holding the details of the blog to be updated

Returns:

the updated blog

Throws:

NonUniqueBlogIdentifierException - in case the new blog alias is not unique

BlogIdentifierValidationException - in case the new blog alias is not valid

BlogAccessException - in case the current user has not the required permission to update the blog