com.crystaldecisions.sdk.plugin.destination.sftp
Interface ISFTPOptions

All Superinterfaces:

IDestinationScheduleOptions

public interface ISFTPOptions
extends IDestinationScheduleOptions

This interface allows you to set the global or schedule options to an SFTP location.

Method Summary

void	clearServerInfo() Clears the following settings related to the SFTP server connection and authentication: Server Name Port User Name Password FingerPrint If the above fields are cleared, InfoObject uses the default settings specified on the Job Server to connect and also authenticate the SFTP server.
java.lang.String	getAccount() Gets the SFTP account.
java.util.List	getDestinationFiles() Gets the file list that can be sent as destination files to the SFTP server.
IDestinationOutputByDocs	getDestinationFilesByDocs() Gets the destination output files that can be customized by the user for individual source documents.
java.lang.String	getFingerPrint() Gets the SFTP server's FingerPrint.
int	getPort() Gets SFTP server listening port.
java.lang.String	getServerName() Gets SFTP server name.
java.lang.String	getUserName() Gets SFTP user logon name.
boolean	isPasswordNotEmpty() Checks if the password is not empty.
boolean	isPasswordSet() Checks if the password is set or not.
void	setAccount(java.lang.String sVal) Sets the SFTP account.
void	setFingerPrint(java.lang.String sVal) Sets the SFTP server's FingerPrint.
void	setPassword(java.lang.String sVal) Sets the password to login to the SFTP server.
void	setPort(int lVal) Sets the SFTP server listening port.
void	setServerName(java.lang.String sVal) Sets SFTP server name.
void	setUserName(java.lang.String sVal) Sets SFTP user logon name.

Methods inherited from interface com.crystaldecisions.sdk.plugin.destination.common.IDestinationScheduleOptions

getInputFiles

Method Detail

getServerName

java.lang.String getServerName()

Gets SFTP server name.

Returns:

Returns String containing SFTP server name.

setServerName

void setServerName(java.lang.String sVal)

Sets SFTP server name.

Parameters:

sVal - A String containing SFTP server name.

getPort

int getPort()

Gets SFTP server listening port.

Returns:

Returns int, which specifies the SFTP server listening port.

setPort

void setPort(int lVal)

Sets the SFTP server listening port.

Parameters:

lVal - An int, which specifies the SFTP server listening port.

getUserName

java.lang.String getUserName()

Gets SFTP user logon name.

Returns:

Returns String containing the SFTP user logon name.

setUserName

void setUserName(java.lang.String sVal)

Sets SFTP user logon name.

Parameters:

sVal - A String containing the SFTP user logon name.

setPassword

void setPassword(java.lang.String sVal)

Sets the password to login to the SFTP server.

Parameters:

sVal - A String containing the password to login to the SFTP server.

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Checks if the password is set or not.

Returns:

Returns true, if the password is set, and false otherwise.

Throws:

SDKException - Thrown if the process is unsuccessful.

isPasswordNotEmpty

boolean isPasswordNotEmpty()
                           throws SDKException

Checks if the password is not empty.

Returns:

Returns true, if the password is set, and false otherwise.

Throws:

SDKException - Thrown if the process is unsuccessful.

clearServerInfo

void clearServerInfo()

Clears the following settings related to the SFTP server connection and authentication:
Server Name
Port
User Name
Password
FingerPrint
If the above fields are cleared, InfoObject uses the default settings specified on the Job Server to connect and also authenticate the SFTP server.

getAccount

java.lang.String getAccount()

Gets the SFTP account.

Returns:

Returns String, which contains the SFTP account.

setAccount

void setAccount(java.lang.String sVal)

Sets the SFTP account. This field can be left empty(optional field).

Parameters:

sVal - A String containing the SFTP account.

setFingerPrint

void setFingerPrint(java.lang.String sVal)

Sets the SFTP server's FingerPrint.

Parameters:

sVal - A String, which contains the SFTP server's FingerPrint.

getFingerPrint

java.lang.String getFingerPrint()

Gets the SFTP server's FingerPrint.

Returns:

Returns String, which contains the SFTP server's FingerPrint.

getDestinationFiles

java.util.List getDestinationFiles()

Gets the file list that can be sent as destination files to the SFTP server.

Returns:

Returns List, which contains SFTP destination files.

getDestinationFilesByDocs

IDestinationOutputByDocs getDestinationFilesByDocs()

Gets the destination output files that can be customized by the user for individual source documents.

Returns:

Returns IDestinationFilesByDocs, which is a collection of files associated with each source document.