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  
20  package org.apache.james.nntpserver;
21  
22  import org.apache.james.nntpserver.repository.NNTPRepository;
23  import org.apache.james.services.MailServer;
24  import org.apache.james.services.UsersRepository;
25  
26  /***
27   * Provides a number of server-wide constant values to the
28   * NNTPHandlers
29   *
30   */
31  public interface NNTPHandlerConfigurationData {
32  
33      /***
34       * Returns the service wide hello name
35       *
36       * @return the hello name
37       */
38      String getHelloName();
39  
40      /***
41       * Returns whether NNTP auth is active for this server.
42       *
43       * @return whether NNTP authentication is on
44       */
45      boolean isAuthRequired();
46  
47      /***
48       * Returns the NNTPRepository used by this service.
49       *
50       * @return the NNTPRepository used by this service
51       */
52      NNTPRepository getNNTPRepository();
53  
54      /***
55       * Returns the UsersRepository for this service.
56       *
57       * @return the local users repository
58       */
59      UsersRepository getUsersRepository();
60  
61  }