View Javadoc
1   /*
2    * This file is part of Waarp Project (named also Waarp or GG).
3    *
4    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
5    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
6    * individual contributors.
7    *
8    *  All Waarp Project is free software: you can redistribute it and/or
9    * modify it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation, either version 3 of the License, or (at your
11   * option) any later version.
12   *
13   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
14   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15   * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16   *
17   *  You should have received a copy of the GNU General Public License along with
18   * Waarp . If not, see <http://www.gnu.org/licenses/>.
19   */
20  package org.waarp.gateway.ftp.exec;
21  
22  /**
23   * Runnable interface for tasks
24   */
25  public interface GatewayRunnable extends Runnable {
26  
27    /**
28     * The way the parameter will be set
29     *
30     * @param waitForValidation True if the caller will wait up to delay
31     *     time
32     *     in ms
33     * @param useLocalExec True if currently is configured to use
34     *     LocalExec
35     *     (may be ignored)
36     * @param delay Delay in ms used only if waitForValidation is True
37     * @param args First arg is the Class name used
38     */
39    void setArgs(boolean waitForValidation, boolean useLocalExec, int delay,
40                 String[] args);
41  
42    /**
43     * @return the final status where 0 is OK, 1 is Warning, 2 is Error
44     */
45    int getFinalStatus();
46  
47    /**
48     * @return Information on task
49     */
50    @Override
51    String toString();
52  }