Package com.invirgance.convirgance.web.parameter

Class HeaderParameter

java.lang.Object
com.invirgance.convirgance.web.parameter.HeaderParameter
All Implemented Interfaces:
Parameter
public class HeaderParameter extends Object implements Parameter
Retrieve the value of an HTTP Header. The returned key defaults to the same name as the header if headerName is not set, but can be overridden by setting the name parameter.
Author:
jbanes

  • Constructor Details

    • HeaderParameter

      public HeaderParameter()

  • Method Details

    • getName

      public String getName()
      Name of the parameter. Defaults to headerName if not set.
      Specified by:
      getName in interface Parameter
      Returns:
      name of the parameter

    • setName

      public void setName(String name)
      Sets the name of the parameter. Also sets headerName if not set.
      Parameters:
      name - name of the parameter

    • getHeaderName

      public String getHeaderName()
      The header to retrieve from the HTTP request
      Returns:
      name of the header

    • setHeaderName

      public void setHeaderName(String headerName)
      Set the header to retrieve from the HTTP request
      Parameters:
      headerName - name of the header

    • getDefaultValue

      public String getDefaultValue()
      The value to return if the header is not found
      Returns:
      default value to return

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Set the value to return if the header is not found
      Parameters:
      defaultValue - default value to return

    • getValue

      public Object getValue(HttpRequest request)
      Description copied from interface: Parameter
      Extracts a value from the HTTP request.
      Specified by:
      getValue in interface Parameter
      Parameters:
      request - The HTTP request to extract values from
      Returns:
      The extracted value