001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010–2011 ApexIdentity Inc.
015 * Portions Copyright 2011-2014 ForgeRock AS.
016 */
017
018package org.forgerock.http.session;
019
020import java.io.IOException;
021import java.util.Map;
022
023import org.forgerock.http.protocol.Response;
024
025/**
026 * An interface for managing attributes across multiple requests from the same user agent.
027 * Implementations should expose underlying container session attributes through this
028 * interface if applicable.
029 * <p>
030 * New keys added to a session object should be named in a manner that avoids possible
031 * collision with keys added by other objects in the heap.
032 */
033public interface Session extends Map<String, Object> {
034
035    /**
036     * Save the session state to the response.
037     *
038     * @param response The {@link Response} instance to write the session state to.
039     * @throws IOException If an I/O error occurs.
040     */
041    void save(Response response) throws IOException;
042}