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 org.opensaml.ws.transport.InTransport;
20  import org.opensaml.ws.transport.OutTransport;
21  
22  /**
23   * Error handlers are invoked when an error is encountered during request processing.
24   * 
25   * Error handlers expect the error to be reported to be bound to the servlet request attribute identified by
26   * {@link #ERROR_KEY} and be of type {@link Throwable}.
27   */
28  public abstract class AbstractErrorHandler implements ProfileHandler {
29  
30      /** Servlet request attribute to which the error is bound. */
31      public static final String ERROR_KEY = "error";
32      
33      /** {@inheritDoc} */
34      public abstract void processRequest(InTransport in, OutTransport out);
35  }