Package net.anotheria.anosite.wizard.handler

Class BaseWizardHandler

java.lang.Object

net.anotheria.anosite.wizard.handler.BaseWizardHandler

All Implemented Interfaces:

WizardHandler

public class BaseWizardHandler
extends Object
implements WizardHandler

BaseWizardHandler as main class for Wizard handlers. Used as Default WizardHandler for wizards where handler is not specified. Can be simply extended.

Author:

h3ll

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseWizardHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected org.slf4j.Logger	getLogger()	Returns logger.
WizardAPI	getWizardAPI()	Return WizardAPI.
protected WizardHandlerResponse	handleIncomingCommand(jakarta.servlet.http.HttpServletRequest req, WizardAO wizard, WizardStepAO currentStep, boolean isSubmit)	Handle incoming command method.
protected boolean	isCancellationAllowed(jakarta.servlet.http.HttpServletRequest req, WizardAO wizard, WizardStepAO step, boolean isSubmit)	Returns true if we can cancel wizard.
protected boolean	isFinishAllowed(jakarta.servlet.http.HttpServletRequest req, WizardAO wizard, WizardStepAO step, boolean isSubmit)	Returns true if we can finish wizard.
protected boolean	isNextStepAllowed(jakarta.servlet.http.HttpServletRequest req, WizardAO wizard, WizardStepAO step, boolean isSubmit)	Returns true if we can be forwarded to next step.
protected boolean	isPreviousStepAllowed(jakarta.servlet.http.HttpServletRequest req, WizardAO wizard, WizardStepAO step, boolean isSubmit)	Returns true if we can be forwarded to previous step.
WizardHandlerResponse	preProcess(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, WizardDef wizard)	Method called before wizard process execution.
WizardHandlerResponse	process(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, WizardDef wizard)	Process request to wizard.
WizardHandlerResponse	submit(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, WizardDef wizard)	ProcessSubmit request to wizard.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWizardHandler

protected BaseWizardHandler()

Constructor.

Method Detail

preProcess

public WizardHandlerResponse preProcess(jakarta.servlet.http.HttpServletRequest req,
                                        jakarta.servlet.http.HttpServletResponse res,
                                        WizardDef wizard)
                                 throws WizardHandlerPreProcessException

Description copied from interface: WizardHandler

Method called before wizard process execution.

Specified by:

preProcess in interface WizardHandler

Parameters:

req - HttpServletRequest}

res - HttpServletResponse

wizard - WizardDef

Returns:

WizardHandlerResponse

Throws:

WizardHandlerPreProcessException - on errors

process

public WizardHandlerResponse process(jakarta.servlet.http.HttpServletRequest req,
                                     jakarta.servlet.http.HttpServletResponse res,
                                     WizardDef wizard)
                              throws WizardHandlerProcessException

Description copied from interface: WizardHandler

Process request to wizard.

Specified by:

process in interface WizardHandler

Parameters:

req - HttpServletRequest}

res - HttpServletResponse

wizard - WizardDef

Returns:

WizardHandlerResponse

Throws:

WizardHandlerProcessException - on process errors

submit

public WizardHandlerResponse submit(jakarta.servlet.http.HttpServletRequest req,
                                    jakarta.servlet.http.HttpServletResponse res,
                                    WizardDef wizard)
                             throws WizardHandlerSubmitException

Description copied from interface: WizardHandler

ProcessSubmit request to wizard.

Specified by:

submit in interface WizardHandler

Parameters:

req - HttpServletRequest}

res - HttpServletResponse

wizard - WizardDef

Returns:

WizardHandlerResponse

Throws:

WizardHandlerSubmitException - on submit errors

isNextStepAllowed

protected boolean isNextStepAllowed(jakarta.servlet.http.HttpServletRequest req,
                                    WizardAO wizard,
                                    WizardStepAO step,
                                    boolean isSubmit)

Returns true if we can be forwarded to next step. False otherwise.

Parameters:

req - HttpServletRequest

wizard - WizardAO

step - WizardStepAO

isSubmit - boolean value - true if called from submit

Returns:

boolean value

isPreviousStepAllowed

protected boolean isPreviousStepAllowed(jakarta.servlet.http.HttpServletRequest req,
                                        WizardAO wizard,
                                        WizardStepAO step,
                                        boolean isSubmit)

Returns true if we can be forwarded to previous step. False otherwise.

Parameters:

req - HttpServletRequest

wizard - WizardAO

step - WizardStepAO

isSubmit - boolean value - true if called from submit

Returns:

boolean value

isFinishAllowed

protected boolean isFinishAllowed(jakarta.servlet.http.HttpServletRequest req,
                                  WizardAO wizard,
                                  WizardStepAO step,
                                  boolean isSubmit)

Returns true if we can finish wizard.

Parameters:

req - HttpServletRequest

wizard - WizardAO

step - WizardStepAO

isSubmit - boolean value - true if called from submit

Returns:

boolean value

isCancellationAllowed

protected boolean isCancellationAllowed(jakarta.servlet.http.HttpServletRequest req,
                                        WizardAO wizard,
                                        WizardStepAO step,
                                        boolean isSubmit)

Returns true if we can cancel wizard.

Parameters:

req - HttpServletRequest

wizard - WizardAO

step - WizardStepAO

isSubmit - boolean value - true if called from submit

Returns:

boolean value

handleIncomingCommand

protected WizardHandlerResponse handleIncomingCommand(jakarta.servlet.http.HttpServletRequest req,
                                                      WizardAO wizard,
                                                      WizardStepAO currentStep,
                                                      boolean isSubmit)
                                               throws WizardHandlerException

Handle incoming command method. Checks which command should be executed, and execute it.

Parameters:

req - HttpServletRequest

wizard - WizardDef

currentStep - WizardStepAO

isSubmit - boolean value - true if called from submit

Returns:

WizardHandlerResponse

Throws:

WizardHandlerException - on errors

getLogger

protected org.slf4j.Logger getLogger()

Returns logger.

Returns:

Logger

getWizardAPI

public WizardAPI getWizardAPI()

Return WizardAPI.

Returns:

WizardAPI