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 2014 ForgeRock AS.
015 */
016
017package org.forgerock.openig.http;
018
019/**
020 * A SessionFactory is responsible to create a new type of {@link Session}.
021 * This allows users to extends the default OpenIG behaviour quite easily.
022 */
023public interface SessionFactory {
024
025    /**
026     * Key to retrieve the default {@link SessionFactory} instance from the {@link org.forgerock.openig.heap.Heap}.
027     */
028    public static final String SESSION_FACTORY_HEAP_KEY = "Session";
029
030    /**
031     * Builds a new Session for the given Exchange. The implementations are free to keep a reference to the Exchange.
032     * The session object is scoped by the Exchange's own lifecycle.
033     *
034     * @param exchange
035     *         Exchange to create a session for.
036     * @return a new Session instance.
037     */
038    Session build(Exchange exchange);
039}