View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.profile;
19  
20  import javax.servlet.ServletRequest;
21  
22  /**
23   * This manager is responsible for determining the correct {@link ProfileHandler} for a given request. The
24   * manner in which this is done is completely implementation specific but implementers should make the selection process
25   * as quick and simple as absolutely possible as this process will be run on every request.
26   */
27  public interface ProfileHandlerManager {
28  
29      /**
30       * Gets the profile handler to service this request.
31       * 
32       * @param request request that will be serviced by the profile handler
33       * 
34       * @return the profile handler that should be used to service the given request
35       */
36      public ProfileHandler getProfileHandler(ServletRequest request);
37      
38      /**
39       * Gets the error handler for this manager.
40       * 
41       * @return handler to use if an error is encountered when processing a request
42       */
43      public AbstractErrorHandler getErrorHandler();
44  }