templates.plugins.spincast-cookies.spincast-cookies.html Maven / Gradle / Ivy
Show all versions of spincast-website Show documentation
{#==========================================
Spincast Cookies plugin
==========================================#}
{% extends "../../layout.html" %}
{% block sectionClasses %}plugins plugins-spincast-cookies{% endblock %}
{% block meta_title %}Plugins - Spincast Cookies{% endblock %}
{% block meta_description %}Spincast Cookies plugin provides functionalities to read and write cookies.{% endblock %}
{% block scripts %}
{% endblock %}
{% block body %}
Plugins- Spincast Cookies plugin
Overview
The Spincast Cookies plugin provides functionalities
to read and write cookies. It mainly consists of a request context add-on :
"ICookiesRequestContextAddon", which is
mounted as .cookies() on the default Spincast request context.
The plugin also provides an implementation for the "ICookie" object.
Installation
If you use the spincast-default artifact, this plugin is already installed so
you have nothing more to do!
If you start from scratch using the spincast-core artifact, you can use the
plugin by adding this artifact to your project:
<dependency>
<groupId>org.spincast</groupId>
<artifactId>spincast-plugins-cookies</artifactId>
<version>{{spincastCurrrentVersion}}</version>
</dependency>
You then install the plugin's Guice module, by passing it to the Guice.createInjector(...) method:
Injector guice = Guice.createInjector(
new SpincastCoreGuiceModule(args),
new SpincastCookiesPluginGuiceModule(IAppRequestContext.class, IAppWebsocketContext.class)
// other modules...
);
... or by using the install(...) method from your custom Guice module:
public class AppModule extends SpincastCoreGuiceModule {
@Override
protected void configure() {
super.configure();
install(new SpincastCookiesPluginGuiceModule(getRequestContextType(),
getWebsocketContextType()));
// other modules...
}
// ...
}
The request context add-on
Quick example :
public void myHandler(IAppRequestContext context) {
ICookie myCookie = context.cookies().getCookie("myCookie");
if(myCookie != null) {
System.out.println(myCookie.getName() + " : " + myCookie.getValue());
}
//...
}
Methods :
-
Map<String, ICookie> getCookies()
Gets the current cookies in a Map, using their names as the keys.
-
ICookie getCookie(String name)
Gets a cookie.
-
void addCookie(ICookie cookie)
Adds a cookie.
-
void addCookie(String name, String value)
Adds a cookie using the specified name and value.
-
void addCookie(String name, String value, String path, String domain, Date expires, boolean secure, boolean httpOnly, boolean discard, int version)
Adds a cookie, using all possible configurations.
-
void deleteCookie(String name)
Deletes a cookie. In fact, this sets the cookie's expires date in the
past so the user's browser will remove it.
isExpired() will return true after you called
this method.
-
void deleteAllCookies()
Deletes all cookies. In fact, this sets their expires date in the
past so the user's browser will remove them.
-
void resetCookies()
Resets the current cookies to the original ones
of the request.
Creating a new cookie
Using the add-on
You can create a new cookie directly from your request context object. This is by far the
easiest way to do it:
public void myHandler(IAppRequestContext context) {
context.cookies().addCookie("myCookie", "some value");
}
Using the ICookieFactory factory
When you don't have access to the request context object directly, for example if you have
some kind of service which creates the cookie and passes it back to your
route handler, you can use the ICookieFactory factory. Why a factory and not simply
use "ICookie cookie = new Cookie()"? Well, technically you can do that too. But
using a Guice's assisted factory allows
your cookie implementation to easily have access to any dependencies it needs.
public class AppService {
private final ICookieFactory cookieFactory;
@Inject
public AppService(ICookieFactory cookieFactory) {
this.cookieFactory = cookieFactory;
}
protected ICookieFactory getCookieFactory() {
return this.cookieFactory;
}
public ICookie someServiceMethod() {
ICookie cookie = getCookieFactory().createCookie("myCookie", "some value");
return cookie;
}
}
Factory methods :
-
ICookie createCookie(@Assisted("name") String name)
Creates a cookie using the given name (null value).
-
ICookie createCookie(@Assisted("name") String name, @Assisted("value") String value)
Creates a cookie using the given name and value.
-
ICookie createCookie(@Assisted("name") String name, @Assisted("value") String value, @Assisted("path") String path, @Assisted("domain") String domain, @Assisted("expires") Date expires, @Assisted("secure") boolean secure, @Assisted("httpOnly") boolean httpOnly, @Assisted("discard") boolean discard, @Assisted("version") int version)
Creates a cookie using all possible configurations.
The ICookie object
The ICookie represents an HTTP cookie. This is what you get
when you read a cookie and what you need to provide to write one.
Methods :
-
String getName()
Gets the cookie name.
-
String getValue()
Gets the cookie value.
-
void setValue(String value)
Sets the cookie value.
-
String getPath()
Gets the cookie path.
-
void setPath(String path)
Sets the cookie path.
-
String getDomain()
Gets the cookie domain.
-
void setDomain(String domain)
Sets the cookie domain.
-
Date getExpires()
Gets the date the cookie will expire at.
If the date is in the past, the cookie will be deleted.
If null the cookie will live for the current session
(this is the default).
-
void setExpires(Date expires)
Sets the date the cookie will expire.
If the date is in the past, the cookie will be deleted.
If null the cookie will live for the current session
(this is the default).
-
void setExpiresUsingMaxAge(Integer maxAge)
Sets the number of seconds for a cookie to live.
If maxAge < 0 : The "Expires date" will be in the past and the cookie will
therefore be deleted.
If maxAge == 0 : The "Expires date" will be null and the cookie will live
for the session only.
If maxAge > 0 : The "Expires date" will be the current date + 'maxAge' seconds.
-
boolean isExpired()
Is this cookie expired?
-
boolean isSecure()
Is the "secure" feature on?
-
void setSecure(boolean secure)
Sets the "secure" feature on or off.
-
boolean isHttpOnly()
Is the cookie availableto the server
and not to javascript?
-
void setHttpOnly(boolean httpOnly)
Sets if the cookie is available only for to the server
anbd not to javascript.
-
boolean isDiscard()
Is this cookie to be discarded?
-
int getVersion()
Gets the cookie version.
{% endblock %}
Spincast Cookies 
Spincast Cookies