Module cloud.piranha.webapp.api
Package cloud.piranha.webapp.api

Interface HttpHeaderManager

All Known Implementing Classes:
DefaultHttpHeaderManager
public interface HttpHeaderManager
The HttpHeaderManager API.
Author:
Manfred Riem ([email protected])

  • Method Summary

    Modifier and Type Method Description
    void addHeader​(java.lang.String name, java.lang.String value)
    Add the header.
    boolean containsHeader​(java.lang.String name)
    Contains the given header.
    long getDateHeader​(java.lang.String name)
    Get the date header.
    java.lang.String getHeader​(java.lang.String name)
    Get the header.
    java.util.Enumeration<java.lang.String> getHeaderNames()
    Get the header names.
    java.util.Enumeration<java.lang.String> getHeaders​(java.lang.String name)
    Get the headers.
    int getIntHeader​(java.lang.String name)
    Get the int header.
    void setHeader​(java.lang.String name, java.lang.String value)
    Set the header.

  • Method Details

    • addHeader

      void addHeader​(java.lang.String name, java.lang.String value)
      Add the header.
      Parameters:
      name - the name.
      value - the value.

    • containsHeader

      boolean containsHeader​(java.lang.String name)
      Contains the given header.
      Parameters:
      name - the header name.
      Returns:
      true if there, false otherwise.

    • getDateHeader

      long getDateHeader​(java.lang.String name) throws java.lang.IllegalArgumentException
      Get the date header.
      Parameters:
      name - the header name.
      Returns:
      the date header.
      Throws:
      java.lang.IllegalArgumentException - when the header could not be converted to a date.

    • getHeader

      java.lang.String getHeader​(java.lang.String name)
      Get the header.
      Parameters:
      name - the header name.
      Returns:
      the header value.

    • getHeaderNames

      java.util.Enumeration<java.lang.String> getHeaderNames()
      Get the header names.
      Returns:
      the header names.

    • getHeaders

      java.util.Enumeration<java.lang.String> getHeaders​(java.lang.String name)
      Get the headers.
      Parameters:
      name - the header name.
      Returns:
      the header values.

    • getIntHeader

      int getIntHeader​(java.lang.String name) throws java.lang.NumberFormatException
      Get the int header.
      Parameters:
      name - the header name.
      Returns:
      the int value.
      Throws:
      java.lang.NumberFormatException - when the value could not be converted to an int.

    • setHeader

      void setHeader​(java.lang.String name, java.lang.String value)
      Set the header.
      Parameters:
      name - the name.
      value - the value (string).