View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  package org.apache.james.services;
20  
21  import java.util.List;
22  
23  /**
24   * provide all the data needed to manage spool processors, mailets and matchers
25   */
26  public interface SpoolManager {
27      String ROLE = "org.apache.james.services.SpoolManager";
28  
29      /**
30       * @return names of all configured processors
31       */
32      String[] getProcessorNames();
33  
34      /**
35       * retrieve all mailets for given processor
36       * @param processorName - name of the processor who's mailets should be retrieved
37       * @return List<MailetConfig>
38       */
39      List getMailetConfigs(String processorName);
40      
41      /**
42       * retrieve all matchers for given processor
43       * @param processorName - name of the processor who's matchers should be retrieved
44       * @return List<MatcherConfig>
45       */
46      List getMatcherConfigs(String processorName);
47  }