View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * 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 org.apache.jetspeed.pipeline.valve;
19  
20  import org.apache.jetspeed.request.RequestContext;
21  import org.apache.jetspeed.pipeline.PipelineException;
22  
23  /***
24   * NOTE: This class will be deprecated once we merge with Summit
25   *
26   *
27   * @author <a href="mailto:david@bluesunrise.com">David Sean Taylor</a>
28   * @version $Id: ValveContext.java 186726 2004-06-05 05:13:09Z taylor $
29   */
30  public interface ValveContext
31  {
32      /***
33       * <p>Cause the <code>invoke()</code> method of the next Valve
34       * that is part of the Pipeline currently being processed (if any)
35       * to be executed, passing on the specified request and response
36       * objects plus this <code>ValveContext</code> instance.
37       * Exceptions thrown by a subsequently executed Valve will be
38       * passed on to our caller.</p>
39       *
40       * <p>If there are no more Valves to be executed, execution of
41       * this method will result in a no op.</p>
42       *
43       * @param data The run-time information, including the servlet
44       * request and response we are processing.
45       *
46       * @exception IOException Thrown by a subsequent Valve.
47       * @exception SummitException Thrown by a subsequent Valve.
48       * @exception SummitException No further Valves configured in the
49       * Pipeline currently being processed.
50       */
51      public void invokeNext(RequestContext request)
52          throws PipelineException;
53  }