org.apache.struts.validator
Class Resources

java.lang.Object
  |
  +--org.apache.struts.validator.Resources

public class Resources
extends java.lang.Object

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

Since:
Struts 1.1
Version:
$Rev: 164530 $ $Date: 2005-04-25 04:11:07 +0100 (Mon, 25 Apr 2005) $

Field Summary
static java.lang.String ACTION_ERRORS_KEY
          Deprecated. This will be removed after Struts 1.2
private static java.lang.String ACTION_MESSAGES_PARAM
          Resources key the ActionMessages is stored under.
static java.lang.String HTTP_SERVLET_REQUEST_KEY
          Deprecated. This will be removed after Struts 1.2
private static java.lang.String HTTP_SERVLET_REQUEST_PARAM
          Resources key the HttpServletRequest is stored under.
static java.lang.String SERVLET_CONTEXT_KEY
          Deprecated. This will be removed after Struts 1.2
private static java.lang.String SERVLET_CONTEXT_PARAM
          Resources key the ServletContext is stored under.
 
Constructor Summary
Resources()
           
 
Method Summary
static ActionError getActionError(javax.servlet.http.HttpServletRequest request, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field)
          Deprecated. Use getActionMessage() instead. This will be removed after Struts 1.2.
static ActionMessage getActionMessage(javax.servlet.http.HttpServletRequest request, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field)
          Gets the ActionMessage based on the ValidatorAction message and the Field's arg objects.
static ActionMessage getActionMessage(org.apache.commons.validator.Validator validator, javax.servlet.http.HttpServletRequest request, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field)
          Gets the ActionMessage based on the ValidatorAction message and the Field's arg objects.
static java.lang.String[] getArgs(java.lang.String actionName, MessageResources messages, java.util.Locale locale, org.apache.commons.validator.Field field)
          Gets the message arguments based on the current ValidatorAction and Field.
private static java.lang.String[] getArgValues(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, MessageResources defaultMessages, java.util.Locale locale, org.apache.commons.validator.Arg[] args)
          Gets the message arguments based on the current ValidatorAction and Field.
static java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request)
          Deprecated. Use RequestUtils.getUserLocale() instead. This will be removed after Struts 1.2.
static java.lang.String getMessage(javax.servlet.http.HttpServletRequest request, java.lang.String key)
          Gets the Locale sensitive value based on the key passed in.
static java.lang.String getMessage(MessageResources messages, java.util.Locale locale, java.lang.String key)
          Gets the Locale sensitive value based on the key passed in.
static java.lang.String getMessage(MessageResources messages, java.util.Locale locale, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field)
          Gets the locale sensitive message based on the ValidatorAction message and the Field's arg objects.
static java.lang.String getMessage(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, MessageResources defaultMessages, java.util.Locale locale, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field)
          Gets the Locale sensitive value based on the key passed in.
static MessageResources getMessageResources(javax.servlet.http.HttpServletRequest request)
          Retrieve MessageResources for the module.
static MessageResources getMessageResources(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, java.lang.String bundle)
          Retrieve MessageResources for the module and bundle.
static org.apache.commons.validator.ValidatorResources getValidatorResources(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request)
          Retrieve ValidatorResources for the current module.
static org.apache.commons.validator.Validator initValidator(java.lang.String key, java.lang.Object bean, javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, ActionMessages errors, int page)
          Initialize the Validator to perform validation.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

SERVLET_CONTEXT_PARAM

private static java.lang.String SERVLET_CONTEXT_PARAM
Resources key the ServletContext is stored under.

SERVLET_CONTEXT_KEY

public static java.lang.String SERVLET_CONTEXT_KEY
Deprecated. This will be removed after Struts 1.2

Resources key the ServletContext is stored under.

HTTP_SERVLET_REQUEST_PARAM

private static java.lang.String HTTP_SERVLET_REQUEST_PARAM
Resources key the HttpServletRequest is stored under.

HTTP_SERVLET_REQUEST_KEY

public static java.lang.String HTTP_SERVLET_REQUEST_KEY
Deprecated. This will be removed after Struts 1.2

Resources key the HttpServletRequest is stored under.

ACTION_MESSAGES_PARAM

private static java.lang.String ACTION_MESSAGES_PARAM
Resources key the ActionMessages is stored under.

