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

Class SecurityCodeConfirmationHandler

java.lang.Object

com.communote.server.web.fe.portal.controller.SecurityCodeConfirmationHandler

public abstract class SecurityCodeConfirmationHandler
extends Object

Handler for confirming a specific security code.

Author:

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

Constructor Summary

Constructors

Constructor and Description
SecurityCodeConfirmationHandler(SecurityCodeAction action) Create a new handler for the given action

Method Summary

Modifier and Type	Method and Description
abstract SecurityCodeConfirmationResult	confirm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SecurityCode code) Confirm the code.
SecurityCodeAction	getAction()
LocalizedMessage	getWarningForMissingCode(javax.servlet.http.HttpServletRequest request, String code) Return a message that should be shown as warning to the user if the action of this handler was provided but the code did not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityCodeConfirmationHandler

public SecurityCodeConfirmationHandler(SecurityCodeAction action)

Create a new handler for the given action

Parameters:

action - the action of the security code this handler can handle

Method Detail

confirm

public abstract SecurityCodeConfirmationResult confirm(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       SecurityCode code)
                                                throws SecurityCodeNotFoundException,
                                                       IOException

Confirm the code.

Parameters:

request - the current request

response - the current response

code - the code to confirm

Returns:

the result of the confirmation or null if the handler has already send an appropriate response within this method

Throws:

SecurityCodeNotFoundException - in case the code was removed in the meantime

IOException - in case this handler wrote to the response and this caused an error

getAction

public SecurityCodeAction getAction()

Returns:

the action of the security code this handler can handle

getWarningForMissingCode

public LocalizedMessage getWarningForMissingCode(javax.servlet.http.HttpServletRequest request,
                                                 String code)

Return a message that should be shown as warning to the user if the action of this handler was provided but the code did not exist. This can for instance occur if a confirmation link is opened a second time.

Parameters:

request - the current request

code - the code that could not be found

Returns:

the message or null if this case should not be handled specifically