de.espirit.firstspirit.access.schedule

Interface FtpTarget

All Superinterfaces:

DeployTarget

public interface FtpTarget
extends DeployTarget

Deployment of contents using the file transfer protocol (FTP).

Since:

4.0.17

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FtpTarget.FtpProxyType Definition of several ftp proxy types.
static class	FtpTarget.FtpServerType Definition of several ftp server types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYST_MVS Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.MVS.getId()
static String	SYST_NT Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.WIN.getId()
static String	SYST_OS400 Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.OS400.getId()
static String	SYST_UNIX Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.UNIX.getId()
static String	SYST_VMS Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.VMS.getId()

Method Summary

Methods

Modifier and Type	Method and Description
long	getConnectionTimeout() Get ftp connection timeout parameter in seconds. -1 means no timeout.
long	getDataTimeout() Get ftp data transfer timeout parameter in seconds. -1 means no timeout.
String	getDefaultTimeFormat() The default time format used to parse the directory listings provided by the ftp server.
String	getFallbackTimeFormat() The fallback time format used to parse the directory listings provided by the ftp server, if this cannot be parsed with the default time format A null value means that a server type dependent default fallback will be used.
String	getFtpServerType() There are some predefined types which may be returned: SYST_UNIX SYST_NT SYST_OS400 SYST_MVS SYST_VMS A null value signals auto detection.
String	getHost() The host of the ftp server
boolean	getLocalActiveMode() The client to server communication may be performed in local active or passive mode.
String	getLogin() The login name, used to log on the ftp server
String	getPassword() The password, used for login
String	getProxyHost() The host for ftp proxy.
String	getProxyLogin() The login used for ftp proxy.
String	getProxyPassword() The password used for ftp proxy login.
int	getProxyPort() The port for ftp proxy.
FtpTarget.FtpProxyType	getProxyType() The protocol used for ftp proxy.
Locale	getServerLanguageLocale() If the ftp server uses alphabetic month names in it's timestamps the short month names of this locale is used for date parsing.
TimeZone	getServerTimeZone() This property is used to interpret file dates, for the format see TimeZone.
String	getSourceDirectory() The relative source directory, typically empty.
boolean	getUseAsciiMode() true if text files should be transfered in ASCII mode (default).
boolean	getUseProxy() true if ftp proxy should be used, false otherwise (default).
void	setConnectionTimeout(Long value) Set ftp connection timeout parameter in seconds. -1 means no timeout, null means "use default value".
void	setDataTimeout(Long value) Set ftp data transfer timeout parameter in seconds. -1 means no timeout, null means "use default value".
void	setDefaultTimeFormat(String value) Set the default time format used to parse the directory listings provided by the ftp server.
void	setFallbackTimeFormat(String value) Set the fallback time format used to parse the directory listings provided by the ftp server, if this cannot be parsed with the default time format.
void	setFtpServerType(String value) Provide the ftp server type.
void	setHost(String value) Provide the host of the ftp server
void	setLocalActiveMode(boolean value) The client to server communication may be performed in local active (default) or passive mode.
void	setLogin(String value) Set the login name which is used to log on the ftp server
void	setPassword(String value) Set the password which is used for login
void	setProxyHost(String value) Set the host for ftp proxy.
void	setProxyLogin(String value) Set the login used for ftp proxy.
void	setProxyPassword(String value) Set the password used for ftp proxy login.
void	setProxyPort(int value) Set the port for ftp proxy.
void	setProxyType(FtpTarget.FtpProxyType value) Set the protocol used for ftp proxy.
void	setServerLanguageLocale(Locale value) If the ftp server uses alphabetic month names in it's timestamps the short month names of this locale is used for date parsing.
void	setServerTimeZone(TimeZone value) This property is used to interpret file dates, for a list of valid id's see TimeZone.
void	setSourceDirectory(String value) Provide the source directory, relative to the schedule directory.
void	setUseAsciiMode(boolean value) Provide true if text files should be transfered in ASCII mode (default).
void	setUseBlockTransferMode(boolean value) Toggle between block transfer mode and stream mode (default).
void	setUseProxy(boolean value) Provide true if ftp proxy should be used, false otherwise (default).
boolean	useBlockTransferMode() Is block or stream mode (default) used?

Methods inherited from interface de.espirit.firstspirit.access.schedule.DeployTarget

checkParams, createWebServerConfiguration, getPath, getTargetType, getWebServerConfiguration, setPath

Field Detail

SYST_UNIX

@Deprecated
static final String SYST_UNIX

Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.UNIX.getId()

Since:

4.0.17

SYST_NT

@Deprecated
static final String SYST_NT

Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.WIN.getId()

Since:

4.0.17

SYST_OS400

@Deprecated
static final String SYST_OS400

Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.OS400.getId()

Since:

4.0.17

SYST_VMS

@Deprecated
static final String SYST_VMS

Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.VMS.getId()

Since:

4.0.17

SYST_MVS

@Deprecated
static final String SYST_MVS

Deprecated. since 4.2.34 - replaced by FtpTarget.FtpServerType.MVS.getId()

Since:

4.0.17

Method Detail

getHost

String getHost()

The host of the ftp server

Since:

4.0.17

setHost

void setHost(String value)

Provide the host of the ftp server

Parameters:

value - the host of the ftp server

Since:

4.0.17

getLogin

String getLogin()

The login name, used to log on the ftp server

Since:

4.0.17

setLogin

void setLogin(String value)

Set the login name which is used to log on the ftp server

Parameters:

value - the login name which is used to log on the ftp server

Since:

4.0.17

getPassword

String getPassword()

The password, used for login

Since:

4.0.17

setPassword

void setPassword(String value)

Set the password which is used for login

Parameters:

value - the password which is used for login

Since:

4.0.17

getFtpServerType

@Nullable
String getFtpServerType()

There are some predefined types which may be returned:

• SYST_UNIX
• SYST_NT
• SYST_OS400
• SYST_MVS
• SYST_VMS

A null value signals auto detection.
Every other value should be a fully qualified class name of a custom class implementing org.apache.commons.net.ftp.FTPFileEntryParser and org.apache.commons.net.ftp.Configurable

Returns:

null for auto detection of ftp server type, a predifined type constant (SYST_*) or a full qualified class name

Since:

4.0.17

See Also:

setFtpServerType(String)

setFtpServerType

void setFtpServerType(@Nullable
                    String value)

Provide the ftp server type.

Parameters:

value - null for auto detection of ftp server type or a FtpServerType using getId().

Since:

4.0.17

See Also:

FtpTarget.FtpServerType.getId(), getFtpServerType()

getLocalActiveMode

boolean getLocalActiveMode()

The client to server communication may be performed in local active or passive mode.

Returns:

true for local active mode (default), false for local passive mode

Since:

4.0.17

See Also:

setLocalActiveMode(boolean)

setLocalActiveMode

void setLocalActiveMode(boolean value)

The client to server communication may be performed in local active (default) or passive mode.

Parameters:

value - use true for local active mode, false for local passive mode

Since:

4.0.17

See Also:

getLocalActiveMode()

getSourceDirectory

String getSourceDirectory()

The relative source directory, typically empty. The path is relative to the schedule directory.

Since:

4.0.17

setSourceDirectory

void setSourceDirectory(String value)

Provide the source directory, relative to the schedule directory.

Parameters:

value - a directory relative to the schedule directory

Since:

4.0.17

getServerTimeZone

@Nullable
TimeZone getServerTimeZone()

This property is used to interpret file dates, for the format see TimeZone.
A null value means that the time zone of the FirstSpirit server is used.

Since:

4.0.17

See Also:

setServerTimeZone(java.util.TimeZone)

setServerTimeZone

void setServerTimeZone(TimeZone value)

This property is used to interpret file dates, for a list of valid id's see TimeZone.
A null value means that the time zone of the FirstSpirit server is used.

Since:

4.0.17

See Also:

getServerTimeZone()

getServerLanguageLocale

Locale getServerLanguageLocale()

If the ftp server uses alphabetic month names in it's timestamps the short month names of this locale is used for date parsing. By default the locale en_US is used.

Since:

4.0.17

See Also:

setServerLanguageLocale(java.util.Locale)

setServerLanguageLocale

void setServerLanguageLocale(Locale value)

If the ftp server uses alphabetic month names in it's timestamps the short month names of this locale is used for date parsing. By default the locale en_US is used.

Since:

4.0.17

See Also:

getServerLanguageLocale()

getDefaultTimeFormat

String getDefaultTimeFormat()

The default time format used to parse the directory listings provided by the ftp server.
A null value means that a default date format of the locale en_US is used.

Since:

4.0.17

See Also:

setDefaultTimeFormat(String)

setDefaultTimeFormat

void setDefaultTimeFormat(String value)

Set the default time format used to parse the directory listings provided by the ftp server.
A null value means that a default date format of the locale en_US is used.

Since:

4.0.17

See Also:

getDefaultTimeFormat()

getFallbackTimeFormat

String getFallbackTimeFormat()

The fallback time format used to parse the directory listings provided by the ftp server, if this cannot be parsed with the default time format A null value means that a server type dependent default fallback will be used.

Since:

4.0.17

See Also:

setFallbackTimeFormat(String)

setFallbackTimeFormat

void setFallbackTimeFormat(String value)

Set the fallback time format used to parse the directory listings provided by the ftp server, if this cannot be parsed with the default time format. This is usally the case for 'recent dates', which omit the year, e.g. "Mar 1 12:04".
Somtimes the month abbreviations used by the ftp server are not iso-conform. You may specify these abbreviations here as a suffix, delimited by pipe (|) characters: "MMM d hh24:mm|Jan|Feb|Mär|Apr|Mai|Jun|Jul|Aug|Sep|Okt|Nov|Dez"
A null value means that no fallback will be used

Since:

4.0.17

See Also:

getFallbackTimeFormat()

getUseAsciiMode

boolean getUseAsciiMode()

true if text files should be transfered in ASCII mode (default).
Transferring files in text mode may convert line breaks from \r\n to \n (for Windows to Unix transfer) or vice versa (for Unix to Windows transfer). In non ASCII mode files are transferred in BIN mode and no convertion will take place.

Since:

4.0.17

See Also:

setUseAsciiMode(boolean)

setUseAsciiMode

void setUseAsciiMode(boolean value)

Provide true if text files should be transfered in ASCII mode (default).

Parameters:

value - true if text files should be transfered in ASCII mode (default)

Since:

4.0.17

See Also:

getUseAsciiMode()

getUseProxy

boolean getUseProxy()

true if ftp proxy should be used, false otherwise (default).

Since:

4.0.17

setUseProxy

void setUseProxy(boolean value)

Provide true if ftp proxy should be used, false otherwise (default).

Parameters:

value - true if ftp proxy should be used, false otherwise (default)

Since:

4.0.17

getProxyHost

String getProxyHost()

The host for ftp proxy.

Since:

4.0.17

setProxyHost

void setProxyHost(String value)

Set the host for ftp proxy.

Parameters:

value - the host for ftp proxy

Since:

4.0.17

getProxyPort

int getProxyPort()

The port for ftp proxy.

Since:

4.0.17

setProxyPort

void setProxyPort(int value)

Set the port for ftp proxy.

Parameters:

value - the port for ftp proxy

Since:

4.0.17

getProxyType

FtpTarget.FtpProxyType getProxyType()

The protocol used for ftp proxy.

Since:

4.0.17

setProxyType

void setProxyType(FtpTarget.FtpProxyType value)

Set the protocol used for ftp proxy.

Parameters:

value - the protocol used for ftp proxy

Since:

4.0.17

getProxyLogin

String getProxyLogin()

The login used for ftp proxy.

Since:

4.0.17

setProxyLogin

void setProxyLogin(String value)

Set the login used for ftp proxy.

Parameters:

value - the login used for ftp proxy

Since:

4.0.17

getProxyPassword

String getProxyPassword()

The password used for ftp proxy login.

Since:

4.0.17

setProxyPassword

void setProxyPassword(String value)

Set the password used for ftp proxy login.

Parameters:

value - the password used for ftp proxy login

Since:

4.0.17

setConnectionTimeout

void setConnectionTimeout(@Nullable
                        Long value)

Set ftp connection timeout parameter in seconds. -1 means no timeout, null means "use default value". Default value is set via fs-server.conf entry FTP_CONNECT_TIMEOUT.

Since:

4.2.16

See Also:

getConnectionTimeout()

getConnectionTimeout

long getConnectionTimeout()

Get ftp connection timeout parameter in seconds. -1 means no timeout. Default value is set via fs-server.conf entry FTP_CONNECT_TIMEOUT.

Since:

4.2.16

See Also:

setConnectionTimeout(Long)

setDataTimeout

void setDataTimeout(@Nullable
                  Long value)

Set ftp data transfer timeout parameter in seconds. -1 means no timeout, null means "use default value". Default value is set via fs-server.conf entry FTP_DATA_TIMEOUT.

Since:

4.2.16

See Also:

getDataTimeout()

getDataTimeout

long getDataTimeout()

Get ftp data transfer timeout parameter in seconds. -1 means no timeout. Default value is set via fs-server.conf entry FTP_DATA_TIMEOUT

Since:

4.2.16

See Also:

setDataTimeout(Long)

useBlockTransferMode

boolean useBlockTransferMode()

Is block or stream mode (default) used?

Returns:

true for block transfer mode, false for stream mode (default).

Since:

4.2.472

See Also:

setUseBlockTransferMode(boolean)

setUseBlockTransferMode

void setUseBlockTransferMode(boolean value)

Toggle between block transfer mode and stream mode (default).

Parameters:

value - true to switch to block transfer mode, false for stream mode (default).

Since:

4.2.472

See Also:

useBlockTransferMode()