Examples of hirondelle.web4j.request.RequestParameter

hirondelle.web4j.request.RequestParameter
Request parameter as a name and (usually) an associated regular expression.
This class does not directly provide access to the parameter value. For such services, please see {@link RequestParser} and {@link ModelFromRequest}.
This class separates request parameters into two kinds : file upload request parameters, and all others (here called "regular" request parameters).
Regular Request Parameters
Regular request parameters are associated with :
- a name, corresponding to both an underlying HTTP request parameter name, and an underlying control name - see naming convention.
- a regular expression, used by {@link ApplicationFirewall} to perform hard validation
File Upload Request Parameters
Files are uploaded using forms having :
- method="POST"
- enctype="multipart/form-data"
- an <INPUT type="file"> control
In addition, note that the Servlet API does not have extensive services for processing file upload parameters. It is likely best to use a third party tool for that task.
File upload request parameters, as represented by this class, have only a name associated with them, and no regular expression. This is because WEB4J cannot perform hard validation on the value of a file upload parameter - since the user may select any file whatsoever, validation of file contents can only be treated as a soft validation. If there is a problem, the response to the user must be polished, as part of the normal operation of the application.
As an example, an {@link Action} might perform soft validation on a file upload parameter for these items :
- file size does not exceed a maximum value
- MIME type matches a regular expression
- file name matches a regular expression
- text file content may be matched to a regular expression
Naming Convention
Parameter names are usually not arbitrary in WEB4J. Instead, a simple convention is used which allows for automated mapping between request parameter names and corresponding getXXX methods of Model Objects (see {@link hirondelle.web4j.ui.tag.Populate}). For example, a parameter named 'Birth Date' (or 'birthDate') is mapped to a method named getBirthDate() when prepopulating a form with the contents of a Model Object. (The 'Birth Date' naming style is recommended, since it has this advantage : when messages regarding form input are presented to the user, the control name may be used directly, without trivial mapping of a 'coder-friendly' parameter name into more user-friendly text.)
Some parameters - notably those passed to Template.jsp - are not processed at all by the Controller, but are used directly in JSPs instead. Such parameters do not undergo hard validation by the {@link hirondelle.web4j.security.ApplicationFirewall}, and are not represented by this class.
See {@link java.util.regex.Pattern} for more information on regular expressions.

    else {
      String localizedPattern = translator.get(fText, aLocale);
      List<String> formattedParams = new ArrayList<String>();
      for (Object param : fParams){
        if ( param instanceof RequestParameter ){
          RequestParameter reqParam = (RequestParameter)param;
          String translatedParamName = translator.get(reqParam.getName(), aLocale); 
          formattedParams.add( translatedParamName ); 
        }
        else {
          //this will escape any special HTML chars in params :
          formattedParams.add( formats.objectToTextForReport(param).toString() );

View Full Code Here

    Object result = null;
    if ( ! (aCandidateArg instanceof RequestParameter) ) {
      result = aCandidateArg;
    }
    else {
      RequestParameter reqParam = (RequestParameter)aCandidateArg;
      result = translateParam(reqParam, aTargetClass);
    }
    return result;
  }

View Full Code Here

      //this method may return file upload controls - depends on interpretation, whether to include file upload controls in this method
      Enumeration paramNames = aRequestParser.getRequest().getParameterNames();
      while ( paramNames.hasMoreElements() ){
        String incomingParamName = (String)paramNames.nextElement();
        fLogger.fine("Checking parameter named " + Util.quote(incomingParamName));
        RequestParameter knownParam = matchToKnownParam(incomingParamName, expectedParams);
        if( knownParam == null ){
          fLogger.severe("*** Unknown Parameter *** : " + Util.quote(incomingParamName) + ". Please add public static final RequestParameter field for this item to your Action.");
          throw new BadRequestException(HttpServletResponse.SC_BAD_REQUEST);
        }
        if ( knownParam.isFileUploadParameter() ) {
          fLogger.fine("File Upload parameter - value not validatable here: " + knownParam.getName());
          continue; //prevents checks on values for file upload controls
        }
        Collection<SafeText> paramValues = aRequestParser.toSafeTexts(knownParam);
        if( ! isInternalParam( knownParam) ) {
          checkParamValues(knownParam, paramValues);

View Full Code Here

    }
  }
  
  /** If no match is found, return <tt>null</tt>.   Matches to both regular and 'internal' request params. */
  private RequestParameter matchToKnownParam(String aIncomingParamName, Collection<RequestParameter> aExpectedParams){
    RequestParameter result = null;
    for (RequestParameter reqParam: aExpectedParams){
      if ( reqParam.getName().equals(aIncomingParamName) ){
        result = reqParam;
        break;
      }

View Full Code Here

TOP

Related Classes of hirondelle.web4j.request.RequestParameter

hirondelle.web4j.model.AppResponseMessage

hirondelle.web4j.model.ModelFromRequest

hirondelle.web4j.security.ApplicationFirewallImpl

java.util.regex.Pattern

hirondelle.web4j.model.ModelCtorException

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.