ACTION_ERRORS_KEY

public static java.lang.String ACTION_ERRORS_KEY
Deprecated. This will be removed after Struts 1.2

Resources key the ActionErrors is stored under.
Constructor Detail

Resources

public Resources()
Method Detail

getValidatorResources

public static org.apache.commons.validator.ValidatorResources getValidatorResources(javax.servlet.ServletContext application,
                                                                                    javax.servlet.http.HttpServletRequest request)
Retrieve ValidatorResources for the current module.
Parameters:
application - Application Context
request - The ServletRequest

getMessageResources

public static MessageResources getMessageResources(javax.servlet.http.HttpServletRequest request)
Retrieve MessageResources for the module.
Parameters:
request - the servlet request

getMessageResources

public static MessageResources getMessageResources(javax.servlet.ServletContext application,
                                                   javax.servlet.http.HttpServletRequest request,
                                                   java.lang.String bundle)
Retrieve MessageResources for the module and bundle.
Parameters:
application - the servlet context
request - the servlet request
bundle - the bundle key

getLocale

public static java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request)
Deprecated. Use RequestUtils.getUserLocale() instead. This will be removed after Struts 1.2.

Get the Locale of the current user.
Parameters:
request - servlet request

getMessage

public static java.lang.String getMessage(MessageResources messages,
                                          java.util.Locale locale,
                                          java.lang.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 java.lang.String getMessage(javax.servlet.http.HttpServletRequest request,
                                          java.lang.String key)
Gets the Locale sensitive value based on the key passed in.
Parameters:
request - servlet request
key - the request key

getMessage

public static java.lang.String getMessage(MessageResources messages,
                                          java.util.Locale locale,
                                          org.apache.commons.validator.ValidatorAction va,
                                          org.apache.commons.validator.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

getMessage

public static java.lang.String getMessage(javax.servlet.ServletContext application,
                                          javax.servlet.http.HttpServletRequest request,
                                          MessageResources defaultMessages,
                                          java.util.Locale locale,
                                          org.apache.commons.validator.ValidatorAction va,
                                          org.apache.commons.validator.Field field)
Gets the Locale sensitive value based on the key passed in.
Parameters:
application - the servlet context
request - the servlet request
defaultMessages - The default Message resources
locale - The locale
va - The Validator Action
field - The Validator Field

getActionError

public static ActionError getActionError(javax.servlet.http.HttpServletRequest request,
                                         org.apache.commons.validator.ValidatorAction va,
                                         org.apache.commons.validator.Field field)
Deprecated. Use getActionMessage() instead. This will be removed after Struts 1.2.

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

getActionMessage

public static ActionMessage getActionMessage(javax.servlet.http.HttpServletRequest request,
                                             org.apache.commons.validator.ValidatorAction va,
                                             org.apache.commons.validator.Field field)
Gets the ActionMessage based on the ValidatorAction message and the Field's arg objects.
Parameters:
request - the servlet request
va - Validator action
field - the validator Field

getActionMessage

public static ActionMessage getActionMessage(org.apache.commons.validator.Validator validator,
                                             javax.servlet.http.HttpServletRequest request,
                                             org.apache.commons.validator.ValidatorAction va,
                                             org.apache.commons.validator.Field field)
Gets the ActionMessage based on the ValidatorAction message and the Field's arg objects.
Parameters:
validator - the Validator
request - the servlet request
va - Validator action
field - the validator Field

getArgs

public static java.lang.String[] getArgs(java.lang.String actionName,
                                         MessageResources messages,
                                         java.util.Locale locale,
                                         org.apache.commons.validator.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

getArgValues

private static java.lang.String[] getArgValues(javax.servlet.ServletContext application,
                                               javax.servlet.http.HttpServletRequest request,
                                               MessageResources defaultMessages,
                                               java.util.Locale locale,
                                               org.apache.commons.validator.Arg[] args)
Gets the message arguments based on the current ValidatorAction and Field.
Parameters:
application - the servlet context
request - the servlet request
defaultMessages - Default message resources
locale - the locale
args - The arguments for the message

initValidator

public static org.apache.commons.validator.Validator initValidator(java.lang.String key,
                                                                   java.lang.Object bean,
                                                                   javax.servlet.ServletContext application,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   ActionMessages 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 2000-2006 - The Apache Software Foundation