Package io.jmix.webdav.tools.impl

Class WebdavSecurityToolsImpl

java.lang.Object

io.jmix.webdav.tools.impl.WebdavSecurityToolsImpl

All Implemented Interfaces:

WebdavSecurityTools

@NullMarked
@Component("webdav_WebdavSecurityTools")
public class WebdavSecurityToolsImpl
extends Object
implements WebdavSecurityTools

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected org.springframework.context.ApplicationContext	applicationContext
protected CurrentAuthentication	currentAuthentication
protected DataManager	dataManager
protected jakarta.persistence.EntityManager	entityManager
protected EntityStates	entityStates
protected Metadata	metadata
protected PolicyStore	policyStore
protected ReferenceIdProvider	referenceIdProvider
protected SecureOperations	secureOperations
protected org.springframework.transaction.support.TransactionTemplate	transaction

Constructor Summary

Constructors

Constructor	Description
WebdavSecurityToolsImpl(DataManager dataManager, EntityStates entityStates, Metadata metadata, SecureOperations secureOperations, PolicyStore policyStore, AccessManager accessManager, CurrentAuthentication currentAuthentication, ReferenceIdProvider referenceIdProvider, org.springframework.context.ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method	Description
void	checkUserCanCreateDocument(WebdavDocument document)
void	checkUserCanCreateDocumentVersion(WebdavDocumentVersion documentVersion)
void	checkUserCanDeleteDocument(WebdavDocument document)
void	checkUserCanDeleteDocumentVersion(WebdavDocumentVersion documentVersion)
void	checkUserCanGetPossibleLockDocument(WebdavDocument document)
void	checkUserCanGetPossibleReadDocument()
void	checkUserCanGetPossibleReadDocumentVersion()
void	checkUserCanGetPossibleUpdateDocument(WebdavDocument document)
void	checkUserCanLockDocument(WebdavDocument document, WebdavLockDescriptor lockDescriptor)
void	checkUserCanReadDocument(WebdavDocument document)	Method always does silent exit, because user already has instance of WebdavDocument
void	checkUserCanReadDocumentById(UUID documentId)
void	checkUserCanReadDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
void	checkUserCanReadDocumentVersion(WebdavDocumentVersion documentVersion)
void	checkUserCanReadDocumentVersionById(UUID documentVersionId)
void	checkUserCanUnlockDocument(WebdavDocument document, WebdavLockDescriptor lock)
void	checkUserCanUpdateDocument(WebdavDocument document, WebdavDocumentVersion documentVersion)
void	checkUserCanUpdateDocumentVersion(WebdavDocumentVersion documentVersion)
void	checkUserIsLockOwner(WebdavDocument document)
protected LoadContext<WebdavDocument>	createLoadContextIsUserPermittedToReadDocument(UUID documentId)
protected InMemoryCrudEntityContext	createWebdavDocumentAccessContext()
protected InMemoryCrudEntityContext	createWebdavDocumentVersionAccessContext()
protected InMemoryCrudEntityContext	createWebdavLockDescriptorAccessContext()
protected boolean	internalIsUserPermittedToReadDocumentVersion(Supplier<WebdavDocumentVersion> documentVersionLoader)
boolean	isUserLockOwner(WebdavDocument document)
boolean	isUserPermittedToCreateDocument(WebdavDocument document)
boolean	isUserPermittedToCreateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToCreateDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToDeleteDocument(WebdavDocument document)
boolean	isUserPermittedToDeleteDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToDeleteDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToGetPossibleLockDocument(WebdavDocument document)
boolean	isUserPermittedToGetPossibleReadDocument()
boolean	isUserPermittedToGetPossibleReadDocumentVersion()
boolean	isUserPermittedToGetPossibleUnlockDocument(WebdavDocument document)
boolean	isUserPermittedToGetPossibleUpdateDocument(WebdavDocument document)
boolean	isUserPermittedToLockDocument(WebdavDocument document, WebdavLockDescriptor lock)
boolean	isUserPermittedToReadDocument(WebdavDocument document)	Method always returns true, because user already has instance of WebdavDocument
boolean	isUserPermittedToReadDocumentById(UUID documentId)
boolean	isUserPermittedToReadDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToReadDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToReadDocumentVersionById(UUID documentVersionId)
boolean	isUserPermittedToReadParentCollectionForDocument(WebdavDocument webdavDocument)
boolean	isUserPermittedToUnlockDocument(WebdavDocument document, WebdavLockDescriptor lock)
boolean	isUserPermittedToUpdateDocument(WebdavDocument document, WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToUpdateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToUpdateDocumentVersion(WebdavDocumentVersion documentVersion)
boolean	isUserPermittedToUpdateParentCollectionForDocument(WebdavDocument webdavDocument)
protected @Nullable UUID	retrieveWebdavDocumentReferenceId(WebdavDocumentVersion loadedDocumentVersion)
protected void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

Methods inherited from class java.lang.Object

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

Field Details

dataManager

protected DataManager dataManager

entityStates

protected EntityStates entityStates

metadata

protected Metadata metadata

secureOperations

protected SecureOperations secureOperations

policyStore

protected PolicyStore policyStore

accessManager

protected AccessManager accessManager

currentAuthentication

protected CurrentAuthentication currentAuthentication

referenceIdProvider

protected ReferenceIdProvider referenceIdProvider

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

entityManager

protected jakarta.persistence.EntityManager entityManager

transaction

protected org.springframework.transaction.support.TransactionTemplate transaction

Constructor Details

WebdavSecurityToolsImpl

public WebdavSecurityToolsImpl(DataManager dataManager,
 EntityStates entityStates,
 Metadata metadata,
 SecureOperations secureOperations,
 PolicyStore policyStore,
 AccessManager accessManager,
 CurrentAuthentication currentAuthentication,
 ReferenceIdProvider referenceIdProvider,
 org.springframework.context.ApplicationContext applicationContext)

Method Details

setTransactionManager

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

checkUserCanReadDocumentById

public void checkUserCanReadDocumentById(UUID documentId)

Specified by:

checkUserCanReadDocumentById in interface WebdavSecurityTools

isUserPermittedToReadDocumentById

public boolean isUserPermittedToReadDocumentById(UUID documentId)

Specified by:

isUserPermittedToReadDocumentById in interface WebdavSecurityTools

createLoadContextIsUserPermittedToReadDocument

protected LoadContext<WebdavDocument> createLoadContextIsUserPermittedToReadDocument(UUID documentId)

checkUserCanReadDocument

public void checkUserCanReadDocument(WebdavDocument document)

Description copied from interface: WebdavSecurityTools

Method always does silent exit, because user already has instance of WebdavDocument

Specified by:

checkUserCanReadDocument in interface WebdavSecurityTools

Parameters:

document - reference on loaded from database instance

isUserPermittedToReadDocument

public boolean isUserPermittedToReadDocument(WebdavDocument document)

Description copied from interface: WebdavSecurityTools

Method always returns true, because user already has instance of WebdavDocument

Specified by:

isUserPermittedToReadDocument in interface WebdavSecurityTools

Parameters:

document - reference on loaded from database instance

checkUserCanReadDocumentByWebdavDocumentVersion

public void checkUserCanReadDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanReadDocumentByWebdavDocumentVersion in interface WebdavSecurityTools

checkUserCanGetPossibleReadDocument

public void checkUserCanGetPossibleReadDocument()

Specified by:

checkUserCanGetPossibleReadDocument in interface WebdavSecurityTools

isUserPermittedToGetPossibleReadDocument

public boolean isUserPermittedToGetPossibleReadDocument()

Specified by:

isUserPermittedToGetPossibleReadDocument in interface WebdavSecurityTools

checkUserCanGetPossibleUpdateDocument

public void checkUserCanGetPossibleUpdateDocument(WebdavDocument document)

Specified by:

checkUserCanGetPossibleUpdateDocument in interface WebdavSecurityTools

isUserPermittedToGetPossibleUpdateDocument

public boolean isUserPermittedToGetPossibleUpdateDocument(WebdavDocument document)

Specified by:

isUserPermittedToGetPossibleUpdateDocument in interface WebdavSecurityTools

checkUserCanUpdateDocument

public void checkUserCanUpdateDocument(WebdavDocument document,
 WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanUpdateDocument in interface WebdavSecurityTools

isUserPermittedToUpdateDocument

public boolean isUserPermittedToUpdateDocument(WebdavDocument document,
 WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToUpdateDocument in interface WebdavSecurityTools

checkUserCanCreateDocument

public void checkUserCanCreateDocument(WebdavDocument document)

Specified by:

checkUserCanCreateDocument in interface WebdavSecurityTools

isUserPermittedToCreateDocument

public boolean isUserPermittedToCreateDocument(WebdavDocument document)

Specified by:

isUserPermittedToCreateDocument in interface WebdavSecurityTools

checkUserCanDeleteDocument

public void checkUserCanDeleteDocument(WebdavDocument document)

Specified by:

checkUserCanDeleteDocument in interface WebdavSecurityTools

isUserPermittedToDeleteDocument

public boolean isUserPermittedToDeleteDocument(WebdavDocument document)

Specified by:

isUserPermittedToDeleteDocument in interface WebdavSecurityTools

checkUserCanGetPossibleLockDocument

public void checkUserCanGetPossibleLockDocument(WebdavDocument document)

Specified by:

checkUserCanGetPossibleLockDocument in interface WebdavSecurityTools

isUserPermittedToGetPossibleLockDocument

public boolean isUserPermittedToGetPossibleLockDocument(WebdavDocument document)

Specified by:

isUserPermittedToGetPossibleLockDocument in interface WebdavSecurityTools

checkUserCanLockDocument

public void checkUserCanLockDocument(WebdavDocument document,
 WebdavLockDescriptor lockDescriptor)

Specified by:

checkUserCanLockDocument in interface WebdavSecurityTools

isUserPermittedToLockDocument

public boolean isUserPermittedToLockDocument(WebdavDocument document,
 WebdavLockDescriptor lock)

Specified by:

isUserPermittedToLockDocument in interface WebdavSecurityTools

checkUserCanUnlockDocument

public void checkUserCanUnlockDocument(WebdavDocument document,
 WebdavLockDescriptor lock)

Specified by:

checkUserCanUnlockDocument in interface WebdavSecurityTools

isUserPermittedToGetPossibleUnlockDocument

public boolean isUserPermittedToGetPossibleUnlockDocument(WebdavDocument document)

Specified by:

isUserPermittedToGetPossibleUnlockDocument in interface WebdavSecurityTools

isUserPermittedToUnlockDocument

public boolean isUserPermittedToUnlockDocument(WebdavDocument document,
 WebdavLockDescriptor lock)

Specified by:

isUserPermittedToUnlockDocument in interface WebdavSecurityTools

checkUserIsLockOwner

public void checkUserIsLockOwner(WebdavDocument document)

Specified by:

checkUserIsLockOwner in interface WebdavSecurityTools

isUserLockOwner

public boolean isUserLockOwner(WebdavDocument document)

Specified by:

isUserLockOwner in interface WebdavSecurityTools

checkUserCanCreateDocumentVersion

public void checkUserCanCreateDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanCreateDocumentVersion in interface WebdavSecurityTools

isUserPermittedToCreateDocumentVersion

public boolean isUserPermittedToCreateDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToCreateDocumentVersion in interface WebdavSecurityTools

checkUserCanGetPossibleReadDocumentVersion

public void checkUserCanGetPossibleReadDocumentVersion()

Specified by:

checkUserCanGetPossibleReadDocumentVersion in interface WebdavSecurityTools

isUserPermittedToGetPossibleReadDocumentVersion

public boolean isUserPermittedToGetPossibleReadDocumentVersion()

Specified by:

isUserPermittedToGetPossibleReadDocumentVersion in interface WebdavSecurityTools

checkUserCanReadDocumentVersionById

public void checkUserCanReadDocumentVersionById(UUID documentVersionId)

Specified by:

checkUserCanReadDocumentVersionById in interface WebdavSecurityTools

checkUserCanReadDocumentVersion

public void checkUserCanReadDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanReadDocumentVersion in interface WebdavSecurityTools

checkUserCanUpdateDocumentVersion

public void checkUserCanUpdateDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanUpdateDocumentVersion in interface WebdavSecurityTools

isUserPermittedToUpdateDocumentVersion

public boolean isUserPermittedToUpdateDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToUpdateDocumentVersion in interface WebdavSecurityTools

checkUserCanDeleteDocumentVersion

public void checkUserCanDeleteDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

checkUserCanDeleteDocumentVersion in interface WebdavSecurityTools

isUserPermittedToDeleteDocumentVersion

public boolean isUserPermittedToDeleteDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToDeleteDocumentVersion in interface WebdavSecurityTools

isUserPermittedToReadParentCollectionForDocument

public boolean isUserPermittedToReadParentCollectionForDocument(WebdavDocument webdavDocument)

Specified by:

isUserPermittedToReadParentCollectionForDocument in interface WebdavSecurityTools

isUserPermittedToUpdateParentCollectionForDocument

public boolean isUserPermittedToUpdateParentCollectionForDocument(WebdavDocument webdavDocument)

Specified by:

isUserPermittedToUpdateParentCollectionForDocument in interface WebdavSecurityTools

isUserPermittedToCreateDocumentByWebdavDocumentVersion

public boolean isUserPermittedToCreateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToCreateDocumentByWebdavDocumentVersion in interface WebdavSecurityTools

isUserPermittedToReadDocumentByWebdavDocumentVersion

public boolean isUserPermittedToReadDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToReadDocumentByWebdavDocumentVersion in interface WebdavSecurityTools

isUserPermittedToUpdateDocumentByWebdavDocumentVersion

public boolean isUserPermittedToUpdateDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToUpdateDocumentByWebdavDocumentVersion in interface WebdavSecurityTools

isUserPermittedToDeleteDocumentByWebdavDocumentVersion

public boolean isUserPermittedToDeleteDocumentByWebdavDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToDeleteDocumentByWebdavDocumentVersion in interface WebdavSecurityTools

isUserPermittedToReadDocumentVersionById

public boolean isUserPermittedToReadDocumentVersionById(UUID documentVersionId)

Specified by:

isUserPermittedToReadDocumentVersionById in interface WebdavSecurityTools

isUserPermittedToReadDocumentVersion

public boolean isUserPermittedToReadDocumentVersion(WebdavDocumentVersion documentVersion)

Specified by:

isUserPermittedToReadDocumentVersion in interface WebdavSecurityTools

internalIsUserPermittedToReadDocumentVersion

protected boolean internalIsUserPermittedToReadDocumentVersion(Supplier<WebdavDocumentVersion> documentVersionLoader)

retrieveWebdavDocumentReferenceId

protected @Nullable UUID retrieveWebdavDocumentReferenceId(WebdavDocumentVersion loadedDocumentVersion)

createWebdavDocumentAccessContext

protected InMemoryCrudEntityContext createWebdavDocumentAccessContext()

createWebdavDocumentVersionAccessContext

protected InMemoryCrudEntityContext createWebdavDocumentVersionAccessContext()

createWebdavLockDescriptorAccessContext

protected InMemoryCrudEntityContext createWebdavLockDescriptorAccessContext()