summaryrefslogtreecommitdiff
path: root/tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java
diff options
context:
space:
mode:
Diffstat (limited to 'tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java')
-rw-r--r--tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java57
1 files changed, 57 insertions, 0 deletions
diff --git a/tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java b/tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java
new file mode 100644
index 0000000..dbfdb4b
--- /dev/null
+++ b/tags/2.1/src/main/java/org/mockftpserver/fake/ServerConfiguration.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2008 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.mockftpserver.fake;
+
+import org.mockftpserver.fake.filesystem.FileSystem;
+
+/**
+ * Interface for objects that provide access to server-specific information.
+ *
+ * @author Chris Mair
+ * @version $Revision$ - $Date$
+ */
+public interface ServerConfiguration {
+
+ /**
+ * @return the {@link FileSystem} for this server
+ */
+ public FileSystem getFileSystem();
+
+ /**
+ * @param username - the user name
+ * @return the {@link UserAccount} configured for this server for the specified user name
+ */
+ public UserAccount getUserAccount(String username);
+
+ /**
+ * @return the System Name for this server (used by the SYST command)
+ */
+ public String getSystemName();
+
+ /**
+ * @return the System Status text for this server (used by the STAT command)
+ */
+ public String getSystemStatus();
+
+ /**
+ * Return the help text for a command or the default help text if no command name is specified
+ *
+ * @param name - the command name; may be empty or null to indicate a request for the default help text
+ * @return the help text for the named command or the default help text if no name is supplied
+ */
+ public String getHelpText(String name);
+
+} \ No newline at end of file