2018-12-21 11:20:43 +01:00
|
|
|
<!DOCTYPE html>
|
2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
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
|
|
|
|
|
|
2019-05-25 13:41:47 +02:00
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
2006-09-11 04:19:00 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
-->
|
2018-12-21 11:20:43 +01:00
|
|
|
<html lang="en">
|
2001-11-30 12:24:17 +00:00
|
|
|
|
|
|
|
|
<head>
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Input Task</title>
|
2001-11-30 12:24:17 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="input">Input</h2>
|
2001-11-30 12:24:17 +00:00
|
|
|
<h3>Description</h3>
|
2002-04-22 13:22:57 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Allows user interaction during the build process by prompting for input. To do so, it uses the
|
|
|
|
|
configured <a href="../inputhandler.html">InputHandler</a>.</p>
|
|
|
|
|
|
|
|
|
|
<p>The prompt can be set via the <var>message</var> attribute or as character data nested into the
|
|
|
|
|
element.</p>
|
|
|
|
|
|
|
|
|
|
<p>Optionally a set of valid input arguments can be defined via the <var>validargs</var>
|
|
|
|
|
attribute. <code>Input</code> task will not accept a value that doesn't match one of the
|
|
|
|
|
predefined.</p>
|
|
|
|
|
|
|
|
|
|
<p>Optionally a property can be created from the value entered by the user. This property can then
|
|
|
|
|
be used during the following build run. <code>Input</code> then behaves
|
|
|
|
|
as <a href="property.html">property task</a> which means that existing properties cannot be
|
|
|
|
|
overridden. <em>Since Apache Ant 1.6</em>, <code><input></code> will not prompt for input if
|
|
|
|
|
a property should be set by the task that has already been set in the project (and the task wouldn't
|
|
|
|
|
have any effect).</p>
|
|
|
|
|
|
|
|
|
|
<p>Historically, a regular complaint about this task has been that it echoes characters to the
|
|
|
|
|
console, this is a critical security defect, we must fix it immediately, etc, etc. This problem was
|
|
|
|
|
due to the lack in early versions of Java of a (fully functional) facility for handling secure
|
|
|
|
|
console input. In Java 6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 and
|
|
|
|
|
1.8 have added support for Java 6 secure console input feature (see <a href="#handler.type">handler
|
|
|
|
|
type</a>).</p>
|
|
|
|
|
|
|
|
|
|
<p>IDE behaviour depends upon the IDE: some hang waiting for input, some let you type it in. For
|
|
|
|
|
this situation, place the password in a (secured) property file and load in before
|
|
|
|
|
the <code>input</code> task.</p>
|
2005-03-02 21:45:10 +00:00
|
|
|
|
2001-11-30 12:24:17 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-11-30 12:24:17 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2001-11-30 12:24:17 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>message</td>
|
|
|
|
|
<td>the Message which gets displayed to the user during the build run.</td>
|
|
|
|
|
<td>No</td>
|
2001-11-30 12:24:17 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>validargs</td>
|
|
|
|
|
<td>comma separated String containing valid input arguments. If set, <code>input</code> task
|
|
|
|
|
will reject any input not defined here. Comparison of input to <var>validargs</var> is case
|
|
|
|
|
sensitive. If you want <q>a</q> and
|
|
|
|
|
<q>A</q> to be accepted you will need to define both arguments within <var>validargs</var>.</td>
|
|
|
|
|
<td>No</td>
|
2001-11-30 12:24:17 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>addproperty</td>
|
|
|
|
|
<td>the name of a property to be created from input. Behaviour is equal
|
|
|
|
|
to <a href="property.html">property task</a> which means that existing properties cannot be
|
|
|
|
|
overridden.</td>
|
|
|
|
|
<td>No</td>
|
2001-11-30 12:24:17 +00:00
|
|
|
</tr>
|
2003-04-07 16:05:57 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>defaultvalue</td>
|
|
|
|
|
<td>Defines the default value of the property to be created from input. Property value will be
|
|
|
|
|
set to default if no input is received.</td>
|
|
|
|
|
<td>No</td>
|
2003-04-07 16:05:57 +00:00
|
|
|
</tr>
|
2001-11-30 12:24:17 +00:00
|
|
|
</table>
|
2018-03-05 17:35:30 +01:00
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2005-12-27 23:00:45 +00:00
|
|
|
<h4>Handler</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p><em>Since Ant 1.7</em>, a nested <code><handler></code> element can be used to specify
|
|
|
|
|
an <code>InputHandler</code>, so that different <code>InputHandler</code>s may be used among
|
|
|
|
|
different <code>Input</code> tasks.</p>
|
2005-12-27 23:00:45 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2005-12-27 23:00:45 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
2018-01-22 23:52:21 +01:00
|
|
|
<tr id="handler.type">
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>type</td>
|
|
|
|
|
<td>one of <q>default</q>, <q>propertyfile</q>, <q>greedy</q>, or <q>secure</q> (<em>since Ant
|
2018-03-01 06:44:53 +01:00
|
|
|
1.8</em>).</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td rowspan="3">One of these</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>refid</td>
|
|
|
|
|
<td class="left">Reference to an <code>InputHandler</code> defined elsewhere in the
|
|
|
|
|
project.</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>classname</td>
|
|
|
|
|
<td class="left">The name of an <code>InputHandler</code> subclass.</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>classpath</td>
|
|
|
|
|
<td>The classpath to use with <var>classname</var>.</td>
|
|
|
|
|
<td>No</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>classpathref</td>
|
|
|
|
|
<td>The refid of a classpath to use with <var>classname</var>.</td>
|
|
|
|
|
<td>No</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>loaderref</td>
|
|
|
|
|
<td>The refid of a classloader to use with <var>classname</var>.
|
2005-12-27 23:00:45 +00:00
|
|
|
</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No</td>
|
2005-12-27 23:00:45 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The classpath can also be specified by means of one or more nested <code><classpath></code>
|
|
|
|
|
elements.</p>
|
2005-12-27 23:00:45 +00:00
|
|
|
|
2001-11-30 12:24:17 +00:00
|
|
|
<h3>Examples</h3>
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Pause the build run until return key is pressed when using
|
2018-02-28 07:58:59 +01:00
|
|
|
the <a href="../inputhandler.html#defaulthandler">default InputHandler</a>, the concrete behavior is
|
|
|
|
|
defined by the <code>InputHandler</code> implementation you use.</p>
|
2018-05-15 09:51:58 +02:00
|
|
|
<pre><input/></pre>
|
|
|
|
|
|
|
|
|
|
<p>Display the message <q>Press Return key to continue...</q> and pause the build run until return
|
|
|
|
|
key is pressed (again, the concrete behavior is implementation dependent).</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre><input>Press Return key to continue...</input></pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Display the message <q>Press Return key to continue...</q> and pause the build run until return
|
|
|
|
|
key is pressed (see above).</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre><input message="Press Return key to continue..."/></pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Display the message <q>All data is going to be deleted from DB continue (y/n)?</q> and
|
|
|
|
|
require <q>y</q> to continue build or <q>n</q> to exit build with following message <q>Build aborted
|
|
|
|
|
by user.</q>.</p>
|
2001-12-12 09:31:51 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<input message="All data is going to be deleted from DB continue (y/n)?"
|
|
|
|
|
validargs="y,n"
|
|
|
|
|
addproperty="do.delete"/>
|
|
|
|
|
<condition property="do.abort">
|
|
|
|
|
<equals arg1="n" arg2="${do.delete}"/>
|
|
|
|
|
</condition>
|
|
|
|
|
<fail if="do.abort">Build aborted by user.</fail>
|
2001-12-12 09:31:51 +00:00
|
|
|
</pre>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
|
<p>Display the message <q>Please enter db-username:</q> and set the property <code>db.user</code> to
|
|
|
|
|
the value entered by the user.</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre>
|
|
|
|
|
<input message="Please enter db-username:"
|
|
|
|
|
addproperty="db.user"/></pre>
|
2001-11-30 12:24:17 +00:00
|
|
|
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>Same as above, but set <code>db.user</code> to the value <q>Scott-Tiger</q> if the user enters no
|
|
|
|
|
value (simply presses <q>return</q>).</p>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre>
|
|
|
|
|
<input message="Please enter db-username:"
|
|
|
|
|
addproperty="db.user"
|
|
|
|
|
defaultvalue="Scott-Tiger"/></pre>
|
2003-04-07 16:05:57 +00:00
|
|
|
|
2001-11-30 12:24:17 +00:00
|
|
|
</body>
|
2005-04-29 18:58:16 +00:00
|
|
|
</html>
|
