001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.session.mgt;
020
021import org.apache.shiro.session.Session;
022
023/**
024 * A simple factory class that instantiates concrete {@link Session Session} instances.  This is mainly a
025 * mechanism to allow instances to be created at runtime if they need to be different the
026 * defaults.  It is not used by end-users of the framework, but rather those configuring Shiro to work in an
027 * application, and is typically injected into the {@link org.apache.shiro.mgt.SecurityManager SecurityManager} or a
028 * {@link SessionManager}.
029 *
030 * @since 1.0
031 */
032public interface SessionFactory {
033
034    /**
035     * Creates a new {@code Session} instance based on the specified contextual initialization data.
036     *
037     * @param initData the initialization data to be used during {@link Session} creation.
038     * @return a new {@code Session} instance.
039     * @since 1.0
040     */
041    Session createSession(SessionContext initData);
042}