/*
 * Copyright 2014 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.web;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;

import java.util.Map;

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 SessionHandler for sessions to be available.

Author:Tim Fox
/** * Represents a browser session. * <p> * 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. * <p> * Sessions can be used to maintain data for a browser session, e.g. a shopping basket. * <p> * The context must have first been routed to a {@link io.vertx.ext.web.handler.SessionHandler} * for sessions to be available. * * @author <a href="http://tfox.org">Tim Fox</a> */
@VertxGen public interface Session {
Returns:The new unique ID of the session.
/** * @return The new unique ID of the session. */
Session regenerateId();
Returns:The unique ID of the session. This is generated using a random secure UUID.
/** * @return The unique ID of the session. This is generated using a random secure UUID. */
String id();
Put some data in a session
Params:
  • key – the key for the data
  • obj – the data
Returns:a reference to this, so the API can be used fluently
/** * 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 */
@Fluent Session put(String key, Object obj);
Get some data from the session
Params:
  • key – the key of the data
Returns: the data
/** * Get some data from the session * * @param key the key of the data * @return the data */
<T> T get(String key);
Remove some data from the session
Params:
  • key – the key of the data
Returns: the data that was there or null if none there
/** * Remove some data from the session * * @param key the key of the data * @return the data that was there or null if none there */
<T> T remove(String key);
Returns:the session data as a map
/** * @return the session data as a map */
@GenIgnore(GenIgnore.PERMITTED_TYPE) Map<String, Object> data();
Returns:true if the session has data
/** * @return true if the session has data */
boolean isEmpty();
Returns:the time the session was last accessed
/** * @return the time the session was last accessed */
long lastAccessed();
Destroy the session
/** * Destroy the session */
void destroy();
Returns:has the session been destroyed?
/** * @return has the session been destroyed? */
boolean isDestroyed();
Returns:has the session been renewed?
/** * @return has the session been renewed? */
boolean isRegenerated();
Returns:old ID if renewed
/** * @return old ID if renewed */
String oldId();
Returns:the amount of time in ms, after which the session will expire, if not accessed.
/** * @return the amount of time in ms, after which the session will expire, if not accessed. */
long timeout();
Mark the session as being accessed.
/** * Mark the session as being accessed. */
void setAccessed();
The short representation of the session to be added to the session cookie. By default is the session id.
Returns:short representation string.
/** * The short representation of the session to be added to the session cookie. By default is the session id. * * @return short representation string. */
default String value() { return id(); } }