svn commit: r406784 - /geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java

[am...@apache.org]

Author: ammulder
Date: Mon May 15 17:24:03 2006
New Revision: 406784

URL: http://svn.apache.org/viewcvs?rev=406784&view=rev
Log:
Add a bit of doc

Modified:
    geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java

Modified: geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java
URL: http://svn.apache.org/viewcvs/geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java?rev=406784&r1=406783&r2=406784&view=diff
==============================================================================
--- geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java (original)
+++ geronimo/branches/1.1/modules/system/src/java/org/apache/geronimo/system/serverinfo/ServerInfo.java Mon May 15 17:24:03 2006
@@ -32,7 +32,8 @@
     public String resolveServerPath(final String filename);
 
     /**
-     * Resolves an abstract pathname to a File.
+     * Resolves a relative pathname to a File, relative to the server
+     * installation directory (e.g. "foo" becomes .../geronimo/foo)
      *
      * @param filename a <code>String</code> containing a pathname,
      * which will be resolved by {@link #resolvePath(String
@@ -41,6 +42,15 @@
      */
     public File resolve(final String filename);
 
+    /**
+     * Resolves a relative pathname to a File, relative to the server
+     * configuration directory.  Normally, this is the same as the Geronimo
+     * installation directory (e.g. "foo" becomes .../geronimo/foo).
+     * However, you can pass command-line arguments to the server to relocate
+     * this to a server-instance-specific directory (e.g. "var/foo" might
+     * become .../geronimo/instance1/var/foo if the server was started with
+     * the flag indicating that the server instance dir was "instance1").
+     */
     public File resolveServer(final String filename);
 
     public URI resolve(final URI uri);