Sets PosixFilePermissions for resources.

This task provides a subset of Chmod's and org.apache.tools.ant.taskdefs.optional.windows.Attrib's abilities in less platform dependent way.

It requires a file system that supports PosixFilePermissions for its full potential. It can optionally fall back to DosFilePermissions (only changing the readonly state) on file systems that don't support POSIX permissions. See SetPermissions.NonPosixMode

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	SetPermissions.NonPosixMode Options for dealing with file systems that don't support POSIX permissions.

Field Summary

Modifier and Type	Field and Description
private boolean	failonerror
private SetPermissions.NonPosixMode	nonPosixMode
private final Set<PosixFilePermission>	permissions
private Resources	resources

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	SetPermissions()

Method Summary

Modifier and Type	Method and Description
public void	add(ResourceCollection a resource collection rc) Adds a collection of resources to set permissions on.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Called by the project to let the task do its work.
private boolean	isWritable()
private void	maybeThrowException(Exception exc, String msgFormat, Object... msgArgs)
private void	posixPermissionsNotSupported(Path p)
public void	setFailOnError(final boolean true or false. failonerror) Set whether to fail when errors are encountered.
public void	setMode(String a `String` value octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion;
public void	setNonPosixMode(SetPermissions.NonPosixMode what to do if changing the permissions of a file is not possible m) Set what to do if changing the permissions of a file is not possible because the file-system doesn't support POSIX file permissions.
public void	setPermissions(String comma separated list of names of `PosixFilePermission`s. perms) Adds permissions as a comma separated list.
private void	tryDos(Path p, boolean failIfDosIsNotSupported)

Field Detail

failonerror	back to summary
private boolean failonerror

nonPosixMode	back to summary
private SetPermissions.NonPosixMode nonPosixMode

permissions	back to summary
private final Set<PosixFilePermission> permissions

resources	back to summary
private Resources resources

Constructor Detail

SetPermissions	back to summary
public SetPermissions()

Method Detail

add	back to summary
public void add(ResourceCollection rc) Adds a collection of resources to set permissions on. Parameters rc:ResourceCollection a resource collection

add

back to summary

public void add(ResourceCollection rc)

Adds a collection of resources to set permissions on.

Parameters

rc:ResourceCollection: a resource collection

execute	back to summary
public void execute() Overrides org.apache.tools.ant.Task.execute. Doc from org.apache.tools.ant.Task.execute. Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice. Annotations @Override

execute

back to summary

public void execute()

Overrides org.apache.tools.ant.Task.execute.

Doc from org.apache.tools.ant.Task.execute.

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Annotations

@Override

isWritable	back to summary
private boolean isWritable()

maybeThrowException	back to summary
private void maybeThrowException(Exception exc, String msgFormat, Object... msgArgs)

posixPermissionsNotSupported	back to summary
private void posixPermissionsNotSupported(Path p)

setFailOnError back to summary

setFailOnError	back to summary
public void setFailOnError(final boolean failonerror) Set whether to fail when errors are encountered. If false, note errors to the output but keep going. Default is true. Only applies to IO and SecurityExceptions, see `setNonPosixMode` for ways to deal with file-systems that don't support PosixPermissions. Parameters failonerror:boolean true or false.

public void setFailOnError(final boolean failonerror)

Set whether to fail when errors are encountered. If false, note errors to the output but keep going. Default is true.

Only applies to IO and SecurityExceptions, see setNonPosixMode for ways to deal with file-systems that don't support PosixPermissions.

Parameters

failonerror:boolean: true or false.

setMode back to summary

setMode	back to summary
public void setMode(String octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; Parameters octalString:String a `String` value

public void setMode(String octalString)

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion;

Parameters

octalString:String: a String value

setNonPosixMode back to summary

setNonPosixMode	back to summary
public void setNonPosixMode(SetPermissions.NonPosixMode m) Set what to do if changing the permissions of a file is not possible because the file-system doesn't support POSIX file permissions. The default is `NonPosixMode#fail`. Parameters m:SetPermissions.NonPosixMode what to do if changing the permissions of a file is not possible

public void setNonPosixMode(SetPermissions.NonPosixMode m)

Set what to do if changing the permissions of a file is not possible because the file-system doesn't support POSIX file permissions.

The default is NonPosixMode#fail.

Parameters

m:SetPermissions.NonPosixMode: what to do if changing the permissions of a file is not possible

setPermissions back to summary

setPermissions	back to summary
public void setPermissions(String perms) Adds permissions as a comma separated list. Parameters perms:String comma separated list of names of `PosixFilePermission`s.

public void setPermissions(String perms)

Adds permissions as a comma separated list.

Parameters

perms:String: comma separated list of names of PosixFilePermissions.

tryDos	back to summary
private void tryDos(Path p, boolean failIfDosIsNotSupported)

org.apache.tools.ant.taskdefs back to summary

public final Enum SetPermissions.NonPosixMode

Class Inheritance

extends Enum<SetPermissions.NonPosixMode>

java.lang.Object
java.lang.Enum
org.apache.tools.ant.taskdefs.SetPermissions.NonPosixMode

Options for dealing with file systems that don't support POSIX permissions.

Field Summary

Modifier and Type	Field and Description
public static final SetPermissions.NonPosixMode	fail Fail the build.
public static final SetPermissions.NonPosixMode	pass Log an error and go on.
public static final SetPermissions.NonPosixMode	tryDosOrFail Try DosFilePermissions - setting the read-only flag - and fail the build if that fails as well.
public static final SetPermissions.NonPosixMode	tryDosOrPass Try DosFilePermissions - setting the read-only flag - and log an error and go on if that fails as well.

Constructor Summary

Access	Constructor and Description
private	NonPosixMode()

Method Summary

Modifier and Type	Method and Description
public static SetPermissions.NonPosixMode	valueOf(String name)
public static SetPermissions.NonPosixMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

fail	back to summary
public static final SetPermissions.NonPosixMode fail Fail the build.

pass	back to summary
public static final SetPermissions.NonPosixMode pass Log an error and go on.

tryDosOrFail	back to summary
public static final SetPermissions.NonPosixMode tryDosOrFail Try DosFilePermissions - setting the read-only flag - and fail the build if that fails as well.

tryDosOrPass	back to summary
public static final SetPermissions.NonPosixMode tryDosOrPass Try DosFilePermissions - setting the read-only flag - and log an error and go on if that fails as well.

Constructor Detail

NonPosixMode	back to summary
private NonPosixMode()

Method Detail

valueOf	back to summary
public static SetPermissions.NonPosixMode valueOf(String name)

values	back to summary
public static SetPermissions.NonPosixMode[] values()

public Class SetPermissions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SetPermissions.NonPosixMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail