/* 
    P/P   *  Method: net.sourceforge.pebble.util.CookieUtils__static_init
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.util;
    33  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.util.CookieUtils()
          */
    34  import javax.servlet.http.Cookie;
    35  import javax.servlet.http.HttpServletResponse;
    36  
    37  /**
    38   * Utilities for finding and manipulating cookies.
    39   *
    40   * @author    Simon Brown
    41   */
    42  public class CookieUtils {
    43  
    44    /** represents 4 weeks in seconds */
    45    public static final int ONE_MONTH = 60 * 60 * 24 * 28;
    46  
    47    /**
    48     * Gets a reference to a named cookie from an array of cookies.
    49     *
    50     * @param cookies   an array of cookies
    51     * @param name      the name of the cookie to find
    52     * @return    a reference to a Cookie, or null if the cookie couldn't be found
    53     */
    54    public static Cookie getCookie(Cookie cookies[], String name) {
    55  
             /* 
    P/P       *  Method: Cookie getCookie(Cookie[], String)
              * 
              *  Preconditions:
              *    (soft) cookies.length <= 232-1
              *    (soft) cookies[...] != null
              * 
              *  Presumptions:
              *    javax.servlet.http.Cookie:getName(...)@58 != null
              * 
              *  Postconditions:
              *    init'ed(return_value)
              * 
              *  Test Vectors:
              *    cookies: Addr_Set{null}, Inverse{null}
              *    java.lang.String:equals(...)@58: {0}, {1}
              */
    56      if (cookies != null) {
    57        for (Cookie cookie : cookies) {
    58          if (cookie.getName().equals(name)) {
    59            return cookie;
    60          }
    61        }
    62      }
    63  
    64      // we've got this far so the specified cookie wasn't found
    65      return null;
    66    }
    67  
    68    /**
    69     * Adds a cookie with the specified name, value and expiry.
    70     *
    71     * @param response    the HttpServletResponse to add the cookie to
    72     * @param name        the name of the cookie
    73     * @param value       the value of the cookie
    74     * @param maxAge      the maxAge of the cookie (in seconds)
    75     */
    76    public static void addCookie(HttpServletResponse response, String name, String value, int maxAge) {
             /* 
    P/P       *  Method: void addCookie(HttpServletResponse, String, String, int)
              * 
              *  Preconditions:
              *    response != null
              */
    77      Cookie cookie = new Cookie(name, value);
    78      cookie.setMaxAge(maxAge);
    79      response.addCookie(cookie);
    80    }
    81  
    82    /**
    83     * Removes a cookie with the specified name.
    84     *
    85     * @param response    the HttpServletResponse to remove the cookie from
    86     * @param name        the name of the cookie
    87     */
    88    public static void removeCookie(HttpServletResponse response, String name) {
             /* 
    P/P       *  Method: void removeCookie(HttpServletResponse, String)
              * 
              *  Preconditions:
              *    response != null
              */
    89      addCookie(response, name, "", 0);
    90    }
    91  
    92  }