2010-10-13 11:06:21 +00:00

107 lines
3.1 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.service.cmr.admin;
import java.io.InputStream;
import java.util.List;
import org.alfresco.repo.admin.RepoModelDefinition;
import org.alfresco.service.Auditable;
import org.alfresco.service.PublicService;
import org.alfresco.service.namespace.QName;
/**
* Repository Admin Service.
*
* Client facing API for interacting with Alfresco Repository Admin services.
*
*/
@PublicService
public interface RepoAdminService
{
//
// Custom Model Management
//
/**
* Get list of deployed custom model.
*/
@Auditable
public List<RepoModelDefinition> getModels();
/**
* Deploy custom model (to the 'Models' space).
* Allows creation of new models and incremental update of existing models.
*
*/
@Auditable(parameters = {"modelStream", "modelFileName"}, recordable = {false, true})
public void deployModel(InputStream modelStream, String modelFileName);
/**
* Undeploy custom model (from the 'Models' space).
* Allows delete of existing models, if not used.
* Permanently removes the model definition from the repository (all versions).
*/
@Auditable(parameters = {"modelFileName"})
public QName undeployModel(String modelFileName);
/**
* Activate custom model.
*/
@Auditable(parameters = {"modelFileName"})
public QName activateModel(String modelFileName);
/**
* Deactivate custom model.
*/
@Auditable(parameters = {"modelFileName"})
public QName deactivateModel(String modelFileName);
//
// Custom Message Management
//
/**
* Get deployed custom messages resource bundles.
*/
@Auditable
public List<String> getMessageBundles();
/**
* Deploy custom message resource bundle (to the 'Messages' space).
*
*/
@Auditable(parameters = {"resourceClasspath"})
public String deployMessageBundle(String resourceClasspath);
/**
* Undeploy custom message resource bundle (from the 'Messages' space).
*/
@Auditable(parameters = {"bundleBaseName"})
public void undeployMessageBundle(String bundleBaseName);
/**
* Reload custom message resource bundle.
*/
@Auditable(parameters = {"bundleBaseName"})
public void reloadMessageBundle(String bundleBaseName);
}