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