Package io.jmix.webdav.service.impl

Class WebdavDocumentsManagementServiceImpl

java.lang.Object

io.jmix.webdav.service.impl.WebdavDocumentsManagementServiceImpl

All Implemented Interfaces:

WebdavDocumentsManagementService

@Component("webdav_WebdavDocumentsManagementService")
public class WebdavDocumentsManagementServiceImpl
extends Object
implements WebdavDocumentsManagementService

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationEventPublisher	applicationEventPublisher
protected DataManager	dataManager
protected WebdavDocumentVersionsManagementService	documentVersionsManagementService
protected jakarta.persistence.EntityManager	entityManager
protected FetchPlanRepository	fetchPlanRepository
protected Metadata	metadata
static final String	RETRIEVE_ROOT_WEBDAV_DOCUMENTS
static final String	RETRIEVE_WEBDAV_DOCUMENT_BY_PATH_LIKE_ESCAPED_TEMPLATE
static final String	RETRIEVE_WEBDAV_DOCUMENT_BY_WEBDAV_DOCUMENT_VERSION_ID
static final String	RETRIEVE_WEBDAV_DOCUMENTS_STARTING_WITH_PATH_ESCAPED_TEMPLATE
protected TimeSource	timeSource
protected org.springframework.transaction.support.TransactionTemplate	transaction
protected WebdavResourceUriTools	uriTools
protected WebdavNaturalVersionIdGenerator	webdavNaturalVersionIdGenerator
protected WebdavPreconditions	webdavPreconditions
protected WebdavProperties	webdavProperties
protected WebdavSecurityTools	webdavSecurityTools
protected WebdavTools	webdavTools

Constructor Summary

Constructors

Constructor

Description

