com.communote.server.api.core.blog

Interface BlogManagement

All Known Implementing Classes:

BlogManagementBase, BlogManagementImpl

public interface BlogManagement

Service for retrieving, creating, updating and removing blogs/topics.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_KEY_PERSONAL_TOPIC_USER_ID Key of the property which marks a topic as the personal topic of a user.

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	createDefaultBlog(String blogName) Create a default topic if there is no such topic yet.
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.
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 topicId, boolean needTags) Retrieve a blog by its ID.
<T> T	getBlogById(Long blogId, Converter<Blog,T> converter) Return the details of a blog.
long	getBlogCount()
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.
List<BlogData>	getMostUsedBlogs(int numberOfMaxResults, boolean sortByTitle) Retrieve a collection of writable blogs the current user has written to.
void	resetGlobalPermissions() Removes "all read" and "all write" permissions from all blogs.
Blog	updateBlog(Long blogId, BlogTO blogDetails) Update the blog data including title, description alias, tags and properties but not access rights.

Field Detail

PROPERTY_KEY_PERSONAL_TOPIC_USER_ID

static final String PROPERTY_KEY_PERSONAL_TOPIC_USER_ID

Key of the property which marks a topic as the personal topic of a user. The property value holds the ID of the user/owner of the personal topic.

See Also:

Constant Field Values

Method Detail

createBlog

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.

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

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

createDefaultBlog

void createDefaultBlog(String blogName)
                throws NonUniqueBlogIdentifierException,
                       BlogIdentifierValidationException

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

Parameters:

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

deleteBlog

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

Delete a blog with all its notes

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:

BlogNotFoundException - if the blog to delete does not exist

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

deleteBlogs

void deleteBlogs(Long[] blogIds)
          throws AuthorizationException

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

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

findBlogByIdentifier

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.

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

Blog findBlogByIdentifierWithoutAuthorizationCheck(String alias)

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

Parameters:

alias - the name identifier/alias of the blog

Returns:

the blog or null if there is no such blog

findBlogByIdWithoutAuthorizationCheck

Blog findBlogByIdWithoutAuthorizationCheck(Long blogId)

Retrieve 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

findBlogsById

List<Blog> findBlogsById(Long[] blogIds)

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

Parameters:

blogIds - the IDs of the blogs to retrieve

Returns:

the found blogs

generateUniqueBlogAlias

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

<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

Blog getBlogById(Long topicId,
                 boolean needTags)
          throws BlogNotFoundException,
                 BlogAccessException

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

Parameters:

topicId - the ID of the blog

needTags - If true tags will also be loaded.

Returns:

the topic

Throws:

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

BlogNotFoundException - in case the topic does not exist

getBlogById

<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

getBlogCount

long getBlogCount()

Returns:

the number of blogs

getBlogId

Long getBlogId(String alias)

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

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

MinimalBlogData getMinimalBlogInfo(Long blogId)

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

getMostUsedBlogs

List<BlogData> getMostUsedBlogs(int numberOfMaxResults,
                                boolean sortByTitle)

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.

Parameters:

numberOfMaxResults - The maximal number of blogs to return

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

Returns:

the collection of blogs

resetGlobalPermissions

void resetGlobalPermissions()

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

updateBlog

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

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.

Parameters:

blogId - ID of the blog to update

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