99b236a13cb9d2a865f5cc2639aca3867c1400fc
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / IdPProfileHandlerManager.java
1 /*
2  * Copyright [2007] [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.profile;
18
19 import java.util.HashMap;
20 import java.util.List;
21 import java.util.Map;
22 import java.util.Timer;
23 import java.util.concurrent.locks.Lock;
24
25 import javax.servlet.ServletRequest;
26 import javax.servlet.http.HttpServletRequest;
27
28 import org.apache.log4j.Logger;
29 import org.opensaml.util.resource.Resource;
30 import org.opensaml.util.resource.ResourceException;
31 import org.opensaml.xml.util.Pair;
32 import org.springframework.context.ApplicationContext;
33
34 import edu.internet2.middleware.shibboleth.common.config.BaseReloadableService;
35 import edu.internet2.middleware.shibboleth.common.profile.AbstractErrorHandler;
36 import edu.internet2.middleware.shibboleth.common.profile.ProfileHandler;
37 import edu.internet2.middleware.shibboleth.common.profile.ProfileHandlerManager;
38 import edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler;
39 import edu.internet2.middleware.shibboleth.idp.authn.AuthenticationHandler;
40 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
41
42 /**
43  * Implementation of a {@link ProfileHandlerManager} that maps the request path, without the servlet context, to a
44  * profile handler and adds support for authentication handlers.
45  */
46 public class IdPProfileHandlerManager extends BaseReloadableService implements ProfileHandlerManager {
47
48     /** Class logger. */
49     private final Logger log = Logger.getLogger(IdPProfileHandlerManager.class);
50
51     /** Handler used for errors. */
52     private AbstractErrorHandler errorHandler;
53
54     /** Map of request paths to profile handlers. */
55     private Map<String, AbstractRequestURIMappedProfileHandler> profileHandlers;
56
57     /** Map of authentication methods to authentication handlers. */
58     private Map<String, AuthenticationHandler> authenticationHandlers;
59
60     /**
61      * Constructor. Configuration resources are not monitored for changes.
62      * 
63      * @param configurations configuration resources for this service
64      */
65     public IdPProfileHandlerManager(List<Resource> configurations) {
66         super(configurations);
67         profileHandlers = new HashMap<String, AbstractRequestURIMappedProfileHandler>();
68         authenticationHandlers = new HashMap<String, AuthenticationHandler>();
69     }
70
71     /**
72      * Constructor.
73      * 
74      * @param timer timer resource polling tasks are scheduled with
75      * @param configurations configuration resources for this service
76      * @param pollingFrequency the frequency, in milliseconds, to poll the policy resources for changes, must be greater
77      *            than zero
78      */
79     public IdPProfileHandlerManager(List<Resource> configurations, Timer timer, long pollingFrequency) {
80         super(timer, configurations, pollingFrequency);
81         profileHandlers = new HashMap<String, AbstractRequestURIMappedProfileHandler>();
82         authenticationHandlers = new HashMap<String, AuthenticationHandler>();
83     }
84
85     /** {@inheritDoc} */
86     public AbstractErrorHandler getErrorHandler() {
87         return errorHandler;
88     }
89
90     /**
91      * Sets the error handler.
92      * 
93      * @param handler error handler
94      */
95     public void setErrorHandler(AbstractErrorHandler handler) {
96         if (handler == null) {
97             throw new IllegalArgumentException("Error handler may not be null");
98         }
99         errorHandler = handler;
100     }
101
102     /** {@inheritDoc} */
103     public ProfileHandler getProfileHandler(ServletRequest request) {
104         ProfileHandler handler;
105
106         String requestPath = ((HttpServletRequest) request).getPathInfo();
107         if (log.isDebugEnabled()) {
108             log.debug("Looking up profile handler for request path: " + requestPath);
109         }
110         Lock readLock = getReadWriteLock().readLock();
111         readLock.lock();
112         handler = profileHandlers.get(requestPath);
113         readLock.unlock();
114
115         if (handler != null) {
116             if (log.isDebugEnabled()) {
117                 log.debug("Located profile handler of the following type for request path " + requestPath + ": "
118                         + handler.getClass().getName());
119             }
120         } else {
121             if (log.isDebugEnabled()) {
122                 log.debug("No profile handler registered for request path " + requestPath);
123             }
124         }
125         return handler;
126     }
127
128     /**
129      * Gets the registered profile handlers.
130      * 
131      * @return registered profile handlers
132      */
133     public Map<String, AbstractRequestURIMappedProfileHandler> getProfileHandlers() {
134         return profileHandlers;
135     }
136
137     /**
138      * Gets the authentication handler appropriate for the given loging context. The mechanism used to determine the
139      * "appropriate" handler is implementation specific.
140      * 
141      * @param loginContext current login context
142      * 
143      * @return authentication method URI and handler appropriate for given login context
144      */
145     public Pair<String, AuthenticationHandler> getAuthenticationHandler(LoginContext loginContext) {
146         List<String> requestedMethods = loginContext.getRequestedAuthenticationMethods();
147         if (requestedMethods != null) {
148             AuthenticationHandler candidateHandler;
149             for (String requestedMethod : requestedMethods) {
150                 candidateHandler = authenticationHandlers.get(requestedMethod);
151                 if (candidateHandler != null) {
152                     if (loginContext.getPassiveAuth() && candidateHandler.supportsPassive()) {
153                         return new Pair<String, AuthenticationHandler>(requestedMethod, candidateHandler);
154                     }
155                 }
156             }
157         }
158
159         return null;
160     }
161
162     /**
163      * Gets the registered authentication handlers.
164      * 
165      * @return registered authentication handlers
166      */
167     public Map<String, AuthenticationHandler> getAuthenticationHandlers() {
168         return authenticationHandlers;
169     }
170
171     /** {@inheritDoc} */
172     protected void newContextCreated(ApplicationContext newServiceContext) throws ResourceException {
173         if (log.isDebugEnabled()) {
174             log.debug("Loading new configuration into service");
175         }
176         String[] errorBeanNames = newServiceContext.getBeanNamesForType(AbstractErrorHandler.class);
177         String[] profileBeanNames = newServiceContext.getBeanNamesForType(AbstractRequestURIMappedProfileHandler.class);
178         String[] authnBeanNames = newServiceContext.getBeanNamesForType(AuthenticationHandler.class);
179
180         Lock writeLock = getReadWriteLock().writeLock();
181         writeLock.lock();
182
183         errorHandler = (AbstractErrorHandler) newServiceContext.getBean(errorBeanNames[0]);
184         if (log.isDebugEnabled()) {
185             log.debug("Loaded new error handler of type: " + errorHandler.getClass().getName());
186         }
187
188         profileHandlers.clear();
189         if (log.isDebugEnabled()) {
190             log.debug(profileBeanNames.length + " profile handlers loaded");
191         }
192         AbstractRequestURIMappedProfileHandler profileHandler;
193         for (String profileBeanName : profileBeanNames) {
194             profileHandler = (AbstractRequestURIMappedProfileHandler) newServiceContext.getBean(profileBeanName);
195             for (String requestPath : profileHandler.getRequestPaths()) {
196                 profileHandlers.put(requestPath, profileHandler);
197                 if (log.isDebugEnabled()) {
198                     log.debug("Request path " + requestPath + " mapped to profile handler of type: "
199                             + profileHandler.getClass().getName());
200                 }
201             }
202         }
203
204         authenticationHandlers.clear();
205         if (log.isDebugEnabled()) {
206             log.debug(authnBeanNames.length + " authentication handlers loaded");
207         }
208         AuthenticationHandler authnHandler;
209         for (String authnBeanName : authnBeanNames) {
210             authnHandler = (AuthenticationHandler) newServiceContext.getBean(authnBeanName);
211             for (String authnMethod : authnHandler.getSupportedAuthenticationMethods()) {
212                 authenticationHandlers.put(authnMethod, authnHandler);
213                 if (log.isDebugEnabled()) {
214                     log.debug("Authentication method " + authnMethod + " mapped to authentication handler of type: "
215                             + authnHandler.getClass().getName());
216                 }
217             }
218         }
219
220         writeLock.unlock();
221     }
222 }