View Javadoc

1   /************************************************************************
2    * Copyright (c) 2000-2006 The Apache Software Foundation.             *
3    * All rights reserved.                                                *
4    * ------------------------------------------------------------------- *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you *
6    * may not use this file except in compliance with the License. You    *
7    * 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     *
14   * implied.  See the License for the specific language governing       *
15   * permissions and limitations under the License.                      *
16   ***********************************************************************/
17  
18  package org.apache.james.nntpserver;
19  
20  import org.apache.james.nntpserver.repository.NNTPRepository;
21  import org.apache.james.services.MailServer;
22  import org.apache.james.services.UsersRepository;
23  
24  /***
25   * Provides a number of server-wide constant values to the
26   * NNTPHandlers
27   *
28   */
29  public interface NNTPHandlerConfigurationData {
30  
31      /***
32       * Returns the service wide hello name
33       *
34       * @return the hello name
35       */
36      String getHelloName();
37  
38      /***
39       * Returns whether NNTP auth is active for this server.
40       *
41       * @return whether NNTP authentication is on
42       */
43      boolean isAuthRequired();
44  
45      /***
46       * Returns the NNTPRepository used by this service.
47       *
48       * @return the NNTPRepository used by this service
49       */
50      NNTPRepository getNNTPRepository();
51  
52      /***
53       * Returns the UsersRepository for this service.
54       *
55       * @return the local users repository
56       */
57      UsersRepository getUsersRepository();
58  
59  }