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.descriptor;
19  
20  import java.util.List;
21  
22  import org.apache.jetspeed.pipeline.descriptor.ValveDescriptorApi;
23  
24  
25  public interface PipelineDescriptorApi
26  {
27      /***
28       * Add a ValveDescriptor to the Pipeline
29       * descriptor
30       *
31       * @param ValveDescriptor
32       */    
33      public void addValveDescriptor(ValveDescriptorApi valveDescriptor);
34  
35      /***
36       * Return a list of ValveDesccriptors
37       *
38       * @return List of ValveDesccriptors
39       */
40      public List getValveDescriptors();
41  
42      /***
43       * Sets the name attribute
44       *
45       * @param name the new name value
46       */
47      public void setName(String name);
48      /***
49       * Gets the name attribute
50       *
51       * @return the name attribute 
52       */
53      public String getName();
54      
55      /***
56       * Sets the id attribute of the BaseDescriptor object
57       *
58       * @param id the new id value
59       */
60      public void setId(String id);
61      
62      /***
63       * Gets the id attribute
64       *
65       * @return the id attribute
66       */
67      public String getId();
68      
69  }