com.technia.tvc.core.actions

Class TVCAction

java.lang.Object

com.technia.tvc.struts.action.Action

com.technia.tvc.core.actions.TVCAction

Direct Known Subclasses:

GetStaticResourceAction, NewTxAction, ShowObjectAction, com.technia.tvc.core.xml.http.XMLAction

public abstract class TVCAction
extends com.technia.tvc.struts.action.Action

This action class contains some utility methods that might come useful for sub classes. All action classes should consider to subclass this class direct or indirect to be able to use these methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_TASK_ERROR
static java.lang.String	CLIENT_TASK_ERROR_KEY
static java.lang.String	CLIENT_TASK_NOTICE_KEY
static java.lang.String	CLIENT_TASK_WARNING_KEY
static java.lang.String	GLOBAL_ERROR_KEY
static java.lang.String	INFORMATION_ERROR Property used to save errors that are more like information to the user, rather than error messages.

Fields inherited from class com.technia.tvc.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
TVCAction()

Method Summary

Modifier and Type	Method and Description
protected void	addError(javax.servlet.http.HttpServletRequest request, java.lang.String property, com.technia.tvc.struts.action.ActionError error) Add an error to the previously saved errors.
protected void	addError(javax.servlet.http.HttpServletRequest request, java.lang.String property, java.lang.String key) Add an error to the previously saved errors.
protected com.technia.tvc.struts.action.ActionErrors	addErrors(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionErrors errors) Adds the error instance in the specified errors instance to the previously saved errors.
protected void	addGlobalError(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionError error) Add a global error to the previously saved errors.
protected void	addGlobalError(javax.servlet.http.HttpServletRequest request, java.lang.String key) Add a global error to the previously saved errors.
protected void	addInformationError(javax.servlet.http.HttpServletRequest request, java.lang.String key) Add an information error to the previously saved errors.
protected com.technia.tvc.struts.action.ActionError	asActionError(TVCException e) Convert the specified TVCException into an ActionError.
protected com.technia.tvc.struts.action.ActionErrors	asActionErrors(matrix.db.ClientTaskList ctl) Convert the specified list of ClientTasks into ActionErrors.
protected com.technia.tvc.struts.action.ActionErrors	copy(com.technia.tvc.struts.action.ActionErrors ae1, com.technia.tvc.struts.action.ActionErrors ae2) Copy errors from the ActionErrors instance with less errors to the ActionErrors with more errors.
protected void	debugRequest(com.technia.tvc.log4j.Logger l, javax.servlet.http.HttpServletRequest request) Prints the parameters and the corresponding values of those from the current request to the provided logger.
com.technia.tvc.struts.action.ActionForward	execute(com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
abstract com.technia.tvc.struts.action.ActionForward	executeImpl(com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method MUST be overridden by subclasses to handle the logic.
protected com.technia.tvc.struts.action.ActionForward	findErrorForward(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionMapping mapping) This method returns the ActionForward instance referring to the predefined error forward.
protected com.technia.tvc.struts.action.ActionForward	findForwardOrTargetPage(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionMapping mapping, java.lang.String forwardName) This method returns an ActionForward instance referring to the requested view.
com.technia.tvc.struts.action.ActionForward	perform(com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
com.technia.tvc.struts.action.ActionForward	perform(com.technia.tvc.struts.action.ActionMapping mapping, com.technia.tvc.struts.action.ActionForm form, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
protected void	saveError(javax.servlet.http.HttpServletRequest request, java.lang.String property, com.technia.tvc.struts.action.ActionError error) Save an error to the request object.
protected void	saveError(javax.servlet.http.HttpServletRequest request, java.lang.String property, java.lang.String key) Save an error to the request object.
protected void	saveGlobalError(javax.servlet.http.HttpServletRequest request, com.technia.tvc.struts.action.ActionError error) Save a global error to the request object.
protected void	saveGlobalError(javax.servlet.http.HttpServletRequest request, java.lang.String key) Save a global error to the request object.
protected void	saveInformationError(javax.servlet.http.HttpServletRequest request, java.lang.String key) Save an information error to the request object.
protected void	setLocale(javax.servlet.http.HttpServletRequest request, java.util.Locale locale)

Methods inherited from class com.technia.tvc.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

INFORMATION_ERROR

public static final java.lang.String INFORMATION_ERROR

Property used to save errors that are more like information to the user, rather than error messages.

See Also:

Constant Field Values

CLIENT_TASK_ERROR

public static final java.lang.String CLIENT_TASK_ERROR

See Also:

Constant Field Values

CLIENT_TASK_NOTICE_KEY

public static final java.lang.String CLIENT_TASK_NOTICE_KEY

See Also:

Constant Field Values

CLIENT_TASK_WARNING_KEY

public static final java.lang.String CLIENT_TASK_WARNING_KEY

See Also:

Constant Field Values

CLIENT_TASK_ERROR_KEY

public static final java.lang.String CLIENT_TASK_ERROR_KEY

See Also:

Constant Field Values

GLOBAL_ERROR_KEY

public static final java.lang.String GLOBAL_ERROR_KEY

See Also:

Constant Field Values

Constructor Detail

TVCAction

public TVCAction()

Method Detail

setLocale

protected void setLocale(javax.servlet.http.HttpServletRequest request,
                         java.util.Locale locale)

Overrides:

setLocale in class com.technia.tvc.struts.action.Action

saveError

protected void saveError(javax.servlet.http.HttpServletRequest request,
                         java.lang.String property,
                         com.technia.tvc.struts.action.ActionError error)

Save an error to the request object. All errors previously saved will be discarded.

Parameters:

request - the current request.

property - the property that the error is bound to.

error - the error to save.

saveGlobalError

protected void saveGlobalError(javax.servlet.http.HttpServletRequest request,
                               com.technia.tvc.struts.action.ActionError error)

Save a global error to the request object. All errors previously saved will be discarded.

Parameters:

request - the current request.

error - the error to save.

saveError

protected void saveError(javax.servlet.http.HttpServletRequest request,
                         java.lang.String property,
                         java.lang.String key)

Save an error to the request object. All errors previously saved will be discarded.

Parameters:

request - the current request.

property - the property that the error is bound to.

key - the key of the error message.

saveGlobalError

protected void saveGlobalError(javax.servlet.http.HttpServletRequest request,
                               java.lang.String key)

Save a global error to the request object. All errors previously saved will be discarded.

Parameters:

request - the current request.

key - the key of the error message.

saveInformationError

protected void saveInformationError(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String key)

Save an information error to the request object. All errors previously saved will be discarded.

Parameters:

request - the current request.

key - the key of the error message.

addError

protected void addError(javax.servlet.http.HttpServletRequest request,
                        java.lang.String property,
                        com.technia.tvc.struts.action.ActionError error)

Add an error to the previously saved errors.

Parameters:

request - the current request.

property - the property that the error is bound to.

error - the error to add.

addGlobalError

protected void addGlobalError(javax.servlet.http.HttpServletRequest request,
                              com.technia.tvc.struts.action.ActionError error)

Add a global error to the previously saved errors.

Parameters:

request - the current request.

error - the error to add.

addError

protected void addError(javax.servlet.http.HttpServletRequest request,
                        java.lang.String property,
                        java.lang.String key)

Add an error to the previously saved errors.

Parameters:

request - the current request.

property - the property that the error is bound to.

key - the key of the error message.

addGlobalError

protected void addGlobalError(javax.servlet.http.HttpServletRequest request,
                              java.lang.String key)

Add a global error to the previously saved errors.

Parameters:

request - the current request.

key - the key of the error message.

addInformationError

protected void addInformationError(javax.servlet.http.HttpServletRequest request,
                                   java.lang.String key)

Add an information error to the previously saved errors.

Parameters:

request - the current request.

key - the key of the error message.

addErrors

protected com.technia.tvc.struts.action.ActionErrors addErrors(javax.servlet.http.HttpServletRequest request,
                                                               com.technia.tvc.struts.action.ActionErrors errors)

Adds the error instance in the specified errors instance to the previously saved errors. This method will return the ActionErrors instance to which the errors were saved, which may be the same instance that was passed as an argument.

Parameters:

request - the current request.

errors - the errors to add.

copy

protected com.technia.tvc.struts.action.ActionErrors copy(com.technia.tvc.struts.action.ActionErrors ae1,
                                                          com.technia.tvc.struts.action.ActionErrors ae2)

Copy errors from the ActionErrors instance with less errors to the ActionErrors with more errors. The AcitonErrors instance to which the errors have been copied is returned while the other is cleared.

Parameters:

ae1 - the first ActionErrors instance.

ae2 - the second ActionErrors instance.

Returns:

the ActionErrors instance to which all errors has been copied.

findForwardOrTargetPage

protected com.technia.tvc.struts.action.ActionForward findForwardOrTargetPage(javax.servlet.http.HttpServletRequest request,
                                                                              com.technia.tvc.struts.action.ActionMapping mapping,
                                                                              java.lang.String forwardName)

This method returns an ActionForward instance referring to the requested view. The forward is retrieved by checking the request parameters "targetPage" and "targetForward". If "targetPage" is present the returned ActionForward will forward the request to the page specified by the "targetPage" parameter. If "targetForward" is present the returned ActionForward will forward the request to a predefined forward with the specified name. If neither "targetPage" nor "targetForward" is present, the returned ActionForward will forward the request to a predefined forward specified by the forwardName parameter.

Parameters:

request - the current request.

mapping - the current action mapping.

forwardName - the name of the default forward.

Returns:

the ActionForward referring to the requested view.

findErrorForward

protected com.technia.tvc.struts.action.ActionForward findErrorForward(javax.servlet.http.HttpServletRequest request,
                                                                       com.technia.tvc.struts.action.ActionMapping mapping)

This method returns the ActionForward instance referring to the predefined error forward.

Parameters:

request - the current request.

mapping - the current action mapping.

Returns:

an ActionForward referring to the predefined error forward.

debugRequest

protected void debugRequest(com.technia.tvc.log4j.Logger l,
                            javax.servlet.http.HttpServletRequest request)

Prints the parameters and the corresponding values of those from the current request to the provided logger.

asActionErrors

protected com.technia.tvc.struts.action.ActionErrors asActionErrors(matrix.db.ClientTaskList ctl)

Convert the specified list of ClientTasks into ActionErrors.

Parameters:

ctl - The list of ClientTasks.

Returns:

A list of ActionErrors.

Since:

5.0.0

asActionError

protected com.technia.tvc.struts.action.ActionError asActionError(TVCException e)

Convert the specified TVCException into an ActionError. Note that this method may return null if it wasn't able to perform the conversion.

Parameters:

e - The TVCException.

Returns:

An ActionError.

Since:

5.0.0

executeImpl

public abstract com.technia.tvc.struts.action.ActionForward executeImpl(com.technia.tvc.struts.action.ActionMapping mapping,
                                                                        com.technia.tvc.struts.action.ActionForm form,
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                 throws java.lang.Exception

This method MUST be overridden by subclasses to handle the logic.

Throws:

java.lang.Exception

execute

public final com.technia.tvc.struts.action.ActionForward execute(com.technia.tvc.struts.action.ActionMapping mapping,
                                                                 com.technia.tvc.struts.action.ActionForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                          throws java.lang.Exception

Overrides:

execute in class com.technia.tvc.struts.action.Action

Throws:

java.lang.Exception

perform

public final com.technia.tvc.struts.action.ActionForward perform(com.technia.tvc.struts.action.ActionMapping mapping,
                                                                 com.technia.tvc.struts.action.ActionForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                          throws java.io.IOException,
                                                                 javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

perform

public final com.technia.tvc.struts.action.ActionForward perform(com.technia.tvc.struts.action.ActionMapping mapping,
                                                                 com.technia.tvc.struts.action.ActionForm form,
                                                                 javax.servlet.ServletRequest request,
                                                                 javax.servlet.ServletResponse response)
                                                          throws java.io.IOException,
                                                                 javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException