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  /***
20   * The Server interface is the ancestor for all kind of content servers (DB, Webdav, ...).
21   * A Server is a collection of {@link org.apache.portals.graffito.model.Folder}.
22   * 
23   * Each Server is associated to a plugin class name (see org.apache.portals.graffito.store in the component subproject).
24   * 
25   * In the Graffito context, there is a mandatary server called "Graffito Master Server" which contains server metadatas.
26   * By this way, the Graffito engine can mount all referenced servers into the same content tree.
27   *  
28   *
29   * Each server has scope which is an uri prefix. Each cms object with the same uri prefix will be stores in this server.
30   * @author <a href="mailto:christophe.lombart@sword-technologies.com">Christophe Lombart</a>
31   * 
32   * @version $Id: Server.java,v 1.1 2004/12/22 21:16:10 christophe Exp $
33   */
34  public abstract interface Server
35  {
36      /***
37       * Get the server scope. The scope is the uri prefix assigned to this server
38       * @return
39       */
40  	public String getScope();
41  	
42  	public void setScope(String scope);
43  	
44  	public String getAlias();
45  	
46  	public void setAlias(String alias);
47  	
48  	public String getDescription();
49  	
50  	public void setDescription(String description);
51  	
52  	public String getTitle();
53  	
54  	public void setTitle(String title);
55  	
56  	public String getStoreClassName();
57  	
58  	public void setStoreClassName(String pluginClassName);
59  	    
60  }