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  package org.apache.jetspeed.pipeline.valve;
18  
19  import org.apache.jetspeed.request.RequestContext;
20  import org.apache.jetspeed.pipeline.PipelineException;
21  
22  /***
23   * NOTE: This class will be deprecated once we merge with Summit
24   *
25   * General valve interface.  The actual valve interface(s) should be 
26   * extended by the implementing class.
27   *
28   * @author <a href="mailto:david@bluesunrise.com">David Sean Taylor</a>
29   * @version $Id: Valve.java 186726 2004-06-05 05:13:09Z taylor $
30   *
31   * @see org.apache.jetspeed.pipeline.JetspeedPipeline
32   * @see org.apache.jetspeed.pipeline.Pipeline
33   */
34  public interface Valve
35  {
36      public void invoke(RequestContext request, ValveContext context)
37          throws PipelineException;
38  
39      /***
40       * Initialize the valve before using in a pipeline.
41       */
42      public void initialize()
43          throws PipelineException;
44  
45  }