Lots o' profile handler refactoring
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / session / Session.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 import java.util.List;
20
21 /**
22  * Session information for user logged into the IdP.
23  */
24 public interface Session extends edu.internet2.middleware.shibboleth.common.session.Session {
25     
26     /** Name of the HttpSession attribute a users Shibboleth session Id is bound to. */
27     public static final String HTTP_SESSION_BINDING_ATTRIBUTE = "ShibbolethSessionId";
28
29     /**
30      * Gets the methods by which the user has authenticated to the IdP.
31      * 
32      * @return methods by which the user has authenticated to the IdP
33      */
34     public List<AuthenticationMethodInformation> getAuthenticationMethods();
35
36     /**
37      * Gets the information for a service a user is logged into.
38      * 
39      * @param entityId ID of the service
40      * 
41      * @return information for a service a user is logged into or null if the user is not logged into the given service
42      */
43     public ServiceInformation getServiceInformation(String entityId);
44
45     /**
46      * Gets the services the user has logged in to.
47      * 
48      * @return services the user has logged in to
49      */
50     public List<ServiceInformation> getServicesInformation();
51 }