Class AbstractFileSystemItemFactory
- java.lang.Object
-
- org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory
-
- All Implemented Interfaces:
FileSystemItemFactory
- Direct Known Subclasses:
AbstractSyncRootFolderItemFactory
,DefaultFileSystemItemFactory
,UserSyncRootParentFactory
,UserWorkspaceTopLevelFactory
public abstract class AbstractFileSystemItemFactory extends Object implements FileSystemItemFactory
Base class forFileSystemItemFactory
implementers. It isDocumentModel
backed.- Author:
- Antoine Taillefer
- See Also:
DefaultFileSystemItemFactory
-
-
Constructor Summary
Constructors Constructor Description AbstractFileSystemItemFactory()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected FileSystemItem
adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem)
protected abstract FileSystemItem
adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean relaxSyncRootConstraint, boolean getLockInfo)
Adapts the givenDocumentModel
to aFileSystemItem
.boolean
canHandleFileSystemItemId(String id)
Returns true if the givenFileSystemItem
id can be handled by this factory.boolean
exists(String id, NuxeoPrincipal principal)
The default factory considers that aFileSystemItem
with the given id exists if the backingDocumentModel
can be fetched andisFileSystemItem(DocumentModel)
returns true.protected DocumentModel
getDocumentById(String docId, CoreSession session)
FileSystemItem
getFileSystemItem(DocumentModel doc)
Gets theFileSystemItem
for the givenDocumentModel
.FileSystemItem
getFileSystemItem(DocumentModel doc, boolean includeDeleted)
Gets theFileSystemItem
for the givenDocumentModel
.FileSystemItem
getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint)
Gets theFileSystemItem
for the givenDocumentModel
.FileSystemItem
getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
Gets theFileSystemItem
for the givenDocumentModel
.protected FileSystemItem
getFileSystemItem(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
FileSystemItem
getFileSystemItem(DocumentModel doc, FolderItem parentItem)
FileSystemItem
getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted)
FileSystemItem
getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint)
FileSystemItem
getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
FileSystemItem
getFileSystemItemById(String id, String parentId, NuxeoPrincipal principal)
Gets theFileSystemItem
with the given id and parent id using a core session fetched with the given principal.FileSystemItem
getFileSystemItemById(String id, NuxeoPrincipal principal)
Gets theFileSystemItem
with the given id using a core session fetched with the given principal.String
getName()
Gets the factory unique name.boolean
isFileSystemItem(DocumentModel doc)
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.boolean
isFileSystemItem(DocumentModel doc, boolean includeDeleted)
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.protected String[]
parseFileSystemId(String id)
void
setName(String name)
Sets the factory unique name.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.nuxeo.drive.service.FileSystemItemFactory
handleParameters, isFileSystemItem
-
-
-
-
Field Detail
-
name
protected String name
-
-
Method Detail
-
adaptDocument
protected abstract FileSystemItem adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean relaxSyncRootConstraint, boolean getLockInfo)
Adapts the givenDocumentModel
to aFileSystemItem
.
-
getName
public String getName()
Description copied from interface:FileSystemItemFactory
Gets the factory unique name.- Specified by:
getName
in interfaceFileSystemItemFactory
-
setName
public void setName(String name)
Description copied from interface:FileSystemItemFactory
Sets the factory unique name.- Specified by:
setName
in interfaceFileSystemItemFactory
-
isFileSystemItem
public boolean isFileSystemItem(DocumentModel doc)
Description copied from interface:FileSystemItemFactory
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
.- Specified by:
isFileSystemItem
in interfaceFileSystemItemFactory
- See Also:
FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)
-
isFileSystemItem
public boolean isFileSystemItem(DocumentModel doc, boolean includeDeleted)
Description copied from interface:FileSystemItemFactory
Returns true if the givenDocumentModel
is adaptable as aFileSystemItem
. IfincludeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns false.- Specified by:
isFileSystemItem
in interfaceFileSystemItemFactory
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
FileSystemItemFactory.isFileSystemItem(DocumentModel)
,FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean)
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
. IfincludeDeleted
is true no filter is applied on the "trashed" state, else if the document is in the trash it is not considered as adaptable as aFileSystemItem
, thus the method returns null.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean, boolean)
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.If
getLockInfo
is true theLock
is fetched from theDocumentModel
and set on the returnedFileSystemItem
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean, boolean)
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem)
Description copied from interface:FileSystemItemFactory
- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
- See Also:
FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean)
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
. IfincludeDeleted
is true no filter is applied on the "trashed" state, else if the document is in the trash it is not considered as adaptable as aFileSystemItem
, thus the method returns null.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
getFileSystemItem
public FileSystemItem getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
for the givenDocumentModel
forcing its parent with the givenparentItem
.If
includeDeleted
is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as aFileSystemItem
, thus the method returns null.If
relaxSyncRootConstraint
is true no filter is applied on the synchronization root aspect for the current user.If
getLockInfo
is true theLock
is fetched from theDocumentModel
and set on the returnedFileSystemItem
.- Specified by:
getFileSystemItem
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if theDocumentModel
is not adaptable as aFileSystemItem
-
canHandleFileSystemItemId
public boolean canHandleFileSystemItemId(String id)
Description copied from interface:FileSystemItemFactory
Returns true if the givenFileSystemItem
id can be handled by this factory. It is typically the case when the factory has been responsible for generating theFileSystemItem
.- Specified by:
canHandleFileSystemItemId
in interfaceFileSystemItemFactory
-
exists
public boolean exists(String id, NuxeoPrincipal principal)
The default factory considers that aFileSystemItem
with the given id exists if the backingDocumentModel
can be fetched andisFileSystemItem(DocumentModel)
returns true.- Specified by:
exists
in interfaceFileSystemItemFactory
- See Also:
isFileSystemItem(DocumentModel)
-
getFileSystemItemById
public FileSystemItem getFileSystemItemById(String id, NuxeoPrincipal principal)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
with the given id using a core session fetched with the given principal.- Specified by:
getFileSystemItemById
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if none matches the given id
-
getFileSystemItemById
public FileSystemItem getFileSystemItemById(String id, String parentId, NuxeoPrincipal principal)
Description copied from interface:FileSystemItemFactory
Gets theFileSystemItem
with the given id and parent id using a core session fetched with the given principal.- Specified by:
getFileSystemItemById
in interfaceFileSystemItemFactory
- Returns:
- the
FileSystemItem
or null if none matches the given id and parent id
-
adaptDocument
protected FileSystemItem adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem)
-
getFileSystemItem
protected FileSystemItem getFileSystemItem(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
-
getDocumentById
protected DocumentModel getDocumentById(String docId, CoreSession session)
-
-