com.ibm.wsspi.http

Class HttpCookie

  • java.lang.Object
    • com.ibm.wsspi.http.HttpCookie


  • public class HttpCookie
    extends java.lang.Object
    HTTP cookie object, similar to the J2EE servlet cookie object.
    • Constructor Summary

      Constructors 
      Constructor and Description
      HttpCookie(java.lang.String name, java.lang.String value)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      HttpCookie clone() 
      java.lang.String getAttribute(java.lang.String name)
      Query a generic attribute of this cookie.
      java.lang.String getComment()
      Query the comment attribute of this cookie.
      java.lang.String getDomain()
      Query the domain attribute of this cookie.
      int getMaxAge()
      Query the max-age attribute of this cookie.
      java.lang.String getName()
      Query the name of this cookie.
      java.lang.String getPath()
      Query the path attribute of this cookie.
      java.lang.String getValue()
      Query the value of this cookie.
      int getVersion()
      Query the version attribute of this cookie.
      boolean isDiscard()
      Query if the Discard attribute is set.
      boolean isHttpOnly()
      Query if the HttpOnly attribute is set.
      boolean isSecure()
      Query the secure-flag attribute of this cookie.
      void setAttribute(java.lang.String name, java.lang.String value)
      Set a generic attribute on this cookie.
      void setComment(java.lang.String comment)
      Set the comment attribute of this cookie.
      void setDiscard(boolean flag)
      Set the Discard attribute flag.
      void setDomain(java.lang.String domain)
      Set the domain attribute of this cookie.
      void setHttpOnly(boolean flag)
      Set the HttpOnly special attribute flag.
      void setMaxAge(int age)
      Set the max-age attribute of this cookie.
      void setPath(java.lang.String path)
      Set the path attribute of this cookie.
      void setSecure(boolean flag)
      Set the secure-flag attribute of this cookie.
      void setVersion(int version)
      Set the version attribute of this cookie to the input value.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • HttpCookie

        public HttpCookie(java.lang.String name,
                          java.lang.String value)
        Constructor.
        Parameters:
        name -
        value -
    • Method Detail

      • getName

        public java.lang.String getName()
        Query the name of this cookie.
        Returns:
        String
      • getValue

        public java.lang.String getValue()
        Query the value of this cookie. This might be null, an empty string, or a full valid string.
        Returns:
        String
      • getComment

        public java.lang.String getComment()
        Query the comment attribute of this cookie.
        Returns:
        String
      • getPath

        public java.lang.String getPath()
        Query the path attribute of this cookie.
        Returns:
        String
      • getDomain

        public java.lang.String getDomain()
        Query the domain attribute of this cookie.
        Returns:
        String
      • isSecure

        public boolean isSecure()
        Query the secure-flag attribute of this cookie.
        Returns:
        String
      • getMaxAge

        public int getMaxAge()
        Query the max-age attribute of this cookie.
        Returns:
        String
      • setAttribute

        public void setAttribute(java.lang.String name,
                                 java.lang.String value)
        Set a generic attribute on this cookie.
        Parameters:
        name -
        value -
      • getAttribute

        public java.lang.String getAttribute(java.lang.String name)
        Query a generic attribute of this cookie.
        Parameters:
        name -
        Returns:
        String
      • getVersion

        public int getVersion()
        Query the version attribute of this cookie.
        Returns:
        int
      • setVersion

        public void setVersion(int version)
        Set the version attribute of this cookie to the input value. Valid options include 0 and 1 only.
        Parameters:
        version -
      • setComment

        public void setComment(java.lang.String comment)
        Set the comment attribute of this cookie.
        Parameters:
        comment -
      • setDomain

        public void setDomain(java.lang.String domain)
        Set the domain attribute of this cookie.
        Parameters:
        domain -
      • setPath

        public void setPath(java.lang.String path)
        Set the path attribute of this cookie.
        Parameters:
        path -
      • setSecure

        public void setSecure(boolean flag)
        Set the secure-flag attribute of this cookie.
        Parameters:
        flag -
      • setMaxAge

        public void setMaxAge(int age)
        Set the max-age attribute of this cookie.
        Parameters:
        age -
      • isHttpOnly

        public boolean isHttpOnly()
        Query if the HttpOnly attribute is set.
        Returns:
        boolean
      • setHttpOnly

        public void setHttpOnly(boolean flag)
        Set the HttpOnly special attribute flag.
        Parameters:
        flag -
      • isDiscard

        public boolean isDiscard()
        Query if the Discard attribute is set.
        Returns:
        boolean
      • setDiscard

        public void setDiscard(boolean flag)
        Set the Discard attribute flag.
        Parameters:
        flag -
      • clone

        public HttpCookie clone()
        Overrides:
        clone in class java.lang.Object