Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
SessionFactory |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one | |
3 | * or more contributor license agreements. See the NOTICE file | |
4 | * distributed with this work for additional information | |
5 | * regarding copyright ownership. The ASF licenses this file | |
6 | * to you under the Apache License, Version 2.0 (the | |
7 | * "License"); you may not use this file except in compliance | |
8 | * with the License. You may obtain a copy of the License at | |
9 | * | |
10 | * http://www.apache.org/licenses/LICENSE-2.0 | |
11 | * | |
12 | * Unless required by applicable law or agreed to in writing, | |
13 | * software distributed under the License is distributed on an | |
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
15 | * KIND, either express or implied. See the License for the | |
16 | * specific language governing permissions and limitations | |
17 | * under the License. | |
18 | */ | |
19 | package org.apache.shiro.session.mgt; | |
20 | ||
21 | import org.apache.shiro.session.Session; | |
22 | ||
23 | /** | |
24 | * A simple factory class that instantiates concrete {@link Session Session} instances. This is mainly a | |
25 | * mechanism to allow instances to be created at runtime if they need to be different the | |
26 | * defaults. It is not used by end-users of the framework, but rather those configuring Shiro to work in an | |
27 | * application, and is typically injected into the {@link org.apache.shiro.mgt.SecurityManager SecurityManager} or a | |
28 | * {@link SessionManager}. | |
29 | * | |
30 | * @since 1.0 | |
31 | */ | |
32 | public interface SessionFactory { | |
33 | ||
34 | /** | |
35 | * Creates a new {@code Session} instance based on the specified contextual initialization data. | |
36 | * | |
37 | * @param initData the initialization data to be used during {@link Session} creation. | |
38 | * @return a new {@code Session} instance. | |
39 | * @since 1.0 | |
40 | */ | |
41 | Session createSession(SessionContext initData); | |
42 | } |