Package com.marklogic.client.ext.file

Class PermissionsFileDocumentFileProcessor

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.client.ext.file.PropertiesDrivenDocumentFileProcessor

com.marklogic.client.ext.file.PermissionsFileDocumentFileProcessor

All Implemented Interfaces:

DocumentFileProcessor, SupportsTokenReplacer, java.io.FileFilter, java.nio.file.FileVisitor<java.nio.file.Path>

public class PermissionsFileDocumentFileProcessor
extends PropertiesDrivenDocumentFileProcessor

Looks for a special file in each directory - defaults to permissions.properties - that contains properties where the key is the name of a file in the directory, and the value is a comma-delimited list of role,capability,role,capability,etc.

Field Summary

Fields inherited from class com.marklogic.client.ext.file.PropertiesDrivenDocumentFileProcessor

WILDCARD_KEY

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

logger

Constructor Summary

Constructors

Constructor	Description
PermissionsFileDocumentFileProcessor()
PermissionsFileDocumentFileProcessor(java.lang.String propertiesFilename)
PermissionsFileDocumentFileProcessor(java.lang.String propertiesFilename, DocumentPermissionsParser documentPermissionsParser)	Deprecated. since 4.6.0

Method Summary

Modifier and Type	Method	Description
boolean	isCascadingEnabled()
java.nio.file.FileVisitResult	postVisitDirectory(java.nio.file.Path dir, java.io.IOException exc)
java.nio.file.FileVisitResult	preVisitDirectory(java.nio.file.Path dir, java.nio.file.attribute.BasicFileAttributes attrs)
protected void	processProperties(DocumentFile documentFile, java.util.Properties properties)
void	setCascadingEnabled(boolean cascadingEnabled)
void	setDocumentPermissionsParser(DocumentPermissionsParser documentPermissionsParser)	Deprecated.
java.nio.file.FileVisitResult	visitFile(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attrs)
java.nio.file.FileVisitResult	visitFileFailed(java.nio.file.Path file, java.io.IOException exc)

Methods inherited from class com.marklogic.client.ext.file.PropertiesDrivenDocumentFileProcessor

accept, getProperties, getPropertiesFilename, getPropertyValue, getTokenReplacer, loadProperties, processDocumentFile, setProperties, setTokenReplacer

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

format

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsFileDocumentFileProcessor

public PermissionsFileDocumentFileProcessor()

PermissionsFileDocumentFileProcessor

public PermissionsFileDocumentFileProcessor(java.lang.String propertiesFilename)

PermissionsFileDocumentFileProcessor

@Deprecated
public PermissionsFileDocumentFileProcessor(java.lang.String propertiesFilename,
                                            DocumentPermissionsParser documentPermissionsParser)

Deprecated.

since 4.6.0

Parameters:

propertiesFilename -

documentPermissionsParser -

Method Detail

processProperties

protected void processProperties(DocumentFile documentFile,
                                 java.util.Properties properties)

Specified by:

processProperties in class PropertiesDrivenDocumentFileProcessor

setDocumentPermissionsParser

@Deprecated
public void setDocumentPermissionsParser(DocumentPermissionsParser documentPermissionsParser)

Deprecated.

preVisitDirectory

public java.nio.file.FileVisitResult preVisitDirectory(java.nio.file.Path dir,
                                                       java.nio.file.attribute.BasicFileAttributes attrs)
                                                throws java.io.IOException

Specified by:

preVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

postVisitDirectory

public java.nio.file.FileVisitResult postVisitDirectory(java.nio.file.Path dir,
                                                        java.io.IOException exc)

Specified by:

postVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

visitFile

public java.nio.file.FileVisitResult visitFile(java.nio.file.Path file,
                                               java.nio.file.attribute.BasicFileAttributes attrs)

Specified by:

visitFile in interface java.nio.file.FileVisitor<java.nio.file.Path>

visitFileFailed

public java.nio.file.FileVisitResult visitFileFailed(java.nio.file.Path file,
                                                     java.io.IOException exc)

Specified by:

visitFileFailed in interface java.nio.file.FileVisitor<java.nio.file.Path>

isCascadingEnabled

public boolean isCascadingEnabled()

setCascadingEnabled

public void setCascadingEnabled(boolean cascadingEnabled)