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