All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.github.streamone.shiro.session.RedissonSessionDao Maven / Gradle / Ivy

    Go to download

    A redis based implementation of Shiro Cache, using redisson for basic capabilities.

    The newest version!
    package com.github.streamone.shiro.session;

import org.apache.shiro.session.Session;
import org.apache.shiro.session.UnknownSessionException;
import org.apache.shiro.session.mgt.eis.AbstractSessionDAO;
import org.apache.shiro.session.mgt.eis.SessionDAO;
import org.redisson.RedissonScript;
import org.redisson.api.RScript;
import org.redisson.api.RedissonClient;
import org.redisson.client.codec.Codec;
import org.redisson.codec.JsonJacksonCodec;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * 
    A {@link SessionDAO} implementation backed by Redisson Objects.
    
 *
 * @author streamone
 */
public class RedissonSessionDao extends AbstractSessionDAO {

    public static final String SESSION_INFO_KEY_PREFIX = "session:info:";
    public static final String SESSION_ATTR_KEY_PREFIX = "session:attr:";

    private RedissonClient redisson;
    private Codec codec = new JsonJacksonCodec();

    @Override
    protected Serializable doCreate(Session session) {
        Serializable sessionId = generateSessionId(session);
        assignSessionId(session, sessionId);
        String infoKey = getSessionInfoKey(sessionId.toString());
        String attrKey = getSessionAttrKey(sessionId.toString());
        new RedissonSession(this.redisson, this.codec, infoKey, attrKey, session);
        return sessionId;
    }

    @Override
    protected Session doReadSession(Serializable sessionId) {
        String infoKey = getSessionInfoKey(sessionId.toString());
        String attrKey = getSessionAttrKey(sessionId.toString());
        List keys = new ArrayList<>(1);
        keys.add(infoKey);

        RedissonScript script = (RedissonScript) this.redisson.getScript(this.codec);
        Long remainTimeToLive = script.eval(infoKey, RScript.Mode.READ_ONLY,
                RedissonSessionScript.READ_SCRIPT,
                RScript.ReturnType.INTEGER, keys);

        if (remainTimeToLive > 0) {
            return new RedissonSession(this.redisson, this.codec, infoKey, attrKey, sessionId);
        } else {
            return null;
        }
    }

    @Override
    public void update(Session session) throws UnknownSessionException {
        //do nothing, the RedissonSession will update the session in redis directly
    }

    @Override
    public void delete(Session session) {
        if (session == null || session.getId() == null || "".equals(session.getId())) {
            return;
        }
        Serializable sessionId = session.getId();
        String infoKey = getSessionInfoKey(sessionId.toString());
        String attrKey = getSessionAttrKey(sessionId.toString());
        List keys = new ArrayList<>(2);
        keys.add(infoKey);
        keys.add(attrKey);

        RedissonScript script = (RedissonScript) this.redisson.getScript(this.codec);
        script.eval(infoKey, RScript.Mode.READ_WRITE,
            RedissonSessionScript.DELETE_SCRIPT,
            RScript.ReturnType.VALUE, keys);
    }

    @Override
    public Collection getActiveSessions() {
        //for performance reasons, this method should not be called
        return Collections.EMPTY_LIST;
    }

    /**
     * 
    Get key name by session id for binding a RMap to store basic informations of the session.
    
     * 
    
     *  In redis cluster, key hash tags ensure that the binding RMaps of a session are allocated in the
     *  same hash slot.
     *  https://redis.io/topics/cluster-spec#keys-hash-tags
     * 
    
     *
     * @param sessionId the session id
     * @return key name
     */
    protected String getSessionInfoKey(String sessionId) {
        StringBuilder name = new StringBuilder(SESSION_INFO_KEY_PREFIX);
        name.append("{").append(sessionId).append("}");
        return name.toString();
    }

    /**
     * 
    Get key name by session id for binding a RMap to store attributes of the session.
    
     * 
    
     *  In redis cluster, key hash tags ensure that the binding RMaps of a session are allocated in the
     *  same hash slot.
     *  https://redis.io/topics/cluster-spec#keys-hash-tags
     * 
    
     *
     * @param sessionId the session id
     * @return key name
     */
    protected String getSessionAttrKey(String sessionId) {
        StringBuilder name = new StringBuilder(SESSION_ATTR_KEY_PREFIX);
        name.append("{").append(sessionId).append("}");
        return name.toString();
    }

    public RedissonClient getRedisson() {
        return redisson;
    }

    public void setRedisson(RedissonClient redisson) {
        this.redisson = redisson;
    }

    public Codec getCodec() {
        return codec;
    }

    public void setCodec(Codec codec) {
        this.codec = codec;
    }
}    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy