Package org.apache.logging.log4j.core.appender.rolling.action

Class PosixViewAttributeAction.Builder

java.lang.Object

org.apache.logging.log4j.core.appender.rolling.action.PosixViewAttributeAction.Builder

All Implemented Interfaces:

Builder<PosixViewAttributeAction>

Enclosing class:

PosixViewAttributeAction

public static class PosixViewAttributeAction.Builder
extends java.lang.Object
implements Builder<PosixViewAttributeAction>

Builder for the POSIX view attribute action.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	basePath
private Configuration	configuration
private java.lang.String	fileGroup
private java.lang.String	fileOwner
private java.util.Set<java.nio.file.attribute.PosixFilePermission>	filePermissions
private java.lang.String	filePermissionsString
private boolean	followLinks
private int	maxDepth
private PathCondition[]	pathConditions
private StrSubstitutor	subst

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PosixViewAttributeAction	build()	Builds the object after all configuration has been set.
PosixViewAttributeAction.Builder	setBasePath(java.lang.String basePath)	Define base path to apply condition before execute POSIX file attribute action.
PosixViewAttributeAction.Builder	setConfiguration(Configuration configuration)	Define required configuration, used to retrieve string substituter.
PosixViewAttributeAction.Builder	setFileGroup(java.lang.String fileGroup)	Define file group to apply during action execution eligible files.
PosixViewAttributeAction.Builder	setFileOwner(java.lang.String fileOwner)	Define file owner to apply during action execution eligible files.
PosixViewAttributeAction.Builder	setFilePermissions(java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions)	Define file permissions to apply during action execution eligible files.
PosixViewAttributeAction.Builder	setFilePermissionsString(java.lang.String filePermissionsString)	Define file permissions in POSIX format to apply during action execution eligible files.
PosixViewAttributeAction.Builder	setFollowLinks(boolean followLinks)	True to allow synonyms links during search of eligible files.
PosixViewAttributeAction.Builder	setMaxDepth(int maxDepth)	Define max folder depth to search for eligible files to apply POSIX attribute view.
PosixViewAttributeAction.Builder	setPathConditions(PathCondition[] pathConditions)	Define path conditions to filter files in AbstractPathAction.getBasePath().
PosixViewAttributeAction.Builder	setSubst(StrSubstitutor subst)	Define string substituter.
PosixViewAttributeAction.Builder	withBasePath(java.lang.String basePath)	Deprecated. since 2.26.0 use setBasePath(String).
PosixViewAttributeAction.Builder	withConfiguration(Configuration configuration)	Deprecated. since 2.26.0 use setConfiguration(Configuration).
PosixViewAttributeAction.Builder	withFileGroup(java.lang.String fileGroup)	Deprecated. since 2.26.0 use setFileGroup(String).
PosixViewAttributeAction.Builder	withFileOwner(java.lang.String fileOwner)	Deprecated. since 2.26.0 use setFileOwner(String).
PosixViewAttributeAction.Builder	withFilePermissions(java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions)	Deprecated. since 2.26.0 use #setFilePermissions(Set).
PosixViewAttributeAction.Builder	withFilePermissionsString(java.lang.String filePermissionsString)	Deprecated. since 2.26.0 use setFilePermissionsString(String).
PosixViewAttributeAction.Builder	withFollowLinks(boolean followLinks)	Deprecated. since 2.26.0 use setFollowLinks(boolean).
PosixViewAttributeAction.Builder	withMaxDepth(int maxDepth)	Deprecated. since 2.26.0 use setMaxDepth(int).
PosixViewAttributeAction.Builder	withPathConditions(PathCondition[] pathConditions)	Deprecated. since 2.26.0 use setPathConditions(PathCondition[]).
PosixViewAttributeAction.Builder	withSubst(StrSubstitutor subst)	Deprecated. since 2.26.0 use setSubst(StrSubstitutor).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

configuration

@PluginConfiguration
private Configuration configuration

subst

private StrSubstitutor subst

basePath

@PluginBuilderAttribute
@Required(message="No base path provided")
private java.lang.String basePath

followLinks

@PluginBuilderAttribute
private boolean followLinks

maxDepth

@PluginBuilderAttribute
private int maxDepth

pathConditions

@PluginElement("PathConditions")
private PathCondition[] pathConditions

filePermissionsString

@PluginBuilderAttribute("filePermissions")
private java.lang.String filePermissionsString

filePermissions

private java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions

fileOwner

@PluginBuilderAttribute
private java.lang.String fileOwner

fileGroup

@PluginBuilderAttribute
private java.lang.String fileGroup

Constructor Detail

Builder

public Builder()

Method Detail

build

public PosixViewAttributeAction build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<PosixViewAttributeAction>

Returns:

the configured instance.

setConfiguration

public PosixViewAttributeAction.Builder setConfiguration(Configuration configuration)

Define required configuration, used to retrieve string substituter.

Parameters:

configuration - AbstractPathAction.getStrSubstitutor()

Returns:

This builder

Since:

2.26.0

setSubst

public PosixViewAttributeAction.Builder setSubst(StrSubstitutor subst)

Define string substituter.

Parameters:

subst - AbstractPathAction.getStrSubstitutor()

Returns:

This builder

Since:

2.26.0

setBasePath

public PosixViewAttributeAction.Builder setBasePath(java.lang.String basePath)

Define base path to apply condition before execute POSIX file attribute action.

Parameters:

basePath - AbstractPathAction.getBasePath()

Returns:

This builder

Since:

2.26.0

setFollowLinks

public PosixViewAttributeAction.Builder setFollowLinks(boolean followLinks)

True to allow synonyms links during search of eligible files.

Parameters:

followLinks - Follow synonyms links

Returns:

This builder

Since:

2.26.0

setMaxDepth

public PosixViewAttributeAction.Builder setMaxDepth(int maxDepth)

Define max folder depth to search for eligible files to apply POSIX attribute view.

Parameters:

maxDepth - Max search depth

Returns:

This builder

Since:

2.26.0

setPathConditions

public PosixViewAttributeAction.Builder setPathConditions(PathCondition[] pathConditions)

Define path conditions to filter files in AbstractPathAction.getBasePath().

Parameters:

pathConditions - AbstractPathAction.getPathConditions()

Returns:

This builder

Since:

2.26.0

setFilePermissionsString

public PosixViewAttributeAction.Builder setFilePermissionsString(java.lang.String filePermissionsString)

Define file permissions in POSIX format to apply during action execution eligible files. Example:

rw-rw-rw

r--r--r--

Parameters:

filePermissionsString - Permissions to apply

Returns:

This builder

Since:

2.26.0

setFilePermissions

public PosixViewAttributeAction.Builder setFilePermissions(java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions)

Define file permissions to apply during action execution eligible files.

Parameters:

filePermissions - Permissions to apply

Returns:

This builder

Since:

2.26.0

setFileOwner

public PosixViewAttributeAction.Builder setFileOwner(java.lang.String fileOwner)

Define file owner to apply during action execution eligible files.

Parameters:

fileOwner - File owner

Returns:

This builder

Since:

2.26.0

setFileGroup

public PosixViewAttributeAction.Builder setFileGroup(java.lang.String fileGroup)

Define file group to apply during action execution eligible files.

Parameters:

fileGroup - File group

Returns:

This builder

Since:

2.26.0

withConfiguration

@Deprecated
public PosixViewAttributeAction.Builder withConfiguration(Configuration configuration)

Deprecated.

since 2.26.0 use setConfiguration(Configuration).

withSubst

@Deprecated
public PosixViewAttributeAction.Builder withSubst(StrSubstitutor subst)

Deprecated.

since 2.26.0 use setSubst(StrSubstitutor).

withBasePath

@Deprecated
public PosixViewAttributeAction.Builder withBasePath(java.lang.String basePath)

Deprecated.

since 2.26.0 use setBasePath(String).

withFollowLinks

@Deprecated
public PosixViewAttributeAction.Builder withFollowLinks(boolean followLinks)

Deprecated.

since 2.26.0 use setFollowLinks(boolean).

withMaxDepth

@Deprecated
public PosixViewAttributeAction.Builder withMaxDepth(int maxDepth)

Deprecated.

since 2.26.0 use setMaxDepth(int).

withPathConditions

@Deprecated
public PosixViewAttributeAction.Builder withPathConditions(PathCondition[] pathConditions)

Deprecated.

since 2.26.0 use setPathConditions(PathCondition[]).

withFilePermissionsString

@Deprecated
public PosixViewAttributeAction.Builder withFilePermissionsString(java.lang.String filePermissionsString)

Deprecated.

since 2.26.0 use setFilePermissionsString(String).

withFilePermissions

@Deprecated
public PosixViewAttributeAction.Builder withFilePermissions(java.util.Set<java.nio.file.attribute.PosixFilePermission> filePermissions)

Deprecated.

since 2.26.0 use #setFilePermissions(Set).

withFileOwner

@Deprecated
public PosixViewAttributeAction.Builder withFileOwner(java.lang.String fileOwner)

Deprecated.

since 2.26.0 use setFileOwner(String).

withFileGroup

@Deprecated
public PosixViewAttributeAction.Builder withFileGroup(java.lang.String fileGroup)

Deprecated.

since 2.26.0 use setFileGroup(String).