View Javadoc

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.common.profile;
18  
19  import javax.servlet.ServletRequest;
20  
21  /**
22   * This manager is responsible for determining the correct {@link ProfileHandler} for a given request. The
23   * manner in which this is done is completely implementation specific but implementers should make the selection process
24   * as quick and simple as absolutely possible as this process will be run on every request.
25   */
26  public interface ProfileHandlerManager {
27  
28      /**
29       * Gets the profile handler to service this request.
30       * 
31       * @param request request that will be serviced by the profile handler
32       * 
33       * @return the profile handler that should be used to service the given request
34       */
35      public ProfileHandler getProfileHandler(ServletRequest request);
36      
37      /**
38       * Gets the error handler for this manager.
39       * 
40       * @return handler to use if an error is encountered when processing a request
41       */
42      public AbstractErrorHandler getErrorHandler();
43  }