org.apache.camel.component.file.remote
Class RemoteFileConfiguration

java.lang.Object
  org.apache.camel.component.file.GenericFileConfiguration
      org.apache.camel.component.file.remote.RemoteFileConfiguration

Direct Known Subclasses:

FtpConfiguration, SftpConfiguration

public abstract class RemoteFileConfiguration
extends GenericFileConfiguration

Configuration of the FTP server

Field Summary

Fields inherited from class org.apache.camel.component.file.GenericFileConfiguration

directory

Constructor Summary

RemoteFileConfiguration()

RemoteFileConfiguration(URI uri)

Method Summary

void	configure(URI uri)
int	getConnectTimeout()
String	getHost()
String	getPassword()
int	getPort()
String	getProtocol()
String	getSiteCommand()
int	getSoTimeout()
int	getTimeout()
String	getUsername()
boolean	isBinary()
boolean	isPassiveMode()
boolean	isThrowExceptionOnConnectFailed()
boolean	needToNormalize()
String	remoteServerInformation() Returns human readable server information for logging purpose
void	setBinary(boolean binary)
void	setConnectTimeout(int connectTimeout) Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH
protected abstract void	setDefaultPort()
void	setHost(String host)
void	setPassiveMode(boolean passiveMode) Sets passive mode connections.
void	setPassword(String password)
void	setPort(int port)
void	setProtocol(String protocol)
void	setSiteCommand(String siteCommand) Sets optional site command(s) to be executed after successful login.
void	setSoTimeout(int soTimeout) Sets the so timeout Used only by FTPClient
void	setThrowExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed) Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged.
void	setTimeout(int timeout) Sets the data timeout for waiting for reply Used only by FTPClient
void	setUsername(String username)

Methods inherited from class org.apache.camel.component.file.GenericFileConfiguration

getDirectory, setDirectory, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFileConfiguration

public RemoteFileConfiguration()

RemoteFileConfiguration

public RemoteFileConfiguration(URI uri)

Method Detail

needToNormalize

public boolean needToNormalize()

Overrides:

needToNormalize in class GenericFileConfiguration

configure

public void configure(URI uri)

Overrides:

configure in class GenericFileConfiguration

remoteServerInformation

public String remoteServerInformation()

Returns human readable server information for logging purpose

setDefaultPort

protected abstract void setDefaultPort()

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

setPort

public void setPort(int port)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

isBinary

public boolean isBinary()

setBinary

public void setBinary(boolean binary)

isPassiveMode

public boolean isPassiveMode()

setPassiveMode

public void setPassiveMode(boolean passiveMode)

Sets passive mode connections.
Default is active mode connections.

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Sets the connect timeout for waiting for a connection to be established

Used by both FTPClient and JSCH

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

Sets the data timeout for waiting for reply

Used only by FTPClient

getSoTimeout

public int getSoTimeout()

setSoTimeout

public void setSoTimeout(int soTimeout)

Sets the so timeout

Used only by FTPClient

isThrowExceptionOnConnectFailed

public boolean isThrowExceptionOnConnectFailed()

setThrowExceptionOnConnectFailed

public void setThrowExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)

Should an exception be thrown if connection failed (exhausted)

By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the PollingConsumerPollStrategy rollback method.

getSiteCommand

public String getSiteCommand()

setSiteCommand

public void setSiteCommand(String siteCommand)

Sets optional site command(s) to be executed after successful login.

Multiple site commands can be separated using a new line character (\n).

Parameters:

siteCommand - the site command(s).