first pass at authnmgr
[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.List;
20
21 import javolution.util.FastList;
22
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 // implementation note: 
28 // pay attention to package names in this file!
29 //
30 // this class is shib.idp.session.impl.SessionImpl. It implements the shib.idp.session.Session
31 // interface. that interface, in turn, extends shib.common.session.Session, which is implemented
32 // in shib.common.session.impl.SessionImpl.
33
34
35 /**
36  * Session information for user logged into the IdP.
37  */
38 public class SessionImpl
39         extends edu.internet2.middleware.shibboleth.common.session.impl.SessionImpl
40         implements Session {
41     
42     /** The list of methods used to authentictate the user */
43     private List<AuthenticationMethodInformation> authnMethods =
44             new FastList<AuthenticationMethodInformation>();
45     
46     /** The list of services to which the user has logged in */
47     private List<ServiceInformation> servicesInformation =
48             new FastList<ServiceInformation>();
49
50     
51     /**
52      * Default constructor.
53      * 
54      * @param principalID The principal ID of the user
55      */
56     public SessionImpl(String principalID) {
57         
58         super(principalID);
59     }
60     
61     
62     /** {@inheritDoc} */
63     public List<AuthenticationMethodInformation> getAuthenticationMethods() {
64     
65         // XXX : This is suspect. One should not return
66         // a reference to a private mutable object. The Session
67         // interface should have methods for adding and removing
68         // AuthenticationMethodInformation and ServicesInformation
69         // entries. Further, the Session interface assumes that 
70         // the implementation will return a thread-safe List. Not
71         // all List implementations are thread-safe.
72             
73         return this.authnMethods;
74     }
75
76
77     /** {@inheritDoc} */
78     public List<ServiceInformation> getServicesInformation() {
79         
80         // XXX: warning: Potentially dangerous. see above note.
81         
82         return this.servicesInformation;
83     }
84     
85 }