com.atlassian.seraph.cookie
Interface CookieHandler

All Known Implementing Classes:
DefaultCookieHandler

Deprecated. replaced by the RememberMeService code

public interface CookieHandler

Handles basic cookie tasks


Method Summary
 javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServletRequest request, String name)
          Deprecated. Returns the specified Cookie object, or null if the cookie does not exist.
 String getCookieValue(javax.servlet.http.HttpServletRequest request, String name)
          Deprecated. Returns the value of the specified cookie as a String.
 void invalidateCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String cookieName, String path)
          Deprecated. Invalidate the specified cookie and delete it from the response object.
 javax.servlet.http.Cookie setCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String name, String value, int maxAge, String path)
          Deprecated. Sets a cookie This will also put the cookie in a list of cookies to send with this request's response (so that in case of a redirect occurring down the chain, the first filter will always try to set this cookie again) The cookie secure flag is set if the request is secure.
 

Method Detail

invalidateCookie

void invalidateCookie(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      String cookieName,
                      String path)
Deprecated. 
Invalidate the specified cookie and delete it from the response object.

Parameters:
response - The HttpServletResponse object, known as "response" in a JSP page.
cookieName - The name of the cookie you want to delete.
path - of the path the cookie you want to delete.

getCookie

javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServletRequest request,
                                    String name)
Deprecated. 
Returns the specified Cookie object, or null if the cookie does not exist.

Parameters:
request - The HttpServletRequest object, known as "request" in a JSP page.
name - the name of the cookie.
Returns:
the Cookie object if it exists, otherwise null.

setCookie

javax.servlet.http.Cookie setCookie(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    String name,
                                    String value,
                                    int maxAge,
                                    String path)
Deprecated. 
Sets a cookie This will also put the cookie in a list of cookies to send with this request's response (so that in case of a redirect occurring down the chain, the first filter will always try to set this cookie again) The cookie secure flag is set if the request is secure.


getCookieValue

String getCookieValue(javax.servlet.http.HttpServletRequest request,
                      String name)
Deprecated. 
Returns the value of the specified cookie as a String. If the cookie does not exist, the method returns null.

Parameters:
request - the HttpServletRequest object, known as "request" in a JSP page.
name - the name of the cookie
Returns:
the value of the cookie, or null if the cookie does not exist.


Copyright © 2013 Atlassian. All Rights Reserved.