com.communote.server.core.blog

Class BlogManagementImpl

java.lang.Object

com.communote.server.core.blog.BlogManagementBase

com.communote.server.core.blog.BlogManagementImpl

All Implemented Interfaces:

BlogManagement

@Service(value="blogManagement")
public class BlogManagementImpl
extends BlogManagementBase

Implementation of the topic management service

Author:

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

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
BlogManagementImpl()

Method Summary

Modifier and Type	Method and Description
void	createDefaultBlog(String topicName) Create a default topic if there is no such topic yet.
String	generateUniqueBlogAlias(String aliasBase, String previousAlias) Tries to find a valid blog alias that is not yet used by another blog
<T> T	getBlogByAlias(String alias, Converter<Blog,T> converter) Return the details of a blog.
Blog	getBlogById(Long blogId, boolean needTags) Retrieve a blog by its ID.
<T> T	getBlogById(Long blogId, Converter<Blog,T> converter) Return the details of a blog.
Long	getBlogId(String alias) Get the ID of a topic identified by the alias.
List<BlogData>	getLastUsedBlogs(int numberOfMaxResults, boolean sortByTitle) Retrieve a collection of the writable blogs the current user has written to.
MinimalBlogData	getMinimalBlogInfo(Long blogId) Return the minimal set of information on a blog, even if the current user is not allowed to read it.
protected Blog	handleCreateBlog(CreationBlogTO blogDetails) Performs the core logic for BlogManagementBase.createBlog(CreationBlogTO)
protected void	handleDeleteBlog(Long blogId, Long newBlogId) Performs the core logic for BlogManagementBase.deleteBlog(Long, Long)
protected void	handleDeleteBlogs(Long[] blogIds) Performs the core logic for BlogManagementBase.deleteBlogs(Long[])
protected Blog	handleFindBlogByIdentifier(String identifier) Performs the core logic for BlogManagementBase.findBlogByIdentifier(String)
protected Blog	handleFindBlogByIdentifierWithoutAuthorizationCheck(String alias) Performs the core logic for BlogManagementBase.findBlogByIdentifierWithoutAuthorizationCheck(String)
protected Blog	handleFindBlogByIdWithoutAuthorizationCheck(Long blogId) Retrieves a blog by its ID.
protected List<Blog>	handleFindBlogsById(Long[] blogIds) Performs the core logic for BlogManagementBase.findBlogsById(Long[])
protected long	handleGetBlogCount() Performs the core logic for BlogManagementBase.getBlogCount()
protected List<BlogData>	handleGetMostUsedBlogs(int numberOfMaxResults, boolean sortByTitle) Performs the core logic for BlogManagementBase.getMostUsedBlogs(int,boolean )
protected Blog	handleUpdateBlog(Long blogId, BlogTO blogTO) Performs the core logic for BlogManagementBase.updateBlog(Long, BlogTO)
void	resetGlobalPermissions() Removes "all read" and "all write" permissions from all blogs.

Methods inherited from class com.communote.server.core.blog.BlogManagementBase

createBlog, deleteBlog, deleteBlogs, findBlogByIdentifier, findBlogByIdentifierWithoutAuthorizationCheck, findBlogByIdWithoutAuthorizationCheck, findBlogsById, getBlogCount, getMostUsedBlogs, getPrincipal, updateBlog

Methods inherited from class java.lang.Object

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

Constructor Detail

BlogManagementImpl

public BlogManagementImpl()

Method Detail

createDefaultBlog

public void createDefaultBlog(String topicName)
                       throws NonUniqueBlogIdentifierException,
                              BlogIdentifierValidationException

Description copied from interface: BlogManagement

Create a default topic if there is no such topic yet.

Parameters:

topicName - the name of the topic to create

Throws:

NonUniqueBlogIdentifierException - in case the blog alias of the default blog is not unique

BlogIdentifierValidationException - in case the blog alias of the default blog is not valid

generateUniqueBlogAlias

@Transactional(readOnly=true)
public String generateUniqueBlogAlias(String aliasBase,
                                                                    String previousAlias)
                                                             throws NonUniqueBlogIdentifierException

Tries to find a valid blog alias that is not yet used by another blog

Parameters:

aliasBase - the alias value to start with. If this value is not a valid alias, it will be converted into a valid string.

previousAlias - if this alias is generated it will not be considered as a duplicate. Providing this value is especially useful when generating an alias for a blog update. Can be null.

Returns:

a proposal for the blog alias which might match the previousAlias if given

Throws:

NonUniqueBlogIdentifierException - in case no unique identifier could be generated

getBlogByAlias

@Transactional(readOnly=true)
public <T> T getBlogByAlias(String alias,
                                                          Converter<Blog,T> converter)
                                                   throws BlogAccessException

Return the details of a blog. The data of the blog will be converted with the provided converter and the resulting object will be returned. In case there is no blog for the ID null is returned. In case the current user has no access to the blog an exception will be thrown.

Type Parameters:

