mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
0dd05fe40f
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6111 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
115 lines
3.2 KiB
Java
115 lines
3.2 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.web.scripts;
|
|
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
|
|
import freemarker.cache.TemplateLoader;
|
|
|
|
|
|
/**
|
|
* Store for holding Web Script Definitions and Implementations
|
|
*
|
|
* @author davidc
|
|
*/
|
|
public interface WebScriptStore
|
|
{
|
|
/**
|
|
* Determines whether the store actually exists
|
|
*
|
|
* @return true => it does exist
|
|
*/
|
|
public boolean exists();
|
|
|
|
/**
|
|
* Gets the base path of the store
|
|
*
|
|
* @return base path
|
|
*/
|
|
public String getBasePath();
|
|
|
|
/**
|
|
* Gets the paths of all Web Script description documents in this store
|
|
*
|
|
* @return array of description document paths
|
|
*/
|
|
public String[] getDescriptionDocumentPaths();
|
|
|
|
/**
|
|
* Gets the paths of all implementation files for a given Web Script
|
|
*
|
|
* @param script web script
|
|
* @return array of implementation document paths
|
|
*/
|
|
public String[] getScriptDocumentPaths(WebScript script);
|
|
|
|
/**
|
|
* Determines if the document exists
|
|
*
|
|
* @param documentPath document path
|
|
* @return true => exists, false => does not exist
|
|
*/
|
|
public boolean hasDocument(String documentPath);
|
|
|
|
/**
|
|
* Gets a document
|
|
*
|
|
* @param documentPath document path
|
|
* @return input stream onto document
|
|
*
|
|
* @throws IOException
|
|
*/
|
|
public InputStream getDocument(String documentPath)
|
|
throws IOException;
|
|
|
|
/**
|
|
* Creates a document
|
|
*
|
|
* @param documentPath
|
|
* @param content
|
|
*
|
|
* @throws IOException
|
|
*/
|
|
public void createDocument(String documentPath, String content)
|
|
throws IOException;
|
|
|
|
/**
|
|
* Gets the template loader for this store
|
|
*
|
|
* @return template loader
|
|
*/
|
|
public TemplateLoader getTemplateLoader();
|
|
|
|
/**
|
|
* Gets the script loader for this store
|
|
*
|
|
* @return script loader
|
|
*/
|
|
public ScriptLoader getScriptLoader();
|
|
|
|
}
|
|
|