lumis.util
Class CookieUtil

Package class diagram package CookieUtil
java.lang.Object
  extended by lumis.util.CookieUtil

@StableMinor(version="5.5",
             sinceVersion="4.0")
public class CookieUtil
extends Object

Utility methods for cookies manipulation.

Since:
4.0.7

Constructor Summary
CookieUtil()
           
 
Method Summary
static void addLumisUserCookies(HttpServletRequest request, HttpServletResponse response)
          Adds lumis user information cookies.
static void addLumisUserCookies(IServiceInterfaceRequest request, IServiceInterfaceResponse response)
          Adds lumis user information cookies.
static void deleteCookie(HttpServletRequest request, HttpServletResponse response, String name)
          Deletes the cookie if it exists in the request.
static void deleteCookie(IServiceInterfaceRequest request, IServiceInterfaceResponse response, String name)
          Deletes the cookie if it exists in the request.
static void deleteLumisStandardCookies(HttpServletRequest request, HttpServletResponse response)
          Delete lumis standard cookies.
static void deleteLumisStandardCookies(IServiceInterfaceRequest request, IServiceInterfaceResponse response)
          Delete lumis standard cookies.
static void deleteLumisUserCookies(HttpServletRequest request, HttpServletResponse response)
          Delete lumis user information cookies.
static void deleteLumisUserCookies(IServiceInterfaceRequest request, IServiceInterfaceResponse response)
          Delete lumis user information cookies.
static String getCookie(HttpServletRequest request, String name)
          Given a cookie name, the cookie value if exists in the request object is returned.
static String getCookie(IServiceInterfaceRequest request, String name)
          Given a cookie name, the cookie value if exists in the request object is returned.
static void setCookie(HttpServletRequest request, HttpServletResponse response, String name, String value)
          Sets a cookie value.
static void setCookie(IServiceInterfaceRequest request, IServiceInterfaceResponse response, String name, String value)
          Sets a cookie value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CookieUtil

public CookieUtil()
Method Detail

getCookie

public static String getCookie(IServiceInterfaceRequest request,
                               String name)
Given a cookie name, the cookie value if exists in the request object is returned. If the cookie is not found, a null value is returned

Parameters:
request - the request.
response - the response.
name - the cookie name.
Returns:
cookie value
Since:
4.0.7

getCookie

public static String getCookie(HttpServletRequest request,
                               String name)
Given a cookie name, the cookie value if exists in the request object is returned. If the cookie is not found, a null value is returned

Parameters:
request - the request.
response - the response.
name - the cookie name.
Returns:
cookie value
Since:
4.0.7

setCookie

public static void setCookie(IServiceInterfaceRequest request,
                             IServiceInterfaceResponse response,
                             String name,
                             String value)
Sets a cookie value.

Parameters:
request - the request.
response - the response.
name - the cookie name.
value - the cookie value.
Since:
4.0.7

setCookie

public static void setCookie(HttpServletRequest request,
                             HttpServletResponse response,
                             String name,
                             String value)
Sets a cookie value.

Parameters:
request - the request.
response - the response.
name - the cookie name.
value - the cookie value.
Since:
4.0.7

deleteCookie

public static void deleteCookie(IServiceInterfaceRequest request,
                                IServiceInterfaceResponse response,
                                String name)
Deletes the cookie if it exists in the request.

Parameters:
request - the request.
response - the response.
name - the cookie name.
Since:
4.0.7

deleteCookie

public static void deleteCookie(HttpServletRequest request,
                                HttpServletResponse response,
                                String name)
Deletes the cookie if it exists in the request.

Parameters:
request - the request.
response - the response.
name - the cookie name.
Since:
4.0.7

deleteLumisUserCookies

public static void deleteLumisUserCookies(IServiceInterfaceRequest request,
                                          IServiceInterfaceResponse response)
Delete lumis user information cookies.

Parameters:
request - the request.
response - the response.
Since:
4.0.7

deleteLumisUserCookies

public static void deleteLumisUserCookies(HttpServletRequest request,
                                          HttpServletResponse response)
Delete lumis user information cookies.

Parameters:
request - the request.
response - the response.
Since:
4.0.7

addLumisUserCookies

public static void addLumisUserCookies(IServiceInterfaceRequest request,
                                       IServiceInterfaceResponse response)
                                throws PortalException
Adds lumis user information cookies.

Parameters:
request - the request.
response - the response.
Throws:
PortalException - if it was not possible to obtain the data necessary to set the cookies.
Since:
4.0.7

addLumisUserCookies

public static void addLumisUserCookies(HttpServletRequest request,
                                       HttpServletResponse response)
                                throws PortalException
Adds lumis user information cookies.

Parameters:
request - the request.
response - the response.
Throws:
PortalException - if it was not possible to obtain the data necessary to set the cookies.
Since:
4.0.7

deleteLumisStandardCookies

public static void deleteLumisStandardCookies(IServiceInterfaceRequest request,
                                              IServiceInterfaceResponse response)
Delete lumis standard cookies. Also deletes the lumis user information cookies.

Parameters:
request - the request.
response - the response.
Since:
4.0.7

deleteLumisStandardCookies

public static void deleteLumisStandardCookies(HttpServletRequest request,
                                              HttpServletResponse response)
Delete lumis standard cookies. Also deletes the lumis user information cookies.

Parameters:
request - the request.
response - the response.
Since:
4.0.7


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.