This plugin makes dealing with cookies easy. Provides an injectable service and tag to easily get, set, and delete cookies with one line.
It's RFC 6265 compliant.
To install the cookie plug-in just add to build.gradle:
implementation 'org.grails.plugins:cookie:2.0.5'
You can configure in Config.groovy or application.yml how long the default cookie age will be (in seconds) when not explicitly supplied while setting a cookie.
grails.plugins.cookie.cookieage.default = 86400 // if not specified default in code is 30 daysYou have two ways to work with cookies:
- The cookie plug-in extends the
requestandresponseobjects found in controllers, filters, etc to allow the following. - The cookie plug-in provides a CookieService that can be used anywhere in your Grails application.
Example of setting a new cookie:
// This sets a cookie with the name `username` to the value `cookieUser123` with a expiration set to a week, defined in seconds
response.setCookie('username', 'cookieUser123', 604800)
// will use default age from Config (or 30 days if not defined)
response.setCookie('username', 'cookieUser123')
// using service
def cookieService // define field for DI
...
cookieService.setCookie('username', 'cookieUser123', 604800)To get the cookie value:
request.getCookie('username') // returns 'cookieUser123'
// using service
def cookieService // define field for DI
...
cookieService.getCookie('username') // returns 'cookieUser123'To delete the cookie (actually it set new expired cookie with same name):
response.deleteCookie('username') // deletes the 'username' cookie
// using service
def cookieService // define field for DI
...
cookieService.deleteCookie('username')All this methods has other signatures and you can find all of them in CookieService JavaDoc's.
You can check out Demo project and also you can find details of implementation in CookieRequestSpec and CookieResponseSpec.
You can configure default values of attributes in Config.groovy.
Default expiration age for cookie in seconds. Max-Age attribute, integer.
If it has value -1 cookie will not stored and removed after browser close.
If it has null value or unset, will be used 30 days, i.e. 2592000 seconds.
Can't has value 0, because it means that cookie should be removed.
grails.plugins.cookie.cookieage.default = 360 * 24 * 60 * 60Default path for cookie selection strategy, string.
- 'context' - web app context path, i.e.
grails.app.contextoption inConfig.groovy - 'root' - root of server, i.e. '/'
- 'current' - current directory, i.e. controller name
If default path is null or unset, it will be used 'context' strategy
grails.plugins.cookie.path.defaultStrategy = 'context'Default secure cookie param. Secure cookie available only for HTTPS connections. Secure attribute, boolean.
If default secure is null or unset, it will set all new cookies as secure if current connection is secure
grails.plugins.cookie.secure.default = nullDefault HTTP Only param that denies accessing to JavaScript's document.cookie.
If null or unset will be true
grails.plugins.cookie.httpOnly.default = trueYou can find details of implementation in CookieServiceDefaultsSpec.
If you use property files to inject values to plugins at runtime. This is now supported as of version 1.0.2. This means that inside your external foo.properties file you can specify the following.
grails.plugins.cookie.httpOnly.default=trueThe string value will correctly be treated as a boolean.
- Bug fix for NPE on some find methods in groovy (Even though supposed to be null safe http://stackoverflow.com/questions/6866253/groovy-give-npe-on-list-find-call-but-only-after-a-period-of-time)
- Missed exclude for test service
- Syncing extension and plugin versions
- Testing for mocking of service which was causing issues in grails 3.0.10
- Minimal Grails version 2.4
- #35 option
grails.plugins.cookie.path.defaultStrategydoesn't work. - Minimal Grails version 2.2.0. But tests of plugin itself will failed. To run them use command
./grailsw test-appthat uses wrapper with Grails 2.4 - Minimal Java version is downgraded to 6
- Minimal Grails version 2.4.0. Plugin probably should work with early versions of Grails but init tests require v2.4.0
- #32 Add ability to externalize configuration by changing check for boolean from
instanceof BooleantotoBoolean()which will correctly address booleanfalseand string"false"properties
- #30 Default path strategy is 'context' and
grails.app.contextused null instead of actual context
- #17 Since v0.1 all deprecated things was removed:
* Tag
<cookie:get/>. Use standard<g:cookie/>tag instead. * Methodsget(),set(),delete()fromCookieService. They are replaced with correspondinggetCookie(),setCookie(),deleteCookie(). - #19 All cookies should be Version 1 (by RFC 2109) cookie specifications
- #22 Support of cookie attributes
- #10 Improved delete cookie method. Method delete cookie now can takes a domain name
- #28
setCookie()anddeleteCookie()should return added cookie - #25 Make default
path,secureandhttpOnlyconfigurable and more intelligent enhancement
- #3 Fixed
deleteCookienot works inresponse - #16 added tests
- #17 Since v0.5 few things was deprecated and will be removed in version v1.0:
* Tag
<cookie:get/>. Use standard<g:cookie/>tag instead. * Methodsget(),set(),delete()fromCookieService. They are replaced with correspondinggetCookie(),setCookie(),deleteCookie().
In the v0.3 release a big issue was fixed that now sets the cookie's path to the root / context.
Otherwise it was setting the path to the same as the controller/service that triggered it.
Most users I believe will want this behavior. If setting the path is desired, that can be accommodated.
Please contact me or do a pull request if you'd like that.