org.atmosphere.cpr.SessionTimeoutRestorer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atmosphere-runtime Show documentation
There is a newer version: 3.0.13
/*
* Copyright 2008-2024 Async-IO.org
*
* 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.atmosphere.cpr;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import jakarta.servlet.http.HttpSession;
import jakarta.servlet.http.HttpSessionActivationListener;
import jakarta.servlet.http.HttpSessionEvent;
import java.io.Serializable;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * Capable of restoring HTTP session timeout to given value.
 *
 * @since 0.9
 * @author Miro Bezjak
 */
public final class SessionTimeoutRestorer implements Serializable, HttpSessionActivationListener {
    private static final Logger logger = LoggerFactory.getLogger(SessionTimeoutRestorer.class);

    private static final long serialVersionUID = -126253550299206646L;

    private final int timeout;

    private final AtomicInteger requestCount = new AtomicInteger(0);
    private final int internalSessionTimeout;

    public SessionTimeoutRestorer(AtmosphereConfig config, int timeout) {
        this.timeout = timeout;
        String s = config.getInitParameter(ApplicationConfig.SESSION_MAX_INACTIVE_INTERVAL);
        if (s != null) {
            internalSessionTimeout = Integer.parseInt(s);
        } else {
            internalSessionTimeout = -1;
        }
    }

    public void setup(HttpSession session) {
        int oldCount = requestCount.getAndIncrement();
        logger.trace("requestCount => {}",requestCount );

        if (oldCount == 0)
            refreshTimeout(session);
    }

    public void restore(HttpSession session) {
        int count = requestCount.decrementAndGet();
        logger.trace("requestCount <= {}",requestCount );

        if (count == 0)
            refreshTimeout(session);
    }

    // Synchronization ensures timeout updates are thread-safe, and the additional check makes sure we know
    // precisely what the timeout should be.
    private synchronized void refreshTimeout(HttpSession session) {
        if (requestCount.get() > 0)
            session.setMaxInactiveInterval(internalSessionTimeout);
        else
            session.setMaxInactiveInterval(timeout);
    }

    @Override
    public void sessionWillPassivate(HttpSessionEvent hse) {
        requestCount.set(0);
        refreshTimeout(hse.getSession());
    }

    @Override
    public void sessionDidActivate(HttpSessionEvent hse) {
    }

    @Override
    public String toString() {
        String sb = "SessionTimeoutRestorer[timeout=" +
                timeout +
                ", requestCount=" +
                requestCount.get() +
                ']';
        return sb;
    }

}