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