com.communote.server.web.fe.portal.user.client.controller

Class ClientUserManagementController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.multiaction.MultiActionController

com.communote.server.web.fe.portal.user.client.controller.ClientUserManagementController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller, org.springframework.web.servlet.mvc.LastModified

public class ClientUserManagementController
extends org.springframework.web.servlet.mvc.multiaction.MultiActionController

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_GROUP_ID parameter name for the kenmei group entity id
static String	PARAM_USER_ID parameter name for the user id
static String	PARAM_USER_ROLE parameter name for the user role

Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

DEFAULT_COMMAND_NAME, LAST_MODIFIED_METHOD_SUFFIX, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
ClientUserManagementController()

Method Summary

Modifier and Type	Method and Description
void	activateUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Activates a user.
void	assignRole(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Assigns a role to a user.
void	confirmUserDeletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles a request for confirming the user deletion.
void	deleteUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method deletes the requested user by setting its status to UserStatus.DELETED.
void	disableUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method temporarily disables the selected user.
void	removeRole(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Tries to remove a role from a user.
void	removeUserFromGroupEntity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Removes a CommunoteEntity from a KenmeiGroupEntity and sends a JSON response to the client.

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

bind, createBinder, getCommandName, getExceptionHandler, getLastModified, getMethodNameResolver, getValidators, getWebBindingInitializer, handleNoSuchRequestHandlingMethod, handleRequestInternal, initBinder, invokeNamedMethod, newCommandObject, setDelegate, setMethodNameResolver, setValidators, setWebBindingInitializer

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_USER_ID

public static final String PARAM_USER_ID

parameter name for the user id

See Also:

Constant Field Values

PARAM_GROUP_ID

public static final String PARAM_GROUP_ID

parameter name for the kenmei group entity id

See Also:

Constant Field Values

PARAM_USER_ROLE

public static final String PARAM_USER_ROLE

parameter name for the user role

See Also:

Constant Field Values

Constructor Detail

ClientUserManagementController

public ClientUserManagementController()

Method Detail

activateUser

public void activateUser(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws IOException

Activates a user.

Parameters:

request - the request

response - the response

Throws:

IOException - in case of IO error when writing response

assignRole

public void assignRole(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws IOException

Assigns a role to a user.

Parameters:

request - the http servlet request

response - the servlet response

Throws:

IOException - in case of IO error when writing response

confirmUserDeletion

public void confirmUserDeletion(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws IOException

Handles a request for confirming the user deletion.

Parameters:

request - the http servlet request

response - the servlet response

Throws:

IOException - in case an exception occurs while writing the response

deleteUser

public void deleteUser(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws IOException

This method deletes the requested user by setting its status to UserStatus.DELETED.

Parameters:

request - The request.

response - The response.

Throws:

IOException - in case of IO error when writing response

disableUser

public void disableUser(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws IOException

This method temporarily disables the selected user. In case of an error an JSON object describing the error is returned.

Parameters:

request - The request.

response - The response.

Throws:

IOException - in case an exception occurs while writing the response

removeRole

public void removeRole(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws IOException

Tries to remove a role from a user. Writes an error message as JSON object (with key 'errorMessage') to the response when the role cannot be removed.

Parameters:

request - the request

response - the response

Throws:

IOException - in case of an IO exception

removeUserFromGroupEntity

public void removeUserFromGroupEntity(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

Removes a CommunoteEntity from a KenmeiGroupEntity and sends a JSON response to the client. The response could be {"message":"my personal error text","status":"ERROR"}.

Parameters:

request - the http servlet request

response - the servlet response

Throws:

IOException - in case of a IO error