T - the type of the resulting object

Parameters:

alias - the alias of the topic

converter - the converter to use for creating the result object

Returns:

the blog data or null if there is no matching topic

Throws:

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

getBlogById

@Transactional(readOnly=true)
public Blog getBlogById(Long blogId,
                                                      boolean needTags)
                                               throws BlogNotFoundException,
                                                      BlogAccessException

Description copied from interface: BlogManagement

Retrieve a blog by its ID.
Usually BlogManagement.getBlogById(Long, Converter) should be used instead.

Parameters:

blogId - the ID of the blog

needTags - If true tags will also be loaded.

Returns:

the topic

Throws:

BlogNotFoundException - in case the topic does not exist

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

getBlogById

@Transactional(readOnly=true)
public <T> T getBlogById(Long blogId,
                                                       Converter<Blog,T> converter)
                                                throws BlogAccessException

Return the details of a blog. The data of the blog will be converted with the provided converter and the resulting object will be returned. In case there is no blog for the ID null is returned. In case the current user has no access to the blog an exception will be thrown.

Type Parameters:

T - the type of the resulting object

Parameters:

blogId - the ID of the blog

converter - the converter to use for creating the result object

Returns:

the blog data

Throws:

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

getBlogId

public Long getBlogId(String alias)

Description copied from interface: BlogManagement

Get the ID of a topic identified by the alias. The access to the topic is not checked.

Parameters:

alias - the alias of the topic

Returns:

the ID of the topic or null if the topic does not exist

getLastUsedBlogs

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

Retrieve a collection of the writable blogs the current user has written to. The blogs are sorted by the creation date of the notes where the blogs with the latest note are on top.

Parameters:

numberOfMaxResults - The maximal number of blogs to return

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

Returns:

the sorted blog collection

getMinimalBlogInfo

public MinimalBlogData getMinimalBlogInfo(Long blogId)

Description copied from interface: BlogManagement

Return the minimal set of information on a blog, even if the current user is not allowed to read it.

Parameters:

blogId - the ID of the topic

Returns:

the info on the topic

handleCreateBlog

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

Performs the core logic for BlogManagementBase.createBlog(CreationBlogTO)

Specified by:

handleCreateBlog in class BlogManagementBase

Throws:

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

NonUniqueBlogIdentifierException

BlogIdentifierValidationException

handleDeleteBlog

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

Performs the core logic for BlogManagementBase.deleteBlog(Long, Long)

Specified by:

handleDeleteBlog in class BlogManagementBase

Throws:

NoteManagementAuthorizationException

BlogNotFoundException

handleDeleteBlogs

protected void handleDeleteBlogs(Long[] blogIds)
                          throws AuthorizationException

Performs the core logic for BlogManagementBase.deleteBlogs(Long[])

Specified by:

handleDeleteBlogs in class BlogManagementBase

Throws:

AuthorizationException

handleFindBlogByIdentifier

protected Blog handleFindBlogByIdentifier(String identifier)
                                   throws BlogAccessException

Description copied from class: BlogManagementBase

Performs the core logic for BlogManagementBase.findBlogByIdentifier(String)

Specified by:

handleFindBlogByIdentifier in class BlogManagementBase

Throws:

BlogAccessException

handleFindBlogByIdentifierWithoutAuthorizationCheck

protected Blog handleFindBlogByIdentifierWithoutAuthorizationCheck(String alias)

Description copied from class: BlogManagementBase

Performs the core logic for BlogManagementBase.findBlogByIdentifierWithoutAuthorizationCheck(String)

Specified by:

handleFindBlogByIdentifierWithoutAuthorizationCheck in class BlogManagementBase

handleFindBlogByIdWithoutAuthorizationCheck

protected Blog handleFindBlogByIdWithoutAuthorizationCheck(Long blogId)

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

Specified by:

handleFindBlogByIdWithoutAuthorizationCheck in class BlogManagementBase

Parameters:

blogId - the ID of the blog

Returns:

the blog or null if there is no such blog

handleFindBlogsById

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

Description copied from class: BlogManagementBase

Performs the core logic for BlogManagementBase.findBlogsById(Long[])

Specified by:

handleFindBlogsById in class BlogManagementBase

handleGetBlogCount

protected long handleGetBlogCount()

Description copied from class: BlogManagementBase

Performs the core logic for BlogManagementBase.getBlogCount()

Specified by:

handleGetBlogCount in class BlogManagementBase

handleGetMostUsedBlogs

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

Performs the core logic for BlogManagementBase.getMostUsedBlogs(int,boolean )

Specified by:

handleGetMostUsedBlogs in class BlogManagementBase

handleUpdateBlog

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

Performs the core logic for BlogManagementBase.updateBlog(Long, BlogTO)

Specified by:

handleUpdateBlog in class BlogManagementBase

Parameters:

blogId - ID of the blog to update

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

resetGlobalPermissions

public void resetGlobalPermissions()

Removes "all read" and "all write" permissions from all blogs.