WebdavDocumentsManagementServiceImpl(FetchPlanRepository fetchPlanRepository, WebdavPreconditions webdavPreconditions, WebdavResourceUriTools uriTools, Metadata metadata, DataManager dataManager, WebdavProperties webdavProperties, WebdavSecurityTools webdavSecurityTools, WebdavTools webdavTools, TimeSource timeSource, WebdavDocumentVersionsManagementService documentVersionsManagementService, WebdavNaturalVersionIdGenerator webdavNaturalVersionIdGenerator, org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Method Summary

Modifier and Type	Method	Description
protected void	acceptOnlyLastVersionIfVersioningDisabled(WebdavDocument document, MergePolicy<?> mergePolicy, WebdavDocumentVersion lastVersion, List<MergeResultItem<WebdavDocumentVersion>> merged, List<WebdavDocumentVersion> documentVersions)
protected Stream<WebdavDocumentVersion>	applyMergeOperation(MergeResultItem<WebdavDocumentVersion> resultItem)
protected String	buildEscapedQuery(String query, Character escapeCharacter)
protected WebdavDocument	copySingleWebdavDocument(WebdavDocument sourceDocument, URI destinationUri)
WebdavDocument	copyWebdavDocument(WebdavDocument sourceDocument, URI destinationUri, boolean overwrite, Depth depth)
WebdavDocument	createDocumentCollection(String name, WebdavDocument parentCollection)	Creates a document collection inside the given parent collection.
WebdavDocument	createDocumentCollectionByUri(URI documentPath)	Creates a document collection by the given URI.
WebdavDocument	createNonVersioningDocumentByFileRef(FileRef fileRef)	Creates a non-versioning document.
WebdavDocument	createNonVersioningDocumentByFileRef(FileRef fileRef, WebdavDocument parent)	Creates a non-versioning document.
WebdavDocument	createVersioningDocumentByFileRef(FileRef fileRef)	Creates a versioning document.
WebdavDocument	createVersioningDocumentByFileRef(FileRef fileRef, WebdavDocument parent)	Creates a versioning document.
protected String	escapeLikeClauseParameter(String value, Character escapeCharacter)
protected String	escapePath(String path)
protected WebdavLockDescriptor	internalCreateLock(WebdavDocument webdavDocument, long timeout)
protected WebdavLockDescriptor	internalRefreshLock(WebdavDocument document, long timeout)
protected void	internalRemoveNonCollectionDocument(WebdavDocument webdavDocument)
protected boolean	isNonVersioningPolicy(MergePolicy<?> mergePolicy)
WebdavDocument	lockDocumentByWebdavDocument(WebdavDocument document)	Creates a lock for document with default timeout.
WebdavDocument	lockDocumentByWebdavDocument(WebdavDocument document, long timeout)	Creates a lock for document with specific timeout.
WebdavDocument	lockDocumentByWebdavDocumentId(UUID documentId)	Creates a lock for document with default timeout.
WebdavDocument	lockDocumentByWebdavDocumentId(UUID documentId, long timeout)	Creates a lock for document with specific timeout.
WebdavDocument	lockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)	Creates a lock for document with default timeout.
WebdavDocument	lockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, long timeout)	Creates a lock for document with specific timeout.
WebdavDocument	lockDocumentByWebdavDocumentVersionId(UUID documentVersionId)	Creates a lock for document with default timeout.
WebdavDocument	lockDocumentByWebdavDocumentVersionId(UUID documentVersionId, long timeout)	Creates a lock for document with specific timeout.
WebdavDocument	moveWebdavDocument(WebdavDocument sourceDocument, URI destinationUri, boolean overwrite)
void	removeDocumentByWebdavDocument(WebdavDocument webdavDocument)	Removes a document.
void	removeDocumentByWebdavDocumentId(UUID documentId)	Removes a document.
void	removeDocumentByWebdavDocumentUri(URI documentPath)	Removes a document.
void	removeDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)	Removes a document.
void	removeDocumentByWebdavDocumentVersionId(UUID documentVersionId)	Removes a document.
protected void	removeDocumentCollection(WebdavDocument webdavDocument)	Removes a document collections along with all its members.
protected void	removeStandaloneNonCollectionDocument(WebdavDocument webdavDocument)	This method is designed to remove standalone document directly (not during removing some collection).
protected MergePolicy<WebdavDocumentVersion>	resolveEffectiveVersionsMergePolicy(WebdavDocument documentFromUser, WebdavDocument documentFromDb, MergePolicy<WebdavDocumentVersion> exceptionMergePolicy)
List<WebdavDocument>	retrieveAllChildDocumentsByParentDocument(WebdavDocument webdavDocument, FetchPlan fetchPlan)	Returns a list containing all descendants of the given document.
List<WebdavDocument>	retrieveAllChildDocumentsByParentDocumentURI(URI parentUri, FetchPlan fetchPlan)	Returns a list containing all descendants of the document defined by the given resource path.
List<WebdavDocument>	retrieveAllChildDocumentsByParentPath(String parentPath, FetchPlan fetchPlan)	Returns a list containing all descendants of the document defined by the given parent string path.
List<WebdavDocument>	retrieveAllChildDocumentsByParentPath(String parentPath, FetchPlan fetchPlan, boolean softDelete)	Returns a list containing all descendants of the document defined by the given parent string path.
WebdavDocument	retrieveDocumentByWebdavDocumentId(UUID documentId)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentId(UUID documentId, FetchPlan fetchPlan)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentId(UUID documentId, String fetchPlanName)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentIdNN(UUID documentId)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentIdNN(UUID documentId, FetchPlan fetchPlan)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentIdNN(UUID documentId, String fetchPlanName)	Returns a document by a document id.
WebdavDocument	retrieveDocumentByWebdavDocumentUri(URI documentPath)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentUri(URI documentPath, FetchPlan fetchPlan)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentUri(URI documentPath, String fetchPlanName)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentUriNN(URI documentPath)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentUriNN(URI documentPath, FetchPlan fetchPlan)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentUriNN(URI documentPath, String fetchPlanName)	Returns a document by a document URI.
WebdavDocument	retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)	Returns a document by a document version.
WebdavDocument	retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, FetchPlan fetchPlan)	Returns document by document version.
WebdavDocument	retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, String fetchPlanName)	Returns document by document version.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId)	Returns a document by a document version id.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId, FetchPlan fetchPlan)	Returns a document by a document version id.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId, String fetchPlanName)	Returns a document by a document version id.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion)	Returns a document by a document version.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion, FetchPlan fetchPlan)	Returns a document by a document version.
WebdavDocument	retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion, String fetchPlanName)	Returns a document by a document version.
List<WebdavDocument>	retrieveRootDocuments(FetchPlan fetchPlan)	Returns a list of documents that virtually belong to the top-level collection.
protected void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
WebdavDocument	unlockDocumentByWebdavDocument(WebdavDocument document)	Removes a lock for document.
WebdavDocument	unlockDocumentByWebdavDocumentId(UUID documentId)	Removes a lock for document.
WebdavDocument	unlockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)	Removes a lock for document.
WebdavDocument	unlockDocumentByWebdavDocumentVersionId(UUID documentVersionId)	Removes a lock for document.
WebdavDocument	updateDocumentByConcreteVersions(WebdavDocument document, List<WebdavDocumentVersion> documentVersions, MergePolicy<WebdavDocumentVersion> exceptionMergePolicy)	Adds new versions from documentVersions to document and resolves conflicts.
WebdavDocument	updateDocumentByWebdavDocument(WebdavDocument document, FileRef fileRef)	Adds a new document version to a document.
WebdavDocument	updateDocumentByWebdavDocumentId(UUID documentId, FileRef fileRef)	Returns document with new added version.
WebdavDocument	updateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion, FileRef fileRef)	Adds a new document version to a document.
WebdavDocument	updateDocumentByWebdavDocumentVersionId(UUID documentVersionId, FileRef fileRef)	Adds a new document version to a document.
WebdavDocument	updateDocumentVersioning(WebdavDocument document, boolean versioning)	Enables or disables a document versioning.
WebdavDocument	updateDocumentVersioning(WebdavDocument document, boolean versioning, FetchPlan fetchPlan)	Enables or disables a document versioning.
WebdavDocument	updateDocumentVersioning(WebdavDocument document, boolean versioning, String fetchPlanName)	Enables or disables a document versioning.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.webdav.service.WebdavDocumentsManagementService

