Class SetPermissions

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.SetPermissions

All Implemented Interfaces:

Cloneable

public class SetPermissions
extends Task

Sets PosixFilePermissions for resources.

This task provides a subset of Chmod's and 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

Since:

Ant 1.10.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
SetPermissions()

Method Summary

Modifier and Type	Method	Description
void	add(ResourceCollection rc)	Adds a collection of resources to set permissions on.
void	execute()	Called by the project to let the task do its work.
void	setActOnLinkTargets(boolean actOnLinkTargets)	Sets whether permissions should be applied to symbolic links or Windows junctions themselves or the link's targets.
void	setFailOnError(boolean failonerror)	Set whether to fail when errors are encountered.
void	setMode(String octalString)	A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion;
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.
void	setPermissions(String perms)	Adds permissions as a comma separated list.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Constructor Details

SetPermissions

public SetPermissions()

Method Details

setPermissions

public void setPermissions(String perms)

Adds permissions as a comma separated list.

Parameters:

perms - comma separated list of names of PosixFilePermissions.

setMode

public void setMode(String octalString)

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

Parameters:

octalString - a String value

setFailOnError

public void setFailOnError(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(SetPermissions.NonPosixMode) for ways to deal with file-systems that don't support PosixPermissions.

Parameters:

failonerror - true or false.

setNonPosixMode

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 SetPermissions.NonPosixMode.fail.

Parameters:

m - what to do if changing the permissions of a file is not possible

setActOnLinkTargets

public void setActOnLinkTargets(boolean actOnLinkTargets)

Sets whether permissions should be applied to symbolic links or Windows junctions themselves or the link's targets.

The default value is true.

Parameters:

actOnLinkTargets - true if permissions of link targets should be set.

Since:

Ant 1.10.16

add

public void add(ResourceCollection rc)

Adds a collection of resources to set permissions on.

Parameters:

rc - a resource collection

execute

public void execute()

Description copied from class: Task

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.

Overrides:

execute in class Task