io.vertx.ext.web.sstore.impl.ClusteredSessionStoreImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-web Show documentation
There is a newer version: 5.0.0.CR1
/*
 * 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.sstore.impl;

import io.vertx.codegen.annotations.Nullable;
import io.vertx.core.Future;
import io.vertx.core.Vertx;
import io.vertx.core.impl.ContextInternal;
import io.vertx.core.impl.VertxInternal;
import io.vertx.core.json.JsonObject;
import io.vertx.core.shareddata.AsyncMap;
import io.vertx.ext.auth.VertxContextPRNG;
import io.vertx.ext.web.Session;
import io.vertx.ext.web.sstore.AbstractSession;
import io.vertx.ext.web.sstore.ClusteredSessionStore;
import io.vertx.ext.web.sstore.SessionStore;

/**
 * @author Tim Fox
 */
public class ClusteredSessionStoreImpl implements SessionStore, ClusteredSessionStore {

  /**
   * The default name used for the session map
   */
  private static final String DEFAULT_SESSION_MAP_NAME = "vertx-web.sessions";

  /**
   * Default retry time out, in ms, for a session not found in this store.
   */
  private static final long DEFAULT_RETRY_TIMEOUT = 5 * 1000; // 5 seconds


  private VertxInternal vertx;
  private VertxContextPRNG random;
  private String sessionMapName;
  private long retryTimeout;

  // Clustered Map
  private volatile AsyncMap sessionMap;

  @Override
  public SessionStore init(Vertx vertx, JsonObject options) {
    this.vertx = (VertxInternal) vertx;
    this.sessionMapName = options.getString("mapName", DEFAULT_SESSION_MAP_NAME);
    this.retryTimeout = options.getLong("retryTimeout", DEFAULT_RETRY_TIMEOUT);
    this.random = VertxContextPRNG.current(vertx);

    return this;
  }

  @Override
  public long retryTimeout() {
    return retryTimeout;
  }

  @Override
  public Session createSession(long timeout) {
    return new SharedDataSessionImpl(random, timeout, DEFAULT_SESSIONID_LENGTH);
  }

  @Override
  public Session createSession(long timeout, int length) {
    return new SharedDataSessionImpl(random, timeout, length);
  }

  @Override
  public Future<@Nullable Session> get(String id) {
    return getMap()
      .compose(map ->
        map.get(id)
          .onSuccess(session -> {
            if (session != null) {
              ((AbstractSession) session).setPRNG(random);
            }
          }));
  }

  @Override
  public Future delete(String id) {
    return getMap()
      .compose(map -> map.remove(id))
      .mapEmpty();
  }

  @Override
  public Future put(Session session) {
    final ContextInternal ctx = vertx.getOrCreateContext();
    return getMap()
      .compose(map ->
        // we need to take care of the transactionality of session data
        map.get(session.id())
          .compose(old -> {
            final AbstractSession oldSession = (AbstractSession) old;
            final AbstractSession newSession = (AbstractSession) session;

            if (oldSession != null) {
              // there was already some stored data in this case we need to validate versions
              if (oldSession.version() != newSession.version()) {
                return ctx.failedFuture("Session version mismatch");
              }
            }

            // we can now safely store the new version
            newSession.incrementVersion();

            return map.put(session.id(), session, session.timeout());
          })
      );
  }

  @Override
  public Future clear() {
    return getMap()
      .compose(AsyncMap::clear);
  }

  @Override
  public Future size() {
    return getMap()
      .compose(AsyncMap::size);
  }

  @Override
  public void close() {
  }

  private Future> getMap() {
    if (sessionMap == null) {
      return vertx.sharedData()
        .getClusterWideMap(sessionMapName)
        .onSuccess(sessionMap -> this.sessionMap = sessionMap);
    } else {
      final ContextInternal ctx = vertx.getOrCreateContext();
      return ctx.succeededFuture(sessionMap);
    }
  }
}