org.alfresco.service.cmr.remote
Interface LoaderRemote

All Known Implementing Classes:
LoaderRemoteServer

public interface LoaderRemote

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.

Since:
2.2.
See Also:
FileFolderRemote

Field Summary
static java.lang.String SERVICE_NAME
          The service name org.alfresco.LoaderRemote
 
Method Summary
 java.lang.String authenticate(java.lang.String username, java.lang.String password)
          Authenticate on the server using the given username and password
 org.alfresco.service.cmr.repository.NodeRef[] checkin(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] workingCopyNodeRef, java.util.List versionProperties)
          Check in files.
 FileInfo[] checkout(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] nodeRef)
          Check out files.
 void coci(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] nodeRef, byte[][] bytes, java.util.List versionProperties)
          Check in Check out files.
 int getNodeCount(java.lang.String ticket)
           
 int getNodeCount(java.lang.String ticket, org.alfresco.service.cmr.repository.StoreRef storeRef)
           
 org.alfresco.service.cmr.repository.NodeRef getOrCreateWorkingRoot(java.lang.String ticket, org.alfresco.service.cmr.repository.StoreRef storeRef)
          Get the working cm:folder node for the given store.
 FileInfo[] uploadContent(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef folderNodeRef, java.lang.String[] filenames, byte[][] bytes)
          Upload multiple files to a folder.
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
The service name org.alfresco.LoaderRemote

See Also:
Constant Field Values
Method Detail

authenticate

java.lang.String authenticate(java.lang.String username,
                              java.lang.String password)
Authenticate on the server using the given username and password

Returns:
the authentication ticket

getOrCreateWorkingRoot

org.alfresco.service.cmr.repository.NodeRef getOrCreateWorkingRoot(java.lang.String ticket,
                                                                   org.alfresco.service.cmr.repository.StoreRef storeRef)
Get the working cm:folder node for the given store. If there is no working root node, then one is created.

Parameters:
ticket - the authentication ticket
storeRef - the store reference
Returns:
a working cm:folder to use as the root for loading, or null if it is not available.

getNodeCount

int getNodeCount(java.lang.String ticket)
Parameters:
ticket - the authentication ticket
Returns:
Returns the total number of ADM nodes

getNodeCount

int getNodeCount(java.lang.String ticket,
                 org.alfresco.service.cmr.repository.StoreRef storeRef)
Parameters:
ticket - the authentication ticket
storeRef - the store to query against
Returns:
Returns the total number of nodes for the given ADM store

uploadContent

FileInfo[] uploadContent(java.lang.String ticket,
                         org.alfresco.service.cmr.repository.NodeRef folderNodeRef,
                         java.lang.String[] filenames,
                         byte[][] bytes)
Upload multiple files to a folder.

Parameters:
ticket - the authentication ticket
folderNodeRef - the folder to upload to
filenames - the names of the files to upload
bytes - the contents of the files
Returns:
Returns the details of each file created

coci

void coci(java.lang.String ticket,
          org.alfresco.service.cmr.repository.NodeRef[] nodeRef,
          byte[][] bytes,
          java.util.List versionProperties)
Check in Check out files.

Parameters:
ticket - the authentication ticket
nodeRef - a reference to the node to checkout
bytes - the contents of the files
versionProperties - the version properties. If null is passed then the original node is NOT versioned during the checkin operation.

checkout

FileInfo[] checkout(java.lang.String ticket,
                    org.alfresco.service.cmr.repository.NodeRef[] nodeRef)
Check out files.

Parameters:
ticket - the authentication ticket
nodeRef - a reference to the node to checkout
Returns:
a node reference to the created working copy

checkin

org.alfresco.service.cmr.repository.NodeRef[] checkin(java.lang.String ticket,
                                                      org.alfresco.service.cmr.repository.NodeRef[] workingCopyNodeRef,
                                                      java.util.List versionProperties)
Check in files.

Parameters:
ticket - the authentication ticket
workingCopyNodeRef - the working copy node reference
versionProperties - the version properties. If null is passed then the original node is NOT versioned during the checkin operation.
Returns:
the node reference to the original node, updated with the checked in state


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.