| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> |
| <title>SetPermissions Task</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="setpermissions">SetPermissions</a></h2> |
| <p><em>Since Ant 1.10.0.</em></p> |
| <h3>Description</h3> |
| <p>Changes the file permissions using Java's NIO support for |
| permissions.</p> |
| <p>This task provides a subset of the platform specific abilities of |
| <a href="chmod.html">chmod</a> and <a href="attrib.html">attrib</a> |
| in a platform independent way.</p> |
| <p>If no permissions are specified either via the mode or the |
| permissions attribute, then all permissions will be removed from the |
| nested resources.</p> |
| <p>The task accepts aribitrary resources as part of the nested |
| resource collections, but not all resources support setting |
| permissions. This task won't do anything for resources that don't |
| support setting permissions - for example URLs.</p> |
| <p>The permissions are applied to all resources contained within the |
| nested resources collections. You may want to ensure the collection |
| only returns files or directories if you want different sets of |
| permissions to apply to either type of resource.</p> |
| |
| <h3>Parameters</h3> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td valign="top">permissions</td> |
| <td valign="top">The permissions to set as comma separated list of |
| names |
| of <a href="http://docs.oracle.com/javase/8/docs/api/java/nio/file/attribute/PosixFilePermission.html">PosixFilePermission</a> |
| values.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">mode</td> |
| <td valign="top">The permissions to set as tradional Unix |
| three-digit octal number.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">nonPosixMode</td> |
| <td valign="top">What to do if changing the permissions of a file |
| is not possible because the file-system doesn't support POSIX |
| file permissions. Possible options are <code>fail</code> (fail |
| the build), <code>pass</code> (just log an |
| error), <code>tryDosOrFail</code> (at least try to set the |
| read-only flag on DOS file systems, fail if that isn't possible |
| either) and <code>tryDosOrPass</code> (at least try to set the |
| read-only flag on DOS file systems, just log an error if that |
| isn't possible either).</td> |
| <td valign="top" align="center">No, defaults to <code>fail</code></td> |
| </tr> |
| <tr> |
| <td valign="top">failonerror</td> |
| <td valign="top">Whether to stop the build if setting permissions |
| fails.</td> |
| <td valign="top" align="center">No, defaults to true</td> |
| </tr> |
| </table> |
| <h3>Parameters specified as nested elements</h3> |
| |
| <h4>any resource collection</h4> |
| <p><a href="../Types/resources.html#collection">Resource |
| Collection</a>s are used to select groups of resources.</p> |
| <h3>Examples</h3> |
| <blockquote><pre> |
| <setpermissions mode="755"> |
| <file file="${dist}/start.sh"/> |
| </setpermissions> |
| </pre></blockquote> |
| <p>makes the "start.sh" file readable and executable for |
| anyone and in addition writable by the owner.</p> |
| <blockquote><pre> |
| <setpermissions permissions="OWNER_READ,OWNER_WRITE,OWNER_EXECUTE,OTHERS_READ,OTHERS_EXECUTE,GROUP_READ,GROUP_EXECUTE"> |
| <file file="${dist}/start.sh"/> |
| </setpermissions> |
| </pre></blockquote> |
| <p>makes the "start.sh" file readable and executable for |
| anyone and in addition writable by the owner.</p> |
| </body> |
| </html> |
