io.vertx.groovy.ext.web.Session.groovy Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.vertx.groovy.ext.web;
import groovy.transform.CompileStatic
import io.vertx.lang.groovy.InternalHelper
import io.vertx.core.json.JsonObject
/**
* Represents a browser session.
*
* Sessions persist between HTTP requests for a single browser session. They are deleted when the browser is closed, or
* they time-out. Session cookies are used to maintain sessions using a secure UUID.
*
* Sessions can be used to maintain data for a browser session, e.g. a shopping basket.
*
* The context must have first been routed to a {@link io.vertx.groovy.ext.web.handler.SessionHandler}
* for sessions to be available.
*/
@CompileStatic
public class Session {
private final def io.vertx.ext.web.Session delegate;
public Session(Object delegate) {
this.delegate = (io.vertx.ext.web.Session) delegate;
}
public Object getDelegate() {
return delegate;
}
/**
* @return The unique ID of the session. This is generated using a random secure UUID.
* @return
*/
public String id() {
def ret = delegate.id();
return ret;
}
/**
* Put some data in a session
* @param key the key for the data
* @param obj the data
* @return a reference to this, so the API can be used fluently
*/
public Session put(String key, Object obj) {
delegate.put(key, obj != null ? InternalHelper.unwrapObject(obj) : null);
return this;
}
/**
* Get some data from the session
* @param key the key of the data
* @return the data
*/
public T get(String key) {
def ret = (T) InternalHelper.wrapObject(delegate.get(key));
return ret;
}
/**
* Remove some data from the session
* @param key the key of the data
* @return the data that was there or null if none there
*/
public T remove(String key) {
def ret = (T) InternalHelper.wrapObject(delegate.remove(key));
return ret;
}
/**
* @return the time the session was last accessed
* @return
*/
public long lastAccessed() {
def ret = delegate.lastAccessed();
return ret;
}
/**
* Destroy the session
*/
public void destroy() {
delegate.destroy();
}
/**
* @return has the session been destroyed?
* @return
*/
public boolean isDestroyed() {
def ret = delegate.isDestroyed();
return ret;
}
/**
* @return the amount of time in ms, after which the session will expire, if not accessed.
* @return
*/
public long timeout() {
def ret = delegate.timeout();
return ret;
}
/**
* Mark the session as being accessed.
*/
public void setAccessed() {
delegate.setAccessed();
}
}