com.redhat.rhn.frontend.struts

Class StrutsDelegate

java.lang.Object

com.redhat.rhn.frontend.struts.StrutsDelegate

public class StrutsDelegate
extends java.lang.Object

StrutsDelegate defines a set of helper operations for working with the Struts API. Implementations should conform to the same design as servlets an actions classes in that they should be thread-safe and should not maintain client state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StrutsDelegate()

Method Summary

Modifier and Type	Method and Description
void	addError(org.apache.struts.action.ActionErrors errors, java.lang.String msgKey, java.lang.Object... params) Add a message to an existing set of ActionErrors.
void	addError(java.lang.String msgKey, org.apache.struts.action.ActionErrors errors) Add a message to an existing set of ActionErrors.
java.lang.String	extractString(org.apache.struts.upload.FormFile f) Util to get the String version of a file upload form.
org.apache.struts.action.ActionForward	forwardParam(org.apache.struts.action.ActionForward base, java.lang.String param, java.lang.String value) Take an action forward and toss on a form variable.
org.apache.struts.action.ActionForward	forwardParams(org.apache.struts.action.ActionForward base, java.util.Map params) Take an action forward and toss on a set of form variables.
java.lang.String	getFormFileName(org.apache.struts.action.DynaActionForm form, java.lang.String paramName) Util to get the String file name of a file upload form.
java.lang.String	getFormFileString(org.apache.struts.action.DynaActionForm form, java.lang.String paramName) Util to get the String version of a file upload form.
static StrutsDelegate	getInstance() Retuns an instance of the struts delegate factory
java.lang.String	getTextAreaValue(org.apache.struts.action.DynaActionForm form, java.lang.String name) Use this for every textarea that we use in our UI.
DatePicker	prepopulateDatePicker(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.DynaActionForm form, java.lang.String name, int yearDirection) Creates a date picker object with the given name and prepopulates the date with values from the given request's parameters.
java.util.Date	readDatePicker(org.apache.struts.action.DynaActionForm form, java.lang.String name, int yearDirection) Reads the earliest date from a form populated by a datepicker.
void	rememberDatePicker(java.util.Map requestParams, org.apache.struts.action.DynaActionForm form, java.lang.String name, int yearDirection) Writes the values of a date picker form to the requestParams for remembering form values across requests.
void	saveMessage(java.lang.String msgKey, javax.servlet.http.HttpServletRequest req) Add a UI message to the Request.
void	saveMessage(java.lang.String msgKey, java.lang.String[] params, javax.servlet.http.HttpServletRequest req) Add a UI message to the Request.
void	saveMessages(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMessages messages) Add messages to the request
void	saveMessages(javax.servlet.http.HttpServletRequest request, java.util.List<ValidatorError> errors, java.util.List<ValidatorWarning> warnings) Add messages to the request
void	saveMessages(javax.servlet.http.HttpServletRequest request, ValidatorResult result) Add messages to the request

Methods inherited from class java.lang.Object

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

Constructor Detail

StrutsDelegate

protected StrutsDelegate()

Method Detail

getInstance

public static StrutsDelegate getInstance()

Retuns an instance of the struts delegate factory

Returns:

an instance

forwardParam

public org.apache.struts.action.ActionForward forwardParam(org.apache.struts.action.ActionForward base,
                                                           java.lang.String param,
                                                           java.lang.String value)

Take an action forward and toss on a form variable.

Parameters:

base - Base ActionForward

param - Parameter to be added to the ActionForward url.

value - Value of parameter to be added.

Returns:

a new ActionForward with the path of the base appended with the param and value.

forwardParams

public org.apache.struts.action.ActionForward forwardParams(org.apache.struts.action.ActionForward base,
                                                            java.util.Map params)

Take an action forward and toss on a set of form variables.

Parameters:

base - Base ActionForward

params - Parameters to be added to the ActionForward url.

Returns:

a new ActionForward with the path of the base appended with the param and value.

addError

public void addError(java.lang.String msgKey,
                     org.apache.struts.action.ActionErrors errors)

Add a message to an existing set of ActionErrors. Useful to add stuff to an already populated ActionErrors instance

Parameters:

msgKey - to add

errors - to add too

addError

public void addError(org.apache.struts.action.ActionErrors errors,
                     java.lang.String msgKey,
                     java.lang.Object... params)

