// Copyright 2006, 2008, 2020 The Apache Software Foundation
//
// 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.apache.tapestry5.http.services;

import java.util.List;

import javax.servlet.http.HttpSession;

import org.apache.tapestry5.http.OptimizedSessionPersistedObject;
import org.apache.tapestry5.http.annotations.ImmutableSessionPersistedObject;
import org.apache.tapestry5.http.internal.services.OptimizedSessionPersistedObjectAnalyzer;

/**
 * Generic version of {@link HttpSession}, used to bridge the gaps between the Servlet API and the Portlet API.
 */
public interface Session
{
    /**
     * Returns a list of the names of all attributes stored in the session. The names are returned sorted
     * alphabetically.
     */
    List<String> getAttributeNames();

    /**
     * Returns a list of the names of all attributes stored in the session whose name has the provided prefix. The names
     * are returned in alphabetical order.
     */
    List<String> getAttributeNames(String prefix);

    /**
     * Returns the value previously stored in the session.
     */
    Object getAttribute(String name);

    /**
     * Sets the value of an attribute. If the value is null, then the attribute is deleted.
     */
    void setAttribute(String name, Object value);

    /**
     * Returns the maximum time interval, in seconds, that the servlet container will keep this session open between
     * client accesses. After this interval, the servlet container will invalidate the session. The maximum time
     * interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never
     * timeout.
     */
    int getMaxInactiveInterval();

    /**
     * Specifies the time, in seconds, between client requests before the servlet container will invalidate this
     * session. A negative time indicates the session should never timeout.
     */
    void setMaxInactiveInterval(int seconds);

    /**
     * Invalidates this session then unbinds any objects bound to it.
     * 
     * @throws IllegalStateException
     *             if this method is called on an already invalidated session
     */
    void invalidate();

    /**
     * Checks to see if the session has been invalidated. Note: since 5.3 this will also catch calls to
     * {@link javax.servlet.http.HttpSession#invalidate()}.
     * 
     * @since 5.1.0.0
     */
    boolean isInvalidated();

    /**
     * Re-stores dirty objects back into the session. This is necessary to support clustering, because (in most
     * application servers) session objects are only broadcast around the cluster from setAttribute(). If a mutable
     * session object is read and changed, those changes will be limited to a single server in the cluster, which can
     * cause confusing application failures in the event of a failover. Does nothing if there are no changes, or
     * the session has been invalidated.
     * 
     * @see OptimizedSessionPersistedObject
     * @see OptimizedSessionPersistedObjectAnalyzer
     * @see ImmutableSessionPersistedObject
     * @since 5.1.0.0
     */
    void restoreDirtyObjects();
}
