org.alfresco.service.cmr.remote
Interface FileFolderRemote

All Known Implementing Classes:
FileFolderRemoteClient, FileFolderRemoteServer

public interface FileFolderRemote

Remote transport interface for the FileFolderService. This includes the authentication tickets and abstracts the stream transport as well.

NOTE: This is not a production API and will most definitely be changed or removed.

Since:
2.2.
See Also:
FileFolderService

Field Summary
static java.lang.String SERVICE_NAME
          The service name org.alfresco.FileFolderRemote
 
Method Summary
 FileInfo copy(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName)
           
 FileInfo[] create(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] parentNodeRefs, java.lang.String[] names, org.alfresco.service.namespace.QName[] typesQName)
           
 FileInfo create(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, java.lang.String name, org.alfresco.service.namespace.QName typeQName)
           
 void delete(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
           
 void delete(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] nodeRefs)
           
 byte[] getContent(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
          TODO: Refactor!!!
 FileInfo getFileInfo(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
           
 java.util.List getNamePath(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef rootNodeRef, org.alfresco.service.cmr.repository.NodeRef nodeRef)
           
 org.alfresco.service.cmr.repository.ContentReader getReader(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
           
 org.alfresco.service.cmr.repository.ContentWriter getWriter(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
           
 java.util.List list(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef contextNodeRef)
           
 java.util.List listFiles(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef folderNodeRef)
           
 java.util.List listFolders(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef contextNodeRef)
           
 FileInfo makeFolders(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, java.util.List pathElements, org.alfresco.service.namespace.QName folderTypeQName)
           
 FileInfo move(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetParentRef, java.lang.String newName)
           
 org.alfresco.service.cmr.repository.ContentData[] putContent(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef[] nodeRefs, byte[][] bytes, java.lang.String[] filenames)
           
 org.alfresco.service.cmr.repository.ContentData putContent(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef, byte[] bytes, java.lang.String filename)
          TODO: Refactor!!! The dirtiest of hacks.
 FileInfo rename(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef fileFolderRef, java.lang.String newName)
           
 FileInfo resolveNamePath(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef rootNodeRef, java.util.List pathElements)
           
 java.util.List search(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String namePattern, boolean includeSubFolders)
           
 java.util.List search(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String namePattern, boolean fileSearch, boolean folderSearch, boolean includeSubFolders)
           
 org.alfresco.service.cmr.repository.NodeRef searchSimple(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef contextNodeRef, java.lang.String name)
           
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

list

java.util.List list(java.lang.String ticket,
                    org.alfresco.service.cmr.repository.NodeRef contextNodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.list(NodeRef)

listFiles

java.util.List listFiles(java.lang.String ticket,
                         org.alfresco.service.cmr.repository.NodeRef folderNodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.listFiles(NodeRef)

listFolders

java.util.List listFolders(java.lang.String ticket,
                           org.alfresco.service.cmr.repository.NodeRef contextNodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.listFolders(NodeRef)

searchSimple

org.alfresco.service.cmr.repository.NodeRef searchSimple(java.lang.String ticket,
                                                         org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                                         java.lang.String name)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.searchSimple(NodeRef, String)

search

java.util.List search(java.lang.String ticket,
                      org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                      java.lang.String namePattern,
                      boolean includeSubFolders)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.search(NodeRef, String, boolean)

search

java.util.List search(java.lang.String ticket,
                      org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                      java.lang.String namePattern,
                      boolean fileSearch,
                      boolean folderSearch,
                      boolean includeSubFolders)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.search(NodeRef, String, boolean, boolean, boolean)

rename

FileInfo rename(java.lang.String ticket,
                org.alfresco.service.cmr.repository.NodeRef fileFolderRef,
                java.lang.String newName)
                throws FileExistsException,
                       FileNotFoundException
Parameters:
token - the authentication ticket
Throws:
FileExistsException
FileNotFoundException
See Also:
FileFolderService.rename(NodeRef, String)

move

FileInfo move(java.lang.String ticket,
              org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
              org.alfresco.service.cmr.repository.NodeRef targetParentRef,
              java.lang.String newName)
              throws FileExistsException,
                     FileNotFoundException
Parameters:
token - the authentication ticket
Throws:
FileExistsException
FileNotFoundException
See Also:
FileFolderService.move(NodeRef, NodeRef, String)

copy

FileInfo copy(java.lang.String ticket,
              org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
              org.alfresco.service.cmr.repository.NodeRef targetParentRef,
              java.lang.String newName)
              throws FileExistsException,
                     FileNotFoundException
Parameters:
token - the authentication ticket
Throws:
FileExistsException
FileNotFoundException
See Also:
FileFolderService.copy(NodeRef, NodeRef, String)

create

FileInfo create(java.lang.String ticket,
                org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                java.lang.String name,
                org.alfresco.service.namespace.QName typeQName)
                throws FileExistsException
Parameters:
token - the authentication ticket
Throws:
FileExistsException
See Also:
FileFolderService.create(NodeRef, String, QName)

create

FileInfo[] create(java.lang.String ticket,
                  org.alfresco.service.cmr.repository.NodeRef[] parentNodeRefs,
                  java.lang.String[] names,
                  org.alfresco.service.namespace.QName[] typesQName)
                  throws FileExistsException
Parameters:
token - the authentication ticket This is additional method to avoid multiple authorisation during creating files
Throws:
FileExistsException

delete

void delete(java.lang.String ticket,
            org.alfresco.service.cmr.repository.NodeRef nodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.delete(NodeRef)

delete

void delete(java.lang.String ticket,
            org.alfresco.service.cmr.repository.NodeRef[] nodeRefs)
Parameters:
token - the authentication ticket This is additional method to avoid multiple authorisation during deleting files

makeFolders

FileInfo makeFolders(java.lang.String ticket,
                     org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                     java.util.List pathElements,
                     org.alfresco.service.namespace.QName folderTypeQName)
Parameters:
token - the authentication ticket
See Also:
FileFolderService#makeFolders(NodeRef, List, QName)

getNamePath

java.util.List getNamePath(java.lang.String ticket,
                           org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                           org.alfresco.service.cmr.repository.NodeRef nodeRef)
                           throws FileNotFoundException
Parameters:
token - the authentication ticket
Throws:
FileNotFoundException
See Also:
FileFolderService.getNamePath(NodeRef, NodeRef)

resolveNamePath

FileInfo resolveNamePath(java.lang.String ticket,
                         org.alfresco.service.cmr.repository.NodeRef rootNodeRef,
                         java.util.List pathElements)
                         throws FileNotFoundException
Parameters:
token - the authentication ticket
Throws:
FileNotFoundException
See Also:
FileFolderService.resolveNamePath(NodeRef, List)

getFileInfo

FileInfo getFileInfo(java.lang.String ticket,
                     org.alfresco.service.cmr.repository.NodeRef nodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.getFileInfo(NodeRef)

putContent

org.alfresco.service.cmr.repository.ContentData putContent(java.lang.String ticket,
                                                           org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                           byte[] bytes,
                                                           java.lang.String filename)
TODO: Refactor!!! The dirtiest of hacks. When time permits, the APIs and implementations will be properly refactored. For now, this remains adequate for small files.


putContent

org.alfresco.service.cmr.repository.ContentData[] putContent(java.lang.String ticket,
                                                             org.alfresco.service.cmr.repository.NodeRef[] nodeRefs,
                                                             byte[][] bytes,
                                                             java.lang.String[] filenames)
Parameters:
token - the authentication ticket This is additional method to avoid multiple authorisation during putting content

getContent

byte[] getContent(java.lang.String ticket,
                  org.alfresco.service.cmr.repository.NodeRef nodeRef)
TODO: Refactor!!!


getReader

org.alfresco.service.cmr.repository.ContentReader getReader(java.lang.String ticket,
                                                            org.alfresco.service.cmr.repository.NodeRef nodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.getReader(NodeRef)

getWriter

org.alfresco.service.cmr.repository.ContentWriter getWriter(java.lang.String ticket,
                                                            org.alfresco.service.cmr.repository.NodeRef nodeRef)
Parameters:
token - the authentication ticket
See Also:
FileFolderService.getWriter(NodeRef)


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