org.jgrapes.http.InMemorySession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.jgrapes.http Show documentation
(No description)
The newest version!
/*
 * JGrapes Event Driven Framework
 * Copyright (C) 2017-2018 Michael N. Lipp
 * 
 * This program is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Affero General Public License as published by 
 * the Free Software Foundation; either version 3 of the License, or 
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
 * for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License along 
 * with this program; if not, see .
 */

package org.jgrapes.http;

import java.io.Serializable;
import java.time.Instant;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Implements the {@link Session} interface using a {@link ConcurrentHashMap}.
 */
@SuppressWarnings("serial")
public class InMemorySession
        extends ConcurrentHashMap
        implements Session {

    @SuppressWarnings("PMD.ShortVariable")
    private final String id;
    private final Instant createdAt;
    private Instant lastUsedAt;
    private final Map transientData = new ConcurrentHashMap<>();
    private boolean beingDiscarded;

    /**
     * Create a new session.
     */
    @SuppressWarnings("PMD.ShortVariable")
    public InMemorySession(String id) {
        this.id = id;
        createdAt = Instant.now();
        lastUsedAt = createdAt;
    }

    /**
     * Returns the session id.
     * 
     * @return the id
     */
    @SuppressWarnings("PMD.ShortMethodName")
    public String id() {
        return id;
    }

    /**
     * Returns the creation time stamp.
     * 
     * @return the creation time stamp
     */
    public Instant createdAt() {
        return createdAt;
    }

    /**
     * Returns the last used (referenced in request) time stamp. 
     * 
     * @return the last used timestamp
     */
    public Instant lastUsedAt() {
        return lastUsedAt;
    }

    /**
     * Updates the last used time stamp.
     */
    public void updateLastUsedAt() {
        this.lastUsedAt = Instant.now();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.jgrapes.http.Session#transientData()
     */
    @Override
    public Map transientData() {
        return transientData;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return id.hashCode();
    }

    /**
     * Marks the session as to be removed.
     *
     * @return false, if called before (session is already being discarded)
     */
    public boolean setBeingDiscarded() {
        boolean result = !beingDiscarded;
        beingDiscarded = true;
        return result;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        @SuppressWarnings("PMD.LooseCoupling")
        InMemorySession other = (InMemorySession) obj;
        if (id == null) {
            if (other.id != null) {
                return false;
            }
        } else if (!id.equals(other.id)) {
            return false;
        }
        return true;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder(50);
        builder.append("InMemorySession [");
        if (id != null) {
            builder.append("id=").append(id).append(", ");
        }
        if (createdAt != null) {
            builder.append("createdAt=").append(createdAt).append(", ");
        }
        if (lastUsedAt != null) {
            builder.append("lastUsedAt=").append(lastUsedAt);
        }
        builder.append(']');
        return builder.toString();
    }

}