Initial session classes
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / session / SessionManager.java
1 /*
2  * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package edu.internet2.middleware.shibboleth.idp.session;
18
19 /**
20  * Session managers are responsible for creating, managing, and destroying Shibboleth IdP sessions.
21  */
22 public interface SessionManager {
23
24     /**
25      * Creates a Shibboleth session.
26      * 
27      * @return a Shibboleth session
28      */
29     public Session createSession();
30     
31     /**
32      * Gets the user's session based on session's ID.
33      * 
34      * @param sessionID the ID of the session
35      * 
36      * @return the session
37      */
38     public Session getSession(String sessionID);
39     
40     /**
41      * Destroys the session.
42      * 
43      * @param sessionID the ID of the session.
44      */
45     public void destroySession(String sessionID);
46 }