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.remotemanager;
19
20 import org.apache.james.services.MailServer;
21 import org.apache.james.services.UsersRepository;
22 import org.apache.james.services.UsersStore;
23
24 import java.util.HashMap;
25
26 /***
27 * Provides a number of server-wide constant values to the
28 * RemoteManagerHandlers
29 *
30 */
31 public interface RemoteManagerHandlerConfigurationData {
32
33 /***
34 * Returns the service wide hello name
35 *
36 * @return the hello name
37 */
38 String getHelloName();
39
40 /***
41 * Returns the MailServer interface for this service.
42 *
43 * @return the MailServer interface for this service
44 */
45 MailServer getMailServer();
46
47 /***
48 * Returns the UsersRepository for this service.
49 *
50 * @return the local users repository
51 */
52 UsersRepository getUsersRepository();
53
54 /***
55 * Returns the UsersStore for this service.
56 *
57 * @return the local users store
58 */
59 UsersStore getUserStore();
60
61 /***
62 * Returns the Administrative Account Data
63 *
64 * TODO: Change the return type to make this immutable.
65 *
66 * @return the admin account data
67 */
68 HashMap getAdministrativeAccountData();
69
70 /***
71 * Returns the prompt to be displayed when waiting for input. e.g. "james> ".
72 *
73 * @return the configured prompt, or an empty string when the prompt is not configured.
74 */
75 String getPrompt();
76
77 }