org.acegisecurity.concurrent.SessionInformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
There is a newer version: 1.0.7
/* Copyright 2004, 2005 Acegi Technology Pty Limited
 *
 * 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 org.acegisecurity.concurrent;

import org.springframework.util.Assert;

import java.util.Date;


/**
 * Represents a record of a session within the Acegi Security framework.
 * 
 * 
 * This is primarily used for concurrent session support.
 * 
 * 
 * 
 * Sessions have three states: active, expired, and destroyed. A session can
 * that is invalidated by session.invalidate() or via Servlet
 * Container management is considered "destroyed". An "expired" session, on
 * the other hand, is a session that Acegi Security wants to end because it
 * was selected for removal for some reason (generally as it was the least
 * recently used session and the maximum sessions for the user were reached).
 * An "expired" session is removed as soon as possible by a
 * Filter.
 * 
 *
 * @author Ben Alex
 * @version $Id: SessionInformation.java,v 1.2 2005/11/17 00:55:56 benalex Exp $
 */
public class SessionInformation {
    //~ Instance fields ========================================================

    private Date lastRequest;
    private Object principal;
    private String sessionId;
    private boolean expired = false;

    //~ Constructors ===========================================================

    public SessionInformation(Object principal, String sessionId,
        Date lastRequest) {
        Assert.notNull(principal, "Principal required");
        Assert.hasText(sessionId, "SessionId required");
        Assert.notNull(lastRequest, "LastRequest required");
        this.principal = principal;
        this.sessionId = sessionId;
        this.lastRequest = lastRequest;
    }

    private SessionInformation() {}

    //~ Methods ================================================================

    public boolean isExpired() {
        return expired;
    }

    public Date getLastRequest() {
        return lastRequest;
    }

    public Object getPrincipal() {
        return principal;
    }

    public String getSessionId() {
        return sessionId;
    }

    public void expireNow() {
        this.expired = true;
    }

    /**
     * Refreshes the internal lastRequest to the current date and time.
     */
    public void refreshLastRequest() {
        this.lastRequest = new Date();
    }
}