Package lumis.util

Class CookieUtil

java.lang.Object

lumis.util.CookieUtil

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

Utility methods for cookies manipulation.

Since:

4.0.7

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Constructor Summary

Constructors

Constructor	Description
CookieUtil()

Method Summary

Modifier and Type	Method	Description
static void	addLumisAppCookie(HttpServletRequest request, HttpServletResponse response)
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	deleteAutoAdministrationCookies(HttpServletRequest request, HttpServletResponse response)	Delete lumis auto-administration 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(HttpServletRequest request, HttpServletResponse response, String name, String value, Date expiration)	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

setCookie

public static void setCookie(HttpServletRequest request,
                             HttpServletResponse response,
                             String name,
                             String value,
                             Date expiration)

Sets a cookie value.

Parameters:

request - the request.

response - the response.

name - the cookie name.

value - the cookie value.

expiration - the cookie expiration date.

Since:

10.1.0

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

addLumisAppCookie

public static void addLumisAppCookie(HttpServletRequest request,
                                     HttpServletResponse response)

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 and auto-administration cookies.

Parameters:

request - the request.

response - the response.

Since:

4.0.7

deleteAutoAdministrationCookies

public static void deleteAutoAdministrationCookies(HttpServletRequest request,
                                                   HttpServletResponse response)

Delete lumis auto-administration cookies.

Parameters:

request - the request.

response - the response.

Since:

7.0.0