View Javadoc

1   /*
2    * Copyright 2000-2004 The Apache Software Foundation.
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   */
16  package org.apache.portals.graffito.model;
17  
18  /***
19   * File System Server
20   *
21   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
22   * @version $Id: $
23   */
24  public interface FileSystemServer extends Server
25  {
26      /***
27       * Returns the root path of the file system in the format
28       * of the file system's native operating system.
29       * Examples: /home/david/share/, c:/stage/website1/
30       *   
31       * @return the root path of the file system.
32       */
33      String getRoot();
34      
35      /***
36       * Sets the root path of the file system in the format
37       * of the file system's native operating system.
38       * Examples: /home/david/share/, c:/stage/website1/
39       *   
40       * @param root the root path of the file system.
41       */
42      void setRoot(String root);
43      
44  }