Package org.sakaiproject.util

Class ParameterParser

  • public class ParameterParser
extends Object
    ParameterParser is a wrapper over the request that provides compatibility with Sakai 1.5 and before.

    • Field Detail

      • m_req

        protected javax.servlet.http.HttpServletRequest m_req
        The request.

    • Constructor Detail

      • ParameterParser

        public ParameterParser​(javax.servlet.http.HttpServletRequest req)
        Construct with this request.
        Parameters:
        req - The current request.

    • Method Detail

      • getProperties

        public Properties getProperties()
        Access the parameter names.
        Returns:
        An Iterator of parameter names (String).

      • getNames

        public Iterator<String> getNames()
        Access the parameter names.
        Returns:
        An Iterator of parameter names (String).

      • get

        public String get​(String name)
        Get a (String) parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter value, or null if it's not defined.

      • getString

        public String getString​(String name)
        Get a (String) parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter value, or null if it's not defined.

      • getStrings

        public String[] getStrings​(String name)
        Get a (String[]) multi-valued parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter values array (of String), or null if it's not defined.

      • getBoolean

        public boolean getBoolean​(String name)
        Get a boolean parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter boolean value, or false if it's not defined.

      • getInt

        public int getInt​(String name,
                  int deflt)
        Get an int parameter by name, with default.
        Parameters:
        name - The parameter name.
        deflt - The default value.
        Returns:
        The parameter int value, or the default if it's not defined or not int.

      • getInt

        public int getInt​(String name)
        Get an int parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter int value, or 0 if it's not defined or not int.

      • getCleanString

        public String getCleanString​(String name)
        Clean the user input string of strange newlines, etc.
        Parameters:
        name - The user input string.
        Returns:
        value cleaned of string newlines, etc.

      • getPath

        public String getPath()
        Access the pathInfo.
        Returns:
        The pathInfo.

      • getFileItem

        public FileItem getFileItem​(String name)
        Get a FileItem parameter by name.
        Parameters:
        name - The parameter name.
        Returns:
        The parameter FileItem value, or null if it's not defined.