1/*
2 * Copyright 2008 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package org.mockftpserver.fake;
17
18import org.mockftpserver.fake.filesystem.FileSystem;
19
20import java.util.ResourceBundle;
21
22/**
23 * Interface for objects that provide access to server-specific information.
24 *
25 * @author Chris Mair
26 * @version $Revision: 80 $ - $Date: 2008-07-07 22:15:50 -0400 (Mon, 07 Jul 2008) $
27 */
28public interface ServerConfiguration {
29
30    /**
31     * @return the {@link FileSystem}    for this server
32     */
33    public FileSystem getFileSystem();
34
35    /**
36     * @param username - the user name
37     * @return the {@link UserAccount}    configured for this server for the specified user name
38     */
39    public UserAccount getUserAccount(String username);
40
41    /**
42     * @return the {@link ResourceBundle}    used by this server for reply messages
43     */
44    public ResourceBundle getReplyTextBundle();
45
46    /**
47     * @return the System Name for this server (used by the SYST command)
48     */
49    public String getSystemName();
50
51
52    /**
53     * Return the help text for a command or the default help text if no command name is specified
54     *
55     * @param name - the command name; may be empty or null to indicate  a request for the default help text
56     * @return the help text for the named command or the default help text if no name is supplied
57     */
58    public String getHelpText(String name);
59
60}