org.apache.struts.validator

Class Resources


public class Resources
extends java.lang.Object

This class helps provides some useful methods for retrieving objects from different scopes of the application.

Version:
$Revision: 1.11 $ $Date: 2003/05/22 01:11:16 $

Authors:
David Winterfeldt
Eddie Bush

Since:
Struts 1.1

Field Summary

static String
ACTION_ERRORS_KEY
Resources key the ActionErrors is stored under.
static String
HTTP_SERVLET_REQUEST_KEY
Resources key the HttpServletRequest is stored under.
static String
SERVLET_CONTEXT_KEY
Resources key the ServletContext is stored under.

Method Summary

static ActionError
getActionError(HttpServletRequest request, ValidatorAction va, Field field)
Gets the ActionError based on the ValidatorAction message and the Field's arg objects.
static String[]
getArgs(String actionName, MessageResources messages, Locale locale, Field field)
Gets the message arguments based on the current ValidatorAction and Field.
static Locale
getLocale(HttpServletRequest request)
Get the Locale of the current user.
static String
getMessage(HttpServletRequest request, String key)
Gets the Locale sensitive value based on the key passed in.
static String
getMessage(MessageResources messages, Locale locale, String key)
Gets the Locale sensitive value based on the key passed in.
static String
getMessage(MessageResources messages, Locale locale, ValidatorAction va, Field field)
Gets the locale sensitive message based on the ValidatorAction message and the Field's arg objects.
static MessageResources
getMessageResources(HttpServletRequest request)
Retrieve MessageResources for the module.
static MessageResources
getMessageResources(ServletContext application)
Deprecated. This method can only return the resources for the default module.
static ValidatorResources
getValidatorResources(ServletContext application)
Deprecated. In Struts 1.1 This method can only return the resources for the default module.
static ValidatorResources
getValidatorResources(ServletContext application, HttpServletRequest request)
Retrieve ValidatorResources for the current module.
static Validator
initValidator(String key, Object bean, ServletContext application, HttpServletRequest request, ActionErrors errors, int page)
Initialize the Validator to perform validation.

Field Details

ACTION_ERRORS_KEY

public static String ACTION_ERRORS_KEY
Resources key the ActionErrors is stored under.


HTTP_SERVLET_REQUEST_KEY

public static String HTTP_SERVLET_REQUEST_KEY
Resources key the HttpServletRequest is stored under.


SERVLET_CONTEXT_KEY

public static String SERVLET_CONTEXT_KEY
Resources key the ServletContext is stored under.

Method Details

getActionError

public static ActionError getActionError(HttpServletRequest request,
                                         ValidatorAction va,
                                         Field field)
Gets the ActionError based on the ValidatorAction message and the Field's arg objects.

Parameters:
request - the servlet request
va - Validator action
field - the validator Field


getArgs

public static String[] getArgs(String actionName,
                               MessageResources messages,
                               Locale locale,
                               Field field)
Gets the message arguments based on the current ValidatorAction and Field.

Parameters:
actionName - action name
messages - message resources
locale - the locale
field - the validator field


getLocale

public static Locale getLocale(HttpServletRequest request)
Get the Locale of the current user.

Parameters:
request - servlet request


getMessage

public static String getMessage(HttpServletRequest request,
                                String key)
Gets the Locale sensitive value based on the key passed in.

Parameters:
request - servlet request
key - the request key


getMessage

public static String getMessage(MessageResources messages,
                                Locale locale,
                                String key)
Gets the Locale sensitive value based on the key passed in.

Parameters:
messages - The Message resources
locale - The locale.
key - Key used to lookup the message


getMessage

public static String getMessage(MessageResources messages,
                                Locale locale,
                                ValidatorAction va,
                                Field field)
Gets the locale sensitive message based on the ValidatorAction message and the Field's arg objects.

Parameters:
messages - The Message resources
locale - The locale
va - The Validator Action
field - The Validator Field


getMessageResources

public static MessageResources getMessageResources(HttpServletRequest request)
Retrieve MessageResources for the module.

Parameters:
request - the servlet request


getMessageResources

public static MessageResources getMessageResources(ServletContext application)

Deprecated. This method can only return the resources for the default module. Use getMessageResources(HttpServletRequest) to get the resources for the current module.

Retrieve MessageResources for the application module.

Parameters:
application - servlet context


getValidatorResources

public static ValidatorResources getValidatorResources(ServletContext application)

Deprecated. In Struts 1.1 This method can only return the resources for the default module. Use getValidatorResources(HttpServletRequest, ServletContext) to get the resources for the current application module.

Retrieve ValidatorResources for the module.

Parameters:
application - servlet context


getValidatorResources

public static ValidatorResources getValidatorResources(ServletContext application,
                                                       HttpServletRequest request)
Retrieve ValidatorResources for the current module.

Parameters:
application - Application Context
request - The ServletRequest


initValidator

public static Validator initValidator(String key,
                                      Object bean,
                                      ServletContext application,
                                      HttpServletRequest request,
                                      ActionErrors errors,
                                      int page)
Initialize the Validator to perform validation.

Parameters:
key - The key that the validation rules are under (the form elements name attribute).
bean - The bean validation is being performed on.
application - servlet context
request - The current request object.
errors - The object any errors will be stored in.
page - This in conjunction with the page property of a Field can control the processing of fields. If the field's page is less than or equal to this page value, it will be processed.


Copyright B) 2000-2005 - Apache Software Foundation