3bb9a014ee2eab86d7a9a7fa5e358836bbb4c563
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / IdPProtocolHandler.java
1 /*
2  * Copyright [2005] [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;
18
19 import javax.servlet.ServletException;
20 import javax.servlet.http.HttpServletRequest;
21 import javax.servlet.http.HttpServletResponse;
22
23 /**
24  * Defines the processing for an IdP-supported protocol. A particular <code>IdPProtocolHandler</code> implementation
25  * is registered to process requests delivered from one or more URL locations. Core IdP functionality is delivered
26  * through the <code>IdPProtocolSupport</code> class.
27  * 
28  * @author Walter Hoehn
29  */
30 public interface IdPProtocolHandler {
31
32         /**
33          * Retreives a textual name for the handler for display purposes.
34          */
35         public String getHandlerName();
36
37         /**
38          * Runs the protocol-specific request processing. Responsible for updating the <code>HttpServletResponse</code>.
39          * 
40          * @throws RequestHandlingException
41          *             if the handler is unable to successfully respond with a successfull protocol exchange or a
42          *             protocol-defined error message
43          */
44         public void processRequest(HttpServletRequest request, HttpServletResponse response, IdPProtocolSupport support)
45                         throws RequestHandlingException, ServletException;
46
47         /**
48          * Returns the locations for which this handler should process requests.
49          */
50         public String[] getLocations();
51 }