Javadoc cleanup
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / session / impl / SessionImpl.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.impl;
18
19 import java.util.HashMap;
20 import java.util.Map;
21
22 import edu.internet2.middleware.shibboleth.common.session.impl.AbstractSession;
23 import edu.internet2.middleware.shibboleth.idp.session.AuthenticationMethodInformation;
24 import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
25 import edu.internet2.middleware.shibboleth.idp.session.Session;
26
27 /**
28  * Session information for user logged into the IdP.
29  */
30 public class SessionImpl extends AbstractSession implements Session {
31
32     /** Serial version UID. */
33     private static final long serialVersionUID = 2927868242208211623L;
34
35     /** The list of methods used to authenticate the user. */
36     private HashMap<String, AuthenticationMethodInformation> authnMethods;
37
38     /** The list of services to which the user has logged in. */
39     private HashMap<String, ServiceInformation> servicesInformation;
40
41     /**
42      * Default constructor.
43      * 
44      * @param sessionId ID of the session
45      * @param principal principal ID of the user
46      * @param timeout inactivity timeout for the session in milliseconds
47      */
48     public SessionImpl(String sessionId, String principal, long timeout) {
49         super(sessionId, principal, timeout);
50
51         authnMethods = new HashMap<String, AuthenticationMethodInformation>();
52         servicesInformation = new HashMap<String, ServiceInformation>();
53     }
54
55     /** {@inheritDoc} */
56     public Map<String, AuthenticationMethodInformation> getAuthenticationMethods() {
57         return authnMethods;
58     }
59
60     /** {@inheritDoc} */
61     public Map<String, ServiceInformation> getServicesInformation() {
62         return servicesInformation;
63     }
64     
65     /**
66      * Gets the service information for the given entity ID.
67      * 
68      * @param entityId entity ID to retrieve the service information for
69      * 
70      * @return the service information or null
71      */
72     public ServiceInformation getServiceInformation(String entityId) {
73         return servicesInformation.get(entityId);
74     }
75 }