Interface ParserService

All Known Implementing Classes:
DefaultParserService

public interface ParserService
ParserService defines the methods which are needed by the parser objects to get their necessities.
Version:
$Id: ValueParser.java 535465 2007-05-05 06:58:06Z tv $
Author:
Thomas Vandahl
  • Field Details

    • ROLE

      static final String ROLE
      Avalon Identifier
    • PARAMETER_ENCODING_DEFAULT

      static final String PARAMETER_ENCODING_DEFAULT
      Default Encoding for Parameter Parser
      See Also:
    • PARAMETER_ENCODING_KEY

      static final String PARAMETER_ENCODING_KEY
      Key for the Parameter Parser Encoding
      See Also:
    • URL_CASE_FOLDING_KEY

      static final String URL_CASE_FOLDING_KEY
      Property for setting the URL folding value
      See Also:
    • AUTOMATIC_KEY

      static final String AUTOMATIC_KEY
      Parse file upload items automatically
      See Also:
    • FULCRUM_POOL_DEFAULT

      static final boolean FULCRUM_POOL_DEFAULT
      fulcrum pool by default false
      See Also:
    • FULCRUM_POOL_KEY

      static final String FULCRUM_POOL_KEY
      fulcrum pool activation parameter
      See Also:
    • POOL_KEY

      static final String POOL_KEY
      commons pool2 parameters
      See Also:
    • AUTOMATIC_DEFAULT

      static final boolean AUTOMATIC_DEFAULT

      The default value of 'automaticUpload' property (false). If set to true, parsing the multipart request will be performed automatically by ParameterParser. Otherwise, an org.apache.turbine.modules.Action may decide to parse the request by calling parseRequest manually.

      See Also:
    • DEFAULT_POOL_CAPACITY

      static final int DEFAULT_POOL_CAPACITY

      The default value of 'maxTotal' property in 'pool' (1024). The default pool capacity.

      See Also:
    • DEFAULT_MAX_IDLE

      static final int DEFAULT_MAX_IDLE

      The default value of 'maxIdle' property in 'pool' (2). The default maximum idle object.

      See Also:
  • Method Details

    • getParameterEncoding

      String getParameterEncoding()
      Get the parameter encoding that has been configured as default for the ParserService.
      Returns:
      A String for the parameter encoding
    • convert

      String convert(String value)
      Trims the string data and applies the conversion specified in the property given by URL_CASE_FOLDING. It returns a new string so that it does not destroy the value data.
      Parameters:
      value - A String to be processed.
      Returns:
      A new String converted to lowercase and trimmed.
    • convertAndTrim

      String convertAndTrim(String value)
      Convert a String value according to the url-case-folding property.
      Parameters:
      value - the String to convert
      Returns:
      a new String.
    • convertAndTrim

      String convertAndTrim(String value, ValueParser.URLCaseFolding fold)
      A convert method, which trims the string data and applies the conversion specified in the parameter given. It returns a new string so that it does not destroy the value data.
      Parameters:
      value - A String to be processed.
      fold - The parameter folding to be applied (see ParserService)
      Returns:
      A new String converted to the correct case and trimmed.
    • getUrlFolding

      Gets the folding value from the configuration
      Returns:
      The current Folding Value
    • getAutomaticUpload

      boolean getAutomaticUpload()
      Gets the automaticUpload value from the configuration
      Returns:
      The current automaticUpload Value
    • parseUpload

      List<jakarta.servlet.http.Part> parseUpload(jakarta.servlet.http.HttpServletRequest request) throws org.apache.avalon.framework.service.ServiceException
      Parse the given request for uploaded files
      Parameters:
      request - the HttpServletRequest object
      Returns:
      A list of Parts
      Throws:
      org.apache.avalon.framework.service.ServiceException - if parsing fails
    • getParser

      <P extends ValueParser> P getParser(Class<P> ppClass) throws InstantiationException
      Get a ValueParser instance from the service. Use the default implementation.
      Type Parameters:
      P - The ValueParser we are using
      Parameters:
      ppClass - parameter parser class
      Returns:
      An object that implements ValueParser
      Throws:
      InstantiationException - if the instance could not be created
    • putParser

      void putParser(ValueParser parser)
      Put the parser into service
      Parameters:
      parser - The value parser to be used