Add a message to an existing set of ActionErrors. Useful to add stuff to an already populated ActionErrors instance

Parameters:

errors - to add too

msgKey - to add

params - key params

saveMessage

public void saveMessage(java.lang.String msgKey,
                        javax.servlet.http.HttpServletRequest req)

Add a UI message to the Request.

Parameters:

msgKey - of the string you want to display

req - used to store the message in.

saveMessage

public void saveMessage(java.lang.String msgKey,
                        java.lang.String[] params,
                        javax.servlet.http.HttpServletRequest req)

Add a UI message to the Request.

Parameters:

msgKey - of the string you want to display

params - formatted params for the localized message

req - used to store the message in.

saveMessages

public void saveMessages(javax.servlet.http.HttpServletRequest request,
                         org.apache.struts.action.ActionMessages messages)

Add messages to the request

Parameters:

request - Request where messages will be saved.

messages - Messages to be saved.

saveMessages

public void saveMessages(javax.servlet.http.HttpServletRequest request,
                         java.util.List<ValidatorError> errors,
                         java.util.List<ValidatorWarning> warnings)

Add messages to the request

Parameters:

request - Request where messages will be saved.

errors - List of ValidatorError objects.

warnings - List of ValidatorWarning objects.

saveMessages

public void saveMessages(javax.servlet.http.HttpServletRequest request,
                         ValidatorResult result)

Add messages to the request

Parameters:

request - Request where messages will bed saved.

result - the validator result object..

getFormFileName

public java.lang.String getFormFileName(org.apache.struts.action.DynaActionForm form,
                                        java.lang.String paramName)

Util to get the String file name of a file upload form.

Parameters:

form - to get the contents from

paramName - of the FormFile

Returns:

String file name of the upload.

getFormFileString

public java.lang.String getFormFileString(org.apache.struts.action.DynaActionForm form,
                                          java.lang.String paramName)

Util to get the String version of a file upload form. Not useful if the upload is binary.

Parameters:

form - to get the contents from

paramName - of the FormFile

Returns:

String version of the upload.

extractString

public java.lang.String extractString(org.apache.struts.upload.FormFile f)

Util to get the String version of a file upload form. Not useful if the upload is binary.

Parameters:

f - the formfile to extract data off....

Returns:

String version of the upload.

getTextAreaValue

public java.lang.String getTextAreaValue(org.apache.struts.action.DynaActionForm form,
                                         java.lang.String name)

Use this for every textarea that we use in our UI. Otherwise you will get ^M in your file showing up.

Parameters:

form - to fetch from

name - of value in form

Returns:

String without CR in them.

readDatePicker

public java.util.Date readDatePicker(org.apache.struts.action.DynaActionForm form,
                                     java.lang.String name,
                                     int yearDirection)

Reads the earliest date from a form populated by a datepicker. Your dyna action picker must either be a struts datePickerForm, or possess all of datePickerForm's fields.

Parameters:

form - The datePickerForm

name - The prefix for the date picker form fields, usually "date"

yearDirection - One of DatePicker's year range static variables.

Returns:

The earliest date to schedule actions.

See Also:

DatePicker

rememberDatePicker

public void rememberDatePicker(java.util.Map requestParams,
                               org.apache.struts.action.DynaActionForm form,
                               java.lang.String name,
                               int yearDirection)

Writes the values of a date picker form to the requestParams for remembering form values across requests. Your dyna action picker must either be a struts datePickerForm, or possess all of datePickerForm's fields.

Parameters:

requestParams - The map to which to copy form fields

form - The datePickerForm

name - The prefix for the date picker form fields, usually "date"

yearDirection - One of DatePicker's year range static variables.

See Also:

DatePicker

prepopulateDatePicker

public DatePicker prepopulateDatePicker(javax.servlet.http.HttpServletRequest request,
                                        org.apache.struts.action.DynaActionForm form,
                                        java.lang.String name,
                                        int yearDirection)

Creates a date picker object with the given name and prepopulates the date with values from the given request's parameters. Prepopulates the form with these values as well. Your dyna action picker must either be a struts datePickerForm, or possess all of datePickerForm's fields.

Parameters:

request - The request from which to get initial form field values.

form - The datePickerForm

name - The prefix for the date picker form fields, usually "date"

yearDirection - One of DatePicker's year range static variables.

Returns:

The created and prepopulated date picker object

See Also:

DatePicker