com.feilong.accessor.session.SessionAccessor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.accessor.session;

import java.io.Serializable;

import javax.servlet.http.HttpServletRequest;

/**
 * 基于session的key是固定的寄存器实现.
 * 
 * 
 * 场景: 适用于 

 * 
 * spring xml 配置:
 * 
 * 
{@code
  
        
    
}
 * 
 * 
 * 代码使用:
 * 
 *  * 
 * @Autowired
 * @Qualifier("memberDetailsSessionAccessor")
 * private SessionAccessor memberDetailsSessionAccessor;
 * 
 * private void putMemberInSession(MemberCommand memberCommand,HttpServletRequest request,HttpServletResponse response){
 *  ...
 *  SsoMemberCommand ssoMember = memberManager.memberCommandConvertToSsoMemberCommand(memberCommand);
 *  memberDetailsSessionAccessor.save(ssoMember, request);
 *  ...
 * }
 * 
 * 
 * 这种固定 key 的场景
 * 
 *
 * @author feilong
 * @since 1.10.6
 */
public class SessionAccessor extends AbstractSessionKeyAccessor{

    /** The key. */
    private String key;

    //---------------------------------------------------------------

    /**
     * Instantiates a new session accessor.
     */
    public SessionAccessor(){
    }

    /**
     * Instantiates a new session accessor.
     *
     * @param key
     *            the key
     */
    public SessionAccessor(String key){
        this.key = key;
    }

    //---------------------------------------------------------------
    /**
     * Save.
     *
     * @param serializable
     *            the serializable
     * @param request
     *            the request
     */
    public void save(Serializable serializable,HttpServletRequest request){
        super.commonSave(key, serializable, request);
    }

    /**
     * 获得.
     *
     * @param 
     *            the generic type
     * @param request
     *            the request
     * @return the t
     */
    public  T get(HttpServletRequest request){
        return super.get(key, request);
    }

    /**
     * 删除.
     *
     * @param request
     *            the request
     */
    public void remove(HttpServletRequest request){
        super.remove(key, request);
    }

    //---------------------------------------------------------------

    /**
     * 设置 key.
     *
     * @param key
     *            the key to set
     */
    public void setKey(String key){
        this.key = key;
    }

    /**
     * 获得 key.
     *
     * @return the key
     */
    public String getKey(){
        return key;
    }
}