mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-30 18:15:39 +00:00
cefda8c965
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
120 lines
4.6 KiB
Java
120 lines
4.6 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.remote;
|
|
|
|
import org.alfresco.service.cmr.model.FileInfo;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.StoreRef;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Remote transport interface for the Loader application. This adds functionality
|
|
* that is generally required by the application and that is not available on other
|
|
* interfaces.
|
|
*
|
|
* @see FileFolderRemote
|
|
*
|
|
* @author Derek Hulley
|
|
* @since 2.2.
|
|
*/
|
|
public interface LoaderRemote
|
|
{
|
|
/** The service name <b>org.alfresco.LoaderRemote</b> */
|
|
public static final String SERVICE_NAME = "org.alfresco.LoaderRemote";
|
|
|
|
/**
|
|
* Authenticate on the server using the given username and password
|
|
*
|
|
* @return the authentication ticket
|
|
*/
|
|
public String authenticate(String username, String password);
|
|
|
|
/**
|
|
* Get the working <b>cm:folder</b> node for the given store. If there is no working
|
|
* root node, then one is created.
|
|
*
|
|
* @param ticket the authentication ticket
|
|
* @param storeRef the store reference
|
|
* @return a working <b>cm:folder</b> to use as the root for loading,
|
|
* or <tt>null</tt> if it is not available.
|
|
*/
|
|
public NodeRef getOrCreateWorkingRoot(String ticket, StoreRef storeRef);
|
|
|
|
/**
|
|
* @param ticket the authentication ticket
|
|
* @return Returns the total number of ADM nodes
|
|
*/
|
|
public int getNodeCount(String ticket);
|
|
|
|
/**
|
|
* @param ticket the authentication ticket
|
|
* @param storeRef the store to query against
|
|
* @return Returns the total number of nodes for the given ADM store
|
|
*/
|
|
public int getNodeCount(String ticket, StoreRef storeRef);
|
|
|
|
/**
|
|
* Upload multiple files to a folder.
|
|
*
|
|
* @param ticket the authentication ticket
|
|
* @param folderNodeRef the folder to upload to
|
|
* @param filenames the names of the files to upload
|
|
* @param bytes the contents of the files
|
|
* @return Returns the details of each file created
|
|
*/
|
|
public FileInfo[] uploadContent(String ticket, NodeRef folderNodeRef, String[] filenames, byte[][] bytes);
|
|
|
|
/**
|
|
* Check in Check out files.
|
|
*
|
|
* @param ticket the authentication ticket
|
|
* @param nodeRef a reference to the node to checkout
|
|
* @param bytes the contents of the files
|
|
* @param versionProperties the version properties. If null is passed then the original node
|
|
* is NOT versioned during the checkin operation.
|
|
*/
|
|
public void coci(String ticket, final NodeRef[] nodeRef, byte[][] bytes, List<HashMap<String, Serializable>> versionProperties);
|
|
|
|
/**
|
|
* Check out files.
|
|
*
|
|
* @param ticket the authentication ticket
|
|
* @param nodeRef a reference to the node to checkout
|
|
* @return a node reference to the created working copy
|
|
*/
|
|
public FileInfo[] checkout(String ticket, NodeRef[] nodeRef);
|
|
|
|
/**
|
|
* Check in files.
|
|
*
|
|
* @param ticket the authentication ticket
|
|
* @param workingCopyNodeRef the working copy node reference
|
|
* @param versionProperties the version properties. If null is passed then the original node
|
|
* is NOT versioned during the checkin operation.
|
|
* @return the node reference to the original node, updated with the checked in
|
|
* state
|
|
*/
|
|
public NodeRef[] checkin(String ticket, NodeRef[] workingCopyNodeRef,
|
|
List<HashMap<String, Serializable>> versionProperties);
|
|
|
|
}
|