org.richfaces.application.push.SessionManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of richfaces-core Show documentation

The RichFaces core framework.

The newest version!

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.richfaces.application.push;

/**
 * Session manager is a registry of all active sessions that maintains their state and provides wipe out for expired sessions.
 *
 * @author Nick Belaevski
 */
public interface SessionManager {

    /**
     * Registers session to the system
     */
    void putPushSession(Session pushSession) throws IllegalStateException;

    /**
     * Look ups session with given ID
     */
    Session getPushSession(String id);

    /**
     * Re-queues given session without actually adding it when it is not registered yet via {@link #putPushSession(Session)}.
     */
    void requeue(Session session);

    /**
     * Destroys all associated sessions
     */
    void destroy();
}