ServerConfiguration.java revision 3fc03edff55387bae91315653eae3ed0ca9b1f2a 
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
20/**
21 * Interface for objects that provide access to server-specific information.
22 *
23 * @author Chris Mair
24 * @version $Revision$ - $Date$
25 */
26public interface ServerConfiguration {
27
28    /**
29     * @return the {@link FileSystem}    for this server
30     */
31    public FileSystem getFileSystem();
32
33    /**
34     * @param username - the user name
35     * @return the {@link UserAccount}    configured for this server for the specified user name
36     */
37    public UserAccount getUserAccount(String username);
38
39    /**
40     * @return the System Name for this server (used by the SYST command)
41     */
42    public String getSystemName();
43
44    /**
45     * @return the System Status text for this server (used by the STAT command)
46     */
47    public String getSystemStatus();
48
49    /**
50     * Return the help text for a command or the default help text if no command name is specified
51     *
52     * @param name - the command name; may be empty or null to indicate  a request for the default help text
53     * @return the help text for the named command or the default help text if no name is supplied
54     */
55    public String getHelpText(String name);
56
57}