01: /****************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one *
03: * or more contributor license agreements. See the NOTICE file *
04: * distributed with this work for additional information *
05: * regarding copyright ownership. The ASF licenses this file *
06: * to you under the Apache License, Version 2.0 (the *
07: * "License"); you may not use this file except in compliance *
08: * with the License. You may obtain a copy of the License at *
09: * *
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: ****************************************************************/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: }
|