001/*
002 * (C) Copyright 2006-2008 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 */
019
020package org.nuxeo.ecm.platform.ui.web.auth.interfaces;
021
022import javax.servlet.ServletRequest;
023import javax.servlet.http.HttpSession;
024
025import org.nuxeo.ecm.platform.ui.web.auth.CachableUserIdentificationInfo;
026
027/**
028 * SessionManager interface for Authentication Filter.
029 *
030 * @author tiry
031 */
032public interface NuxeoAuthenticationSessionManager {
033
034    /**
035     * Checks whether or not this request was made to perform login. This is tested by the authentication filter to
036     * decide if a switch user is needed.
037     */
038    boolean needResetLogin(ServletRequest req);
039
040    /**
041     * Returns true if request does not require to be authenticated.
042     */
043    boolean canBypassRequest(ServletRequest request);
044
045    /**
046     * May invalidates the session. Return true is the session was invalidated.
047     */
048    boolean invalidateSession(ServletRequest request);
049
050    /**
051     * CallBack before SessionReinit.
052     */
053    void onBeforeSessionReinit(ServletRequest request);
054
055    /**
056     * CallBack after SessionReinit.
057     */
058    void onAfterSessionReinit(ServletRequest request);
059
060    /**
061     * CallBack for session creation
062     */
063    void onAuthenticatedSessionCreated(ServletRequest request, HttpSession session,
064            CachableUserIdentificationInfo cachebleUserInfo);
065
066}