160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair/* 260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Copyright 2008 the original author or authors. 360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * you may not use this file except in compliance with the License. 660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * You may obtain a copy of the License at 760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * http://www.apache.org/licenses/LICENSE-2.0 960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 1060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Unless required by applicable law or agreed to in writing, software 1160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * distributed under the License is distributed on an "AS IS" BASIS, 1260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * See the License for the specific language governing permissions and 1460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * limitations under the License. 1560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 1660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairpackage org.mockftpserver.fake; 1760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 1860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairimport org.mockftpserver.fake.filesystem.FileSystem; 1960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 2060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair/** 2160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Interface for objects that provide access to server-specific information. 2260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 2360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @author Chris Mair 2460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @version $Revision$ - $Date$ 2560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 2660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismairpublic interface ServerConfiguration { 2760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 2860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 2960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @return the {@link FileSystem} for this server 3060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 3160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public FileSystem getFileSystem(); 3260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 3360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 3460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @param username - the user name 3560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @return the {@link UserAccount} configured for this server for the specified user name 3660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 3760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public UserAccount getUserAccount(String username); 3860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 3960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 4060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @return the System Name for this server (used by the SYST command) 4160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 4260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public String getSystemName(); 4360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 4460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 4560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @return the System Status text for this server (used by the STAT command) 4660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 4760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public String getSystemStatus(); 4860b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 4960b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair /** 5060b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * Return the help text for a command or the default help text if no command name is specified 5160b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * 5260b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @param name - the command name; may be empty or null to indicate a request for the default help text 5360b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair * @return the help text for the named command or the default help text if no name is supplied 5460b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair */ 5560b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair public String getHelpText(String name); 5660b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair 5760b81e2faf8511148f0d1e8f296e0b40ce9c7971chrismair}