org.nustaq.kontraktor.weblication.ISessionStorage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kontraktor-web Show documentation

webapp utils/framework for kontraktor

The newest version!

package org.nustaq.kontraktor.weblication;

import org.nustaq.kontraktor.Callback;
import org.nustaq.kontraktor.IPromise;
import org.nustaq.reallive.api.Record;

import java.io.Serializable;
import java.util.function.Function;

/**
 * Created by ruedi on 20.06.17.
 *
 * Defines Persistance requirements. There is a default implementation based on memory mapped
 * files which should be sufficient for small to medium sized apps (<0.5 million user).
 *
 * The interface could be implemented backed by your favourite data base or data grid.
 */
public interface ISessionStorage {

    class Token implements Serializable {
        String userId;
        String data;
        long lifeTime;

        public Token(String userId, String data, long lifeTime) {
            this.userId = userId;
            this.data = data;
            this.lifeTime = lifeTime;
        }

        public String getUserId() {
            return userId;
        }

        public String getData() {
            return data;
        }

        public long getLifeTime() {
            return lifeTime;
        }
    }

    /**
     * creates a persisted token associated with the user and data. (e.g. a pending confirmation email)
     *
     * @return a unique string identifier
     */
    IPromise createToken(Token t);

    /**
     * retrieves the token if it is present and valid (not timed out)
     *
     * @return
     */
    IPromise takeToken(String tokenId, boolean delete);

    IPromise getUserFromSessionId(String sid);
    void putUserAtSessionId(String sessionId, String userKey);

    void delUser(String userkey);
    IPromise getUser(String userId);
    void putUser(Record userRecord);
    IPromise putUserIfNotPresent(Record userRecord);

    /**
     * stream all user records to the given callback and close it calling cb.finish()
     * @param cb
     */
    void forEachUser(Callback cb);
}