org.nuxeo.ecm.platform.wi.backend

Class AbstractVirtualBackend

java.lang.Object

org.nuxeo.ecm.platform.wi.backend.AbstractCoreBackend

org.nuxeo.ecm.platform.wi.backend.AbstractVirtualBackend

All Implemented Interfaces:

Backend, VirtualBackend

Direct Known Subclasses:

SearchVirtualBackend

public abstract class AbstractVirtualBackend
extends AbstractCoreBackend
implements VirtualBackend

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUnlock(DocumentRef ref)
DocumentModel	copyItem(DocumentModel source, PathRef targetParentRef)
DocumentModel	createFile(String parentPath, String name)
DocumentModel	createFile(String parentPath, String name, Blob content)
DocumentModel	createFolder(String parentPath, String name)
void	destroy()
boolean	exists(String location)
Backend	getBackend(String uri)
String	getBackendDisplayName()
String	getCheckoutUser(DocumentRef ref)
List<DocumentModel>	getChildren(DocumentRef ref)
String	getDisplayName(DocumentModel doc)
DocumentModel	getDocument(String location)
LinkedList<String>	getOrderedBackendNames()
String	getRootPath()
String	getRootUrl()
LinkedList<String>	getVirtualFolderNames()
String	getVirtualPath(String path)
boolean	hasPermission(DocumentRef docRef, String permission)
boolean	isLocked(DocumentRef ref)
boolean	isRename(String source, String destination)
boolean	isRoot()
boolean	isVirtual()
String	lock(DocumentRef ref)
DocumentModel	moveItem(DocumentModel source, DocumentRef targetParentRef, String name)
DocumentModel	moveItem(DocumentModel source, PathRef targetParentRef)
Path	parseLocation(String location)
void	removeItem(DocumentRef ref)
void	removeItem(String location)
void	renameItem(DocumentModel source, String destinationName)
DocumentModel	resolveLocation(String location)
boolean	unlock(DocumentRef ref)
DocumentModel	updateDocument(DocumentModel doc, String name, Blob content)

Methods inherited from class org.nuxeo.ecm.platform.wi.backend.AbstractCoreBackend

discardChanges, discardChanges, getSession, getSession, saveChanges, saveChanges, setSession

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.wi.backend.Backend

discardChanges, getSession, getSession, saveChanges, setSession

Method Detail

getRootPath

public String getRootPath()

Specified by:

getRootPath in interface Backend

getRootUrl

public String getRootUrl()

Specified by:

getRootUrl in interface Backend

isVirtual

public final boolean isVirtual()

Specified by:

isVirtual in interface Backend

isRoot

public boolean isRoot()

Specified by:

isRoot in interface Backend

getBackendDisplayName

public String getBackendDisplayName()

Specified by:

getBackendDisplayName in interface Backend

getVirtualFolderNames

public LinkedList<String> getVirtualFolderNames()
                                         throws ClientException

Specified by:

getVirtualFolderNames in interface Backend

Throws:

ClientException

getBackend

public Backend getBackend(String uri)

Specified by:

getBackend in interface Backend

destroy

public void destroy()

Specified by:

destroy in interface Backend

Overrides:

destroy in class AbstractCoreBackend

isLocked

public boolean isLocked(DocumentRef ref)
                 throws ClientException

Specified by:

isLocked in interface Backend

Throws:

ClientException

canUnlock

public boolean canUnlock(DocumentRef ref)
                  throws ClientException

Specified by:

canUnlock in interface Backend

Throws:

ClientException

lock

public String lock(DocumentRef ref)
            throws ClientException

Specified by:

lock in interface Backend

Throws:

ClientException

unlock

public boolean unlock(DocumentRef ref)
               throws ClientException

Specified by:

unlock in interface Backend

Throws:

ClientException

getCheckoutUser

public String getCheckoutUser(DocumentRef ref)
                       throws ClientException

Specified by:

getCheckoutUser in interface Backend

Throws:

ClientException

resolveLocation

public DocumentModel resolveLocation(String location)
                              throws ClientException

Specified by:

resolveLocation in interface Backend

Throws:

ClientException

parseLocation

public Path parseLocation(String location)

Specified by:

parseLocation in interface Backend

removeItem

public void removeItem(String location)
                throws ClientException

Specified by:

removeItem in interface Backend

Throws:

ClientException

removeItem

public void removeItem(DocumentRef ref)
                throws ClientException

Specified by:

removeItem in interface Backend

Throws:

ClientException

renameItem

public void renameItem(DocumentModel source,
              String destinationName)
                throws ClientException

Specified by:

renameItem in interface Backend

Throws:

ClientException

moveItem

public DocumentModel moveItem(DocumentModel source,
                     PathRef targetParentRef)
                       throws ClientException

Specified by:

moveItem in interface Backend

Throws:

ClientException

copyItem

public DocumentModel copyItem(DocumentModel source,
                     PathRef targetParentRef)
                       throws ClientException

Specified by:

copyItem in interface Backend

Throws:

ClientException

createFolder

public DocumentModel createFolder(String parentPath,
                         String name)
                           throws ClientException

Specified by:

createFolder in interface Backend

Throws:

ClientException

createFile

public DocumentModel createFile(String parentPath,
                       String name,
                       Blob content)
                         throws ClientException

Specified by:

createFile in interface Backend

Throws:

ClientException

createFile

public DocumentModel createFile(String parentPath,
                       String name)
                         throws ClientException

Specified by:

createFile in interface Backend

Throws:

ClientException

getChildren

public List<DocumentModel> getChildren(DocumentRef ref)
                                throws ClientException

Specified by:

getChildren in interface Backend

Throws:

ClientException

isRename

public boolean isRename(String source,
               String destination)

Specified by:

isRename in interface Backend

exists

public boolean exists(String location)

Specified by:

exists in interface Backend

getDisplayName

public String getDisplayName(DocumentModel doc)

Specified by:

getDisplayName in interface Backend

hasPermission

public boolean hasPermission(DocumentRef docRef,
                    String permission)
                      throws ClientException

Specified by:

hasPermission in interface Backend

Throws:

ClientException

getDocument

public DocumentModel getDocument(String location)
                          throws ClientException

Specified by:

getDocument in interface Backend

Throws:

ClientException

updateDocument

public DocumentModel updateDocument(DocumentModel doc,
                           String name,
                           Blob content)
                             throws ClientException

Specified by:

updateDocument in interface Backend

Throws:

ClientException

moveItem

public DocumentModel moveItem(DocumentModel source,
                     DocumentRef targetParentRef,
                     String name)
                       throws ClientException

Specified by:

moveItem in interface Backend

Throws:

ClientException

getVirtualPath

public String getVirtualPath(String path)
                      throws ClientException

Specified by:

getVirtualPath in interface Backend

Throws:

ClientException

getOrderedBackendNames

public LinkedList<String> getOrderedBackendNames()
                                          throws ClientException

Specified by:

getOrderedBackendNames in interface VirtualBackend

Throws:

ClientException