com.communote.plugins.api.rest.v30.resource.topic.role

Class RoleResourceHelper

java.lang.Object

com.communote.plugins.api.rest.v30.resource.topic.role.RoleResourceHelper

public final class RoleResourceHelper
extends Object

Author:

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

Method Summary

Modifier and Type	Method and Description
static void	assignOrRemoveRoleForEntity(Long topicId, BlogRole role, Long entityId) Remove or assign role for entity
static void	assignOrRemoveRoleForGroup(String groupAlias, Long blogId, BlogRole role) Assign or remove role for a group
static void	assignOrRemoveRoleForUser(String userAlias, Long blogId, BlogRole role) Assign or remove role for a user
static void	assignRoleResources(RoleResource[] roleResources, Long topicId) Assign role resources.
static BlogRole	getBlogRole(ERole eRole) Get topic role
static ERole	getERole(BlogRole role) Convert blog role to rest api resource role

Methods inherited from class java.lang.Object

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

Method Detail

assignOrRemoveRoleForEntity

public static void assignOrRemoveRoleForEntity(Long topicId,
                                               BlogRole role,
                                               Long entityId)
                                        throws NoBlogManagerLeftException,
                                               BlogNotFoundException,
                                               CommunoteEntityNotFoundException,
                                               AuthorizationException

Remove or assign role for entity

Parameters:

topicId - identifier of a blog

role - role of the blog

entityId - identifier of an entity (user/group)

Throws:

NoBlogManagerLeftException - no active user with managment rights

BlogNotFoundException - blog not found

CommunoteEntityNotFoundException - can not found entity (user/group)

AuthorizationException - in case the the current user tries to become manager of a topic but is not the client manager

assignOrRemoveRoleForGroup

public static void assignOrRemoveRoleForGroup(String groupAlias,
                                              Long blogId,
                                              BlogRole role)
                                       throws NoBlogManagerLeftException,
                                              BlogNotFoundException,
                                              CommunoteEntityNotFoundException,
                                              AuthorizationException

Assign or remove role for a group

Parameters:

groupAlias - alias of group

blogId - identifier of the blog

role - role of the blog

Throws:

NoBlogManagerLeftException - no active user with managment rights

BlogNotFoundException - blog not found

CommunoteEntityNotFoundException - can not found entity (user/group)

AuthorizationException - should not occur

assignOrRemoveRoleForUser

public static void assignOrRemoveRoleForUser(String userAlias,
                                             Long blogId,
                                             BlogRole role)
                                      throws NoBlogManagerLeftException,
                                             BlogNotFoundException,
                                             CommunoteEntityNotFoundException,
                                             AuthorizationException

Assign or remove role for a user

Parameters:

userAlias - alias of user

blogId - identifier of the blog

role - role of the blog

Throws:

NoBlogManagerLeftException - no active user with managment rights

BlogNotFoundException - blog not found

CommunoteEntityNotFoundException - can not found entity (user/group)

AuthorizationException - in case the the current user tries to become manager of a topic but is not the client manager

assignRoleResources

public static void assignRoleResources(RoleResource[] roleResources,
                                       Long topicId)
                                throws BlogNotFoundException,
                                       CommunoteEntityNotFoundException,
                                       NoBlogManagerLeftException,
                                       AuthorizationException

Assign role resources.

Parameters:

roleResources - the external object resources.

topicId - the identifier of the topic.

Throws:

NoBlogManagerLeftException - cannot add role because no topic manager exists after create of topic

CommunoteEntityNotFoundException - can not found entity (user or group)

BlogNotFoundException - can not found topic

AuthorizationException - in case the the current user tries to become manager of a topic but is not the client manager

getBlogRole

public static BlogRole getBlogRole(ERole eRole)

Get topic role

Parameters:

eRole - role of entity

Returns:

topic role

getERole

public static ERole getERole(BlogRole role)

Convert blog role to rest api resource role

Parameters:

role - blog role of entity

Returns:

role resource enum role