copyWebdavDocument, moveWebdavDocument

Field Details

RETRIEVE_WEBDAV_DOCUMENT_BY_WEBDAV_DOCUMENT_VERSION_ID

public static final String RETRIEVE_WEBDAV_DOCUMENT_BY_WEBDAV_DOCUMENT_VERSION_ID

See Also:

• Constant Field Values

RETRIEVE_WEBDAV_DOCUMENT_BY_PATH_LIKE_ESCAPED_TEMPLATE

public static final String RETRIEVE_WEBDAV_DOCUMENT_BY_PATH_LIKE_ESCAPED_TEMPLATE

See Also:

• Constant Field Values

RETRIEVE_WEBDAV_DOCUMENTS_STARTING_WITH_PATH_ESCAPED_TEMPLATE

public static final String RETRIEVE_WEBDAV_DOCUMENTS_STARTING_WITH_PATH_ESCAPED_TEMPLATE

See Also:

• Constant Field Values

RETRIEVE_ROOT_WEBDAV_DOCUMENTS

public static final String RETRIEVE_ROOT_WEBDAV_DOCUMENTS

See Also:

• Constant Field Values

fetchPlanRepository

protected FetchPlanRepository fetchPlanRepository

webdavPreconditions

protected WebdavPreconditions webdavPreconditions

uriTools

protected WebdavResourceUriTools uriTools

metadata

protected Metadata metadata

dataManager

protected DataManager dataManager

webdavProperties

protected WebdavProperties webdavProperties

webdavSecurityTools

protected WebdavSecurityTools webdavSecurityTools

webdavTools

protected WebdavTools webdavTools

timeSource

protected TimeSource timeSource

entityManager

protected jakarta.persistence.EntityManager entityManager

transaction

protected org.springframework.transaction.support.TransactionTemplate transaction

documentVersionsManagementService

protected WebdavDocumentVersionsManagementService documentVersionsManagementService

webdavNaturalVersionIdGenerator

protected WebdavNaturalVersionIdGenerator webdavNaturalVersionIdGenerator

applicationEventPublisher

protected org.springframework.context.ApplicationEventPublisher applicationEventPublisher

Constructor Details

WebdavDocumentsManagementServiceImpl

public WebdavDocumentsManagementServiceImpl(FetchPlanRepository fetchPlanRepository,
 WebdavPreconditions webdavPreconditions,
 WebdavResourceUriTools uriTools,
 Metadata metadata,
 DataManager dataManager,
 WebdavProperties webdavProperties,
 WebdavSecurityTools webdavSecurityTools,
 WebdavTools webdavTools,
 TimeSource timeSource,
 WebdavDocumentVersionsManagementService documentVersionsManagementService,
 WebdavNaturalVersionIdGenerator webdavNaturalVersionIdGenerator,
 org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Method Details

setTransactionManager

@Autowired
protected void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

retrieveDocumentByWebdavDocumentVersionId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version id.

Specified by:

retrieveDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentVersionId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version id.

Specified by:

retrieveDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentVersionId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersionId(UUID documentVersionId,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version id.

Specified by:

retrieveDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentId(UUID documentId)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentIdNN

public WebdavDocument retrieveDocumentByWebdavDocumentIdNN(UUID documentId)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentIdNN in interface WebdavDocumentsManagementService

retrieveDocumentByWebdavDocumentId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentId(UUID documentId,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentIdNN

public WebdavDocument retrieveDocumentByWebdavDocumentIdNN(UUID documentId,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentIdNN in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

retrieveDocumentByWebdavDocumentId

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentId(UUID documentId,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentIdNN

public WebdavDocument retrieveDocumentByWebdavDocumentIdNN(UUID documentId,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document id.

Specified by:

retrieveDocumentByWebdavDocumentIdNN in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

retrieveDocumentByWebdavDocumentUri

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentUri(URI documentPath)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUri in interface WebdavDocumentsManagementService

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentUriNN

public WebdavDocument retrieveDocumentByWebdavDocumentUriNN(URI documentPath)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUriNN in interface WebdavDocumentsManagementService

retrieveDocumentByWebdavDocumentUri

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentUri(URI documentPath,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUri in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentUriNN

public WebdavDocument retrieveDocumentByWebdavDocumentUriNN(URI documentPath,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUriNN in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

retrieveDocumentByWebdavDocumentUri

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentUri(URI documentPath,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUri in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentUriNN

public WebdavDocument retrieveDocumentByWebdavDocumentUriNN(URI documentPath,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document URI.

Specified by:

retrieveDocumentByWebdavDocumentUriNN in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

retrieveDocumentByWebdavDocumentVersion

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version.

Specified by:

retrieveDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentVersionNN

public WebdavDocument retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version.

Specified by:

retrieveDocumentByWebdavDocumentVersionNN in interface WebdavDocumentsManagementService

retrieveDocumentByWebdavDocumentVersion

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns document by document version.

Specified by:

retrieveDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentVersionNN

public WebdavDocument retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version.

Specified by:

retrieveDocumentByWebdavDocumentVersionNN in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

retrieveDocumentByWebdavDocumentVersion

@Nullable
public WebdavDocument retrieveDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns document by document version.

Specified by:

retrieveDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

Returns:

null if a document is not found

retrieveDocumentByWebdavDocumentVersionNN

public WebdavDocument retrieveDocumentByWebdavDocumentVersionNN(WebdavDocumentVersion documentVersion,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a document by a document version.

Specified by:

retrieveDocumentByWebdavDocumentVersionNN in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

retrieveRootDocuments

public List<WebdavDocument> retrieveRootDocuments(FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a list of documents that virtually belong to the top-level collection.

Specified by:

retrieveRootDocuments in interface WebdavDocumentsManagementService

retrieveAllChildDocumentsByParentDocument

public List<WebdavDocument> retrieveAllChildDocumentsByParentDocument(WebdavDocument webdavDocument,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a list containing all descendants of the given document.

Specified by:

retrieveAllChildDocumentsByParentDocument in interface WebdavDocumentsManagementService

retrieveAllChildDocumentsByParentDocumentURI

public List<WebdavDocument> retrieveAllChildDocumentsByParentDocumentURI(URI parentUri,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a list containing all descendants of the document defined by the given resource path.

Specified by:

retrieveAllChildDocumentsByParentDocumentURI in interface WebdavDocumentsManagementService

retrieveAllChildDocumentsByParentPath

public List<WebdavDocument> retrieveAllChildDocumentsByParentPath(String parentPath,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Returns a list containing all descendants of the document defined by the given parent string path. Soft-deleted documents are excluded.

Specified by:

retrieveAllChildDocumentsByParentPath in interface WebdavDocumentsManagementService

Parameters:

parentPath - full path of the parent directory

fetchPlan - fetch plan for loading

Returns:

list of found documents.

retrieveAllChildDocumentsByParentPath

public List<WebdavDocument> retrieveAllChildDocumentsByParentPath(String parentPath,
 FetchPlan fetchPlan,
 boolean softDelete)

Description copied from interface: WebdavDocumentsManagementService

Returns a list containing all descendants of the document defined by the given parent string path.

Specified by:

retrieveAllChildDocumentsByParentPath in interface WebdavDocumentsManagementService

Parameters:

parentPath - full path of the parent directory

fetchPlan - fetch plan for loading

softDelete - enable\disable soft-delete condition

Returns:

list of found documents.

lockDocumentByWebdavDocumentId

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentId(UUID documentId)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with default timeout. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocumentId

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentId(UUID documentId,
 long timeout)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with specific timeout. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocument

@Transactional
public WebdavDocument lockDocumentByWebdavDocument(WebdavDocument document)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with default timeout. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocument in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocumentVersionId

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentVersionId(UUID documentVersionId)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with default timeout. The document is found by a version id. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocumentVersionId

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentVersionId(UUID documentVersionId,
 long timeout)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with specific timeout. The document is found by a version id. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocumentVersion

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with default timeout. The document is found by a version. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocumentVersion

@Transactional
public WebdavDocument lockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion,
 long timeout)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with specific timeout. The document is found by a version. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

Returns:

a locked document

lockDocumentByWebdavDocument

@Transactional
public WebdavDocument lockDocumentByWebdavDocument(WebdavDocument document,
 long timeout)

Description copied from interface: WebdavDocumentsManagementService

Creates a lock for document with specific timeout. Automatically creates a transaction when the method is called.

Specified by:

lockDocumentByWebdavDocument in interface WebdavDocumentsManagementService

Returns:

a locked document

internalRefreshLock

protected WebdavLockDescriptor internalRefreshLock(@Mutable(fieldName="webdavLockDescriptor")
 WebdavDocument document,
 long timeout)

internalCreateLock

protected WebdavLockDescriptor internalCreateLock(WebdavDocument webdavDocument,
 long timeout)

unlockDocumentByWebdavDocumentId

public WebdavDocument unlockDocumentByWebdavDocumentId(UUID documentId)

Description copied from interface: WebdavDocumentsManagementService

Removes a lock for document.

Specified by:

unlockDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

Returns:

a unlocked document

unlockDocumentByWebdavDocument

public WebdavDocument unlockDocumentByWebdavDocument(WebdavDocument document)

Description copied from interface: WebdavDocumentsManagementService

Removes a lock for document.

Specified by:

unlockDocumentByWebdavDocument in interface WebdavDocumentsManagementService

Returns:

a unlocked document

unlockDocumentByWebdavDocumentVersionId

public WebdavDocument unlockDocumentByWebdavDocumentVersionId(UUID documentVersionId)

Description copied from interface: WebdavDocumentsManagementService

Removes a lock for document. The document is found by document version id.

Specified by:

unlockDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

Returns:

a unlocked document

unlockDocumentByWebdavDocumentVersion

public WebdavDocument unlockDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Description copied from interface: WebdavDocumentsManagementService

Removes a lock for document. The document is found by document version.

Specified by:

unlockDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

Returns:

a unlocked document

updateDocumentByConcreteVersions

@Transactional
public WebdavDocument updateDocumentByConcreteVersions(WebdavDocument document,
 List<WebdavDocumentVersion> documentVersions,
 MergePolicy<WebdavDocumentVersion> exceptionMergePolicy)

Description copied from interface: WebdavDocumentsManagementService

Adds new versions from documentVersions to document and resolves conflicts. Conflicts occur if last version of changed document is differs from last version of document in database. For conflict solving is used policy from exceptionMergePolicy.

Specified by:

updateDocumentByConcreteVersions in interface WebdavDocumentsManagementService

resolveEffectiveVersionsMergePolicy

protected MergePolicy<WebdavDocumentVersion> resolveEffectiveVersionsMergePolicy(WebdavDocument documentFromUser,
 WebdavDocument documentFromDb,
 MergePolicy<WebdavDocumentVersion> exceptionMergePolicy)

applyMergeOperation

protected Stream<WebdavDocumentVersion> applyMergeOperation(MergeResultItem<WebdavDocumentVersion> resultItem)

acceptOnlyLastVersionIfVersioningDisabled

protected void acceptOnlyLastVersionIfVersioningDisabled(WebdavDocument document,
 MergePolicy<?> mergePolicy,
 WebdavDocumentVersion lastVersion,
 List<MergeResultItem<WebdavDocumentVersion>> merged,
 List<WebdavDocumentVersion> documentVersions)

isNonVersioningPolicy

protected boolean isNonVersioningPolicy(MergePolicy<?> mergePolicy)

updateDocumentByWebdavDocumentId

public WebdavDocument updateDocumentByWebdavDocumentId(UUID documentId,
 FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Returns document with new added version. New version is created by FileDescriptor instance and is set as last version. Document for update is set by id.

Specified by:

updateDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

updateDocumentByWebdavDocument

public WebdavDocument updateDocumentByWebdavDocument(WebdavDocument document,
 FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Adds a new document version to a document. The new version is based on a file reference.

Specified by:

updateDocumentByWebdavDocument in interface WebdavDocumentsManagementService

Returns:

a updated document with a new last version

updateDocumentByWebdavDocumentVersion

public WebdavDocument updateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion,
 FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Adds a new document version to a document. The new version is based on a file reference. The document is found by a document version.

Specified by:

updateDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

Returns:

a updated document with a new last version

updateDocumentByWebdavDocumentVersionId

public WebdavDocument updateDocumentByWebdavDocumentVersionId(UUID documentVersionId,
 FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Adds a new document version to a document. The new version is based on a file descriptor. The document is found by a document version id.

Specified by:

updateDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

Returns:

a updated document with a new last version

createVersioningDocumentByFileRef

public WebdavDocument createVersioningDocumentByFileRef(FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Creates a versioning document. The document will contain a version based on file reference. The document will not have a parent document specified, which means that it will be shown in the root collection.

Specified by:

createVersioningDocumentByFileRef in interface WebdavDocumentsManagementService

createVersioningDocumentByFileRef

public WebdavDocument createVersioningDocumentByFileRef(FileRef fileRef,
 @Nullable
 WebdavDocument parent)

Description copied from interface: WebdavDocumentsManagementService

Creates a versioning document. The document will contain a version based on file reference.

Specified by:

createVersioningDocumentByFileRef in interface WebdavDocumentsManagementService

createNonVersioningDocumentByFileRef

public WebdavDocument createNonVersioningDocumentByFileRef(FileRef fileRef)

Description copied from interface: WebdavDocumentsManagementService

Creates a non-versioning document. The document will contain a version based on file reference. The document will not have a parent document specified, which means that it will be shown in the root collection.

Specified by:

createNonVersioningDocumentByFileRef in interface WebdavDocumentsManagementService

createNonVersioningDocumentByFileRef

public WebdavDocument createNonVersioningDocumentByFileRef(FileRef fileRef,
 @Nullable
 WebdavDocument parent)

Description copied from interface: WebdavDocumentsManagementService

Creates a non-versioning document. The document will contain a version based on file reference.

Specified by:

createNonVersioningDocumentByFileRef in interface WebdavDocumentsManagementService

createDocumentCollection

public WebdavDocument createDocumentCollection(String name,
 @Nullable
 WebdavDocument parentCollection)

Description copied from interface: WebdavDocumentsManagementService

Creates a document collection inside the given parent collection. If the parent collection is null, the resulting collection will be created within the root collection.

Specified by:

createDocumentCollection in interface WebdavDocumentsManagementService

createDocumentCollectionByUri

public WebdavDocument createDocumentCollectionByUri(URI documentPath)

Description copied from interface: WebdavDocumentsManagementService

Creates a document collection by the given URI.

Specified by:

createDocumentCollectionByUri in interface WebdavDocumentsManagementService

updateDocumentVersioning

public WebdavDocument updateDocumentVersioning(WebdavDocument document,
 boolean versioning)

Description copied from interface: WebdavDocumentsManagementService

Enables or disables a document versioning.

Specified by:

updateDocumentVersioning in interface WebdavDocumentsManagementService

updateDocumentVersioning

public WebdavDocument updateDocumentVersioning(WebdavDocument document,
 boolean versioning,
 String fetchPlanName)

Description copied from interface: WebdavDocumentsManagementService

Enables or disables a document versioning.

Specified by:

updateDocumentVersioning in interface WebdavDocumentsManagementService

fetchPlanName - a returned document fetch plan

updateDocumentVersioning

public WebdavDocument updateDocumentVersioning(WebdavDocument document,
 boolean versioning,
 FetchPlan fetchPlan)

Description copied from interface: WebdavDocumentsManagementService

Enables or disables a document versioning.

Specified by:

updateDocumentVersioning in interface WebdavDocumentsManagementService

fetchPlan - a returned document fetch plan

removeDocumentByWebdavDocumentId

public void removeDocumentByWebdavDocumentId(UUID documentId)

Description copied from interface: WebdavDocumentsManagementService

Removes a document. If the document is collection, it will be deleted with all child members.

Specified by:

removeDocumentByWebdavDocumentId in interface WebdavDocumentsManagementService

removeDocumentByWebdavDocumentUri

public void removeDocumentByWebdavDocumentUri(URI documentPath)

Description copied from interface: WebdavDocumentsManagementService

Removes a document. If the document is collection, it will be deleted with all child members.

Specified by:

removeDocumentByWebdavDocumentUri in interface WebdavDocumentsManagementService

removeDocumentByWebdavDocument

public void removeDocumentByWebdavDocument(WebdavDocument webdavDocument)

Description copied from interface: WebdavDocumentsManagementService

Removes a document. If the document is collection, it will be deleted with all child members.

Specified by:

removeDocumentByWebdavDocument in interface WebdavDocumentsManagementService

removeDocumentByWebdavDocumentVersionId

public void removeDocumentByWebdavDocumentVersionId(UUID documentVersionId)

Description copied from interface: WebdavDocumentsManagementService

Removes a document. The document is found by document version id.

Specified by:

removeDocumentByWebdavDocumentVersionId in interface WebdavDocumentsManagementService

removeDocumentByWebdavDocumentVersion

public void removeDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Description copied from interface: WebdavDocumentsManagementService

Removes a document. The document is found by document version.

Specified by:

removeDocumentByWebdavDocumentVersion in interface WebdavDocumentsManagementService

removeDocumentCollection

protected void removeDocumentCollection(WebdavDocument webdavDocument)

Removes a document collections along with all its members. This method implicitly locks all documents before delete.

removeStandaloneNonCollectionDocument

protected void removeStandaloneNonCollectionDocument(WebdavDocument webdavDocument)

This method is designed to remove standalone document directly (not during removing some collection).

internalRemoveNonCollectionDocument

protected void internalRemoveNonCollectionDocument(WebdavDocument webdavDocument)

copyWebdavDocument

public WebdavDocument copyWebdavDocument(WebdavDocument sourceDocument,
 URI destinationUri,
 boolean overwrite,
 Depth depth)

Specified by:

copyWebdavDocument in interface WebdavDocumentsManagementService

copySingleWebdavDocument

protected WebdavDocument copySingleWebdavDocument(WebdavDocument sourceDocument,
 URI destinationUri)

moveWebdavDocument

public WebdavDocument moveWebdavDocument(WebdavDocument sourceDocument,
 URI destinationUri,
 boolean overwrite)

Specified by:

moveWebdavDocument in interface WebdavDocumentsManagementService

buildEscapedQuery

protected String buildEscapedQuery(String query,
 Character escapeCharacter)

escapeLikeClauseParameter

protected String escapeLikeClauseParameter(String value,
 Character escapeCharacter)

escapePath

protected String escapePath(String path)