org.nuxeo.drive.service.impl

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 for FileSystemItemFactory implementers. It is DocumentModel backed.

Author:

Antoine Taillefer

See Also:

DefaultFileSystemItemFactory

Constructor Summary

Constructors

Constructor and Description
AbstractFileSystemItemFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandleFileSystemItemId(String id) Returns true if the given FileSystemItem id can be handled by this factory.
boolean	exists(String id, Principal principal) The default factory considers that a FileSystemItem with the given id exists if the backing DocumentModel can be fetched and isFileSystemItem(DocumentModel) returns true.
DocumentModel	getDocumentByFileSystemId(String id, Principal principal) Deprecated.
FileSystemItem	getFileSystemItem(DocumentModel doc) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.
FileSystemItem	getFileSystemItemById(String id, Principal principal) Gets the FileSystemItem with the given id using a core session fetched with the given principal.
FileSystemItem	getFileSystemItemById(String id, String parentId, Principal principal) Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.
String	getName() Gets the factory unique name.
abstract void	handleParameters(Map<String,String> parameters) Handles the factory parameters contributed through the fileSystemItemFactory contribution.
boolean	isFileSystemItem(DocumentModel doc) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
abstract boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
void	setName(String name) Sets the factory unique name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileSystemItemFactory

public AbstractFileSystemItemFactory()

Method Detail

handleParameters

public abstract void handleParameters(Map<String,String> parameters)
                               throws ClientException

Description copied from interface: FileSystemItemFactory

Handles the factory parameters contributed through the fileSystemItemFactory contribution.

Specified by:

handleParameters in interface FileSystemItemFactory

Throws:

ClientException

isFileSystemItem

public abstract boolean isFileSystemItem(DocumentModel doc,
                       boolean includeDeleted,
                       boolean relaxSyncRootConstraint)
                                  throws ClientException

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem.

If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns false.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Throws:

ClientException

getName

public String getName()

Description copied from interface: FileSystemItemFactory

Gets the factory unique name.

Specified by:

getName in interface FileSystemItemFactory

setName

public void setName(String name)

Description copied from interface: FileSystemItemFactory

Sets the factory unique name.

Specified by:

setName in interface FileSystemItemFactory

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc)
                         throws ClientException

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Throws:

ClientException

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc,
                       boolean includeDeleted)
                         throws ClientException

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem. If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns false.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Throws:

ClientException

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel), FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel. If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean))

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               boolean includeDeleted,
                               boolean relaxSyncRootConstraint)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, 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 interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

#isFileSystemItem(DocumentModel, boolean, boolean))

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel), #getFileSystemItem(DocumentModel, String, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem,
                               boolean includeDeleted)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id. If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                               FolderItem parentItem,
                               boolean includeDeleted,
                               boolean relaxSyncRootConstraint)
                                 throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent id with the given id.

If includeDeleted is true no filter is applied on the "deleted" life cycle state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, 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 interface FileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

Throws:

ClientException

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean, boolean)

canHandleFileSystemItemId

public boolean canHandleFileSystemItemId(String id)

Description copied from interface: FileSystemItemFactory

Returns true if the given FileSystemItem id can be handled by this factory. It is typically the case when the factory has been responsible for generating the FileSystemItem.

Specified by:

canHandleFileSystemItemId in interface FileSystemItemFactory

exists

public boolean exists(String id,
             Principal principal)
               throws ClientException

The default factory considers that a FileSystemItem with the given id exists if the backing DocumentModel can be fetched and isFileSystemItem(DocumentModel) returns true.

Specified by:

exists in interface FileSystemItemFactory

Throws:

ClientException

See Also:

isFileSystemItem(DocumentModel)

getFileSystemItemById

public FileSystemItem getFileSystemItemById(String id,
                                   Principal principal)
                                     throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem with the given id using a core session fetched with the given principal.

Specified by:

getFileSystemItemById in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if none matches the given id

Throws:

ClientException

getFileSystemItemById

public FileSystemItem getFileSystemItemById(String id,
                                   String parentId,
                                   Principal principal)
                                     throws ClientException

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.

Specified by:

getFileSystemItemById in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if none matches the given id and parent id

Throws:

ClientException

getDocumentByFileSystemId

@Deprecated
public DocumentModel getDocumentByFileSystemId(String id,
                                                 Principal principal)
                                        throws ClientException

Deprecated.

Description copied from interface: FileSystemItemFactory

Gets the DocumentModel bound to the given FileSystemItem id using a core session fetched with the given principal.

Specified by:

getDocumentByFileSystemId in interface FileSystemItemFactory

Returns:

the DocumentModel

Throws:

ClientException