org.oddjob.net.ftp

Class FTPClientJob

java.lang.Object

org.oddjob.net.ftp.FTPClientJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Stoppable

public class FTPClientJob
extends java.lang.Object
implements java.lang.Runnable, Stoppable, java.io.Serializable

Description

Connect to an FTP server and run a set of FTP commands.

Example

Doing lots of FTP things.

<oddjob id="this" xmlns:net="http://rgordon.co.uk/oddjob/net">
    <job>
        <net:ftp host="localhost" port="${ftp.port}" username="admin" password="admin">
            <commands>
                <list>
                    <values>
                        <identify id="pwd">
                            <value>
                                <net:ftp-pwd/>
                            </value>
                        </identify>
                        <net:ftp-mk-dir path="stuff"/>
                        <net:ftp-cd path="stuff"/>
                        <identify id="list1">
                            <value>
                                <net:ftp-list/>
                            </value>
                        </identify>
                        <net:ftp-ascii/>
                        <net:ftp-put remote="stuff.txt">
                            <file>
                                <file file="${this.args[0]}"/>
                            </file>
                        </net:ftp-put>
                        <identify id="list2">
                            <value>
                                <net:ftp-list/>
                            </value>
                        </identify>
                        <net:ftp-rename from="stuff.txt" to="things.txt"/>
                        <net:ftp-get remote="things.txt">
                            <file>
                                <file file="${this.args[1]}"/>
                            </file>
                        </net:ftp-get>
                        <net:ftp-delete path="things.txt"/>
                        <net:ftp-bin/>
                        <net:ftp-cd/>
                        <net:ftp-rm-dir path="stuff"/>
                    </values>
                </list>
            </commands>
        </net:ftp>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

rob

Constructor Summary

Constructors

Constructor and Description
FTPClientJob()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHost()
java.lang.String	getName()
java.lang.String	getPassword()
int	getPort()
int	getResult()
java.lang.String	getUsername()
boolean	isPassive()
void	run()
void	setCommands(FTPCommand[] commands)
void	setHost(java.lang.String host)
void	setName(java.lang.String name)
void	setPassive(boolean passive)
void	setPassword(java.lang.String password)
void	setPort(int port)
void	setUsername(java.lang.String username)
void	stop() Stop executing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPClientJob

public FTPClientJob()

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

stop

public void stop()
          throws FailedToStopException

Description copied from interface: Stoppable

Stop executing. This method should not return until the Stoppable has actually stopped.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

setCommands

public void setCommands(FTPCommand[] commands)

getResult

public int getResult()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isPassive

public boolean isPassive()

setPassive

public void setPassive(boolean passive)