A B C D E F G H I L M N O P R S T U W

## A

ACTIVE_MODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  FTP active mode to be set so that FTP client can listen on a port and send the ip and port information through the use of PORT FTP command
aeTrace(String, String, String, String) - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Send information to the BusinessConnect log.
aeTrace(String, String, String, String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
aeTrace(String, String, String, String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Send information to the BusinessConnect log.
ALL_FILE_LIST - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Optional, it can be used by business protocols during post processing messages.
ALL_FILE_LIST - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Optional, it can be used by business protocols during post processing messages.

## B

BAD_COMMAND_SEQUENCE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Bad sequence of commands.

## C

CAN_T_OPEN_DATA_CONNECTION_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Can't open data connection.
com.tibco.ax.fw.runtime.inbound.impl - package com.tibco.ax.fw.runtime.inbound.impl
com.tibco.ax.fw.runtime.outbound.impl - package com.tibco.ax.fw.runtime.outbound.impl
com.tibco.ax.fw.runtime.transport - package com.tibco.ax.fw.runtime.transport
com.tibco.ax.fw.runtime.transport.file - package com.tibco.ax.fw.runtime.transport.file
com.tibco.ax.fw.runtime.transport.ftp - package com.tibco.ax.fw.runtime.transport.ftp
com.tibco.ax.fw.runtime.transport.sshftp - package com.tibco.ax.fw.runtime.transport.sshftp
com.tibco.ax.fw.runtime.util - package com.tibco.ax.fw.runtime.util
COMMAND_NOT_IMPLEMENTED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Command not implemented.
COMMAND_NOT_IMPLEMENTED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  Command not implemented.
COMMAND_NOT_IMPLEMENTED_FOR_THAT_PARAMETER_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Command not implemented for that parameter.
COMMON_ALL_FILE_LIST - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Optional, it can be used by business protocols during post processing messages.
COMMON_ALL_FILE_LIST - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Optional, it can be used by business protocols during post processing messages.
COMPLETED - Static variable in interface com.tibco.ax.fw.runtime.util.UserLogAccess
  COMPLETED status to be specified for the log entry.
connect() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Connects to the FTP server using the user, password, and port specified in the configuration for non-proxy connections.
CONTROL_CONNECTION_CLOSED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Service closing control connection.
CONTROL_CONNECTION_OPENED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Service ready for new user.

## D

DATA_CONNECTION_ABORTED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Connection closed; transfer aborted.
DATA_CONNECTION_ABOUT_TO_BE_OPENED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  File status okay; about to open data connection.
DATA_CONNECTION_ALREADY_OPENED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Data Connection already open; transfer starting.
DATA_CONNECTION_CLOSED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Closing data connection.
DATA_CONNECTION_OPENED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Data connection open; no transfer in progress.
DATA_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  If the payload exists in memory and therefore it is not referenced by a filename, this slot holds the object, which can be retrieved through the method get("dataObj").
DATA_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  If the payload exists in memory and therefore it is not referenced by a filename, this slot holds the object, which can be retrieved through the method get("dataObj").
DEFAULT_FTP_PORT - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
DEFAULT_SSHFTP_PORT - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
DELETE_FILE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Currently not used.
DELETE_FILE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Currently not used.
DELETEREF - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The custom script can refrain from deleting the referenced source by setting this slot to the value 'false' (this is if the framework transport is not configured to remove the reference).
DIRECTORY_STATUS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Directory status
disconnect() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Disconnects from the FTP server by sending the QUIT command for non proxy connections.
DOCUMENT_ID - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The document ID of the message.
DOCUMENTID - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The document ID of the message.

## E

ENTERING_PASSIVE_MODE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Entering Passive Mode (h1,h2,h3,h4,p1,p2).
ERROR - Static variable in interface com.tibco.ax.fw.runtime.util.UserLogAccess
  ERROR status to be specified for the log entry.
EXCEEDED_STORAGE_ALLOCATION_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested file action aborted.
executeAppendCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends APPE command to the FTP server to store the contents of the file under the name `filename` on the FTP server.
executeAppendCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Append a file to the ssh server.
executeCdCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends CWD command to the FTP server and returns the reply.
executeDelCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends DELE command to the FTP server to delete the filename specified in `filename` parameter.
executeDelCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Delete a file from the ssh server.
executeDirCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends LIST command to the FTP server and receives the list of directory listing for that current pathname.
executeGetCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends RETR command to the FTP server and receive the response.
executeGetCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve the file specified.
executeListCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve a list of entries from a directory on the SSH server.
executeLsCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends NLST command to the FTP server and receive the list of files available for that current `pathname`
executeMdelCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends NLST command to retrieve the files that needs to be deleted based on the `pathname` specified.
executeMdelCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Delete one or more files from the ssh server.
executeMgetCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Retrieves the list of files that match the `filename` value.
executeMgetCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve file(s) specified by a pattern.
executeMkdirCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends MKD command to the FTP server to create a directory specified in `pathname` at the current working directory.
executeMkdirCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Create a directory on the ssh server.
executeMputCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Stores the list of files that match the `filename` value.
executeMputCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy one or more files to the ssh server.
executePutCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends STOR command to the FTP server to store the contents of the file under the name specified in `filename`.
executePutCmd(String, String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends STOR command to the FTP server to store the contents of the file under the name specified in `remotefilename`.
executePutCmd(Object, boolean, String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends STOR command to the FTP server to store the contents of the file under the name specified in `remotefilename`.
executePutCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server.
executePutCmd(String, boolean) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server and possibly append it to an existing file with the same name.
executePutCmd(String, String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server and create the file with the name 'remotefilename' on the ssh server.
executePutCmd(String, String, boolean) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server and create the file with the name 'remotefilename'.
executePutCmd(Object, boolean, String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server and create the file with the name 'remotefilename'.
executePutCmd(Object, boolean, String, boolean) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Copy a file to the ssh server and create the file with the name 'remotefilename'.
executePwdCmd() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends PWD command to the FTP server and Prints the Working Directory
executeQuoteCmd(String, String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends any `command` that is defined in the RFC 959 specification.
executeRenameCmd(String, String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends RNFR and RNTO to rename the `oldfilename to `newfilename`.`
executeRenameCmd(String, String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Rename a file on the ssh server.
executeRmdirCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends RMD command to the FTP server to remove the directory specified in `pathname`.
executeRmdirCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Delete a directory from the ssh server.
executeSiteCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends SITE command to the FTP server to retrieve services specific to his system that are essential to file transfer but not sufficiently universal to be included as a regular command.
executeStatusCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends STAT command to the FTP server to get the status response of the `pathname` specified as a parameter.
executeStouCmd() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends STOU command to the FTP server to store the contents of the file under the name that is generated by the FTP server.
executeTypeCmd(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sends TYPE command to the FTP server.

## F

FILE_NAME_NOT_ALLOWED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested action not taken.
FILE_NAME_NOT_ALLOWED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  The requested file cannot be accessed or returned.
FILE_STATUS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  File status.
FileAttr - Interface in com.tibco.ax.fw.runtime.transport.sshftp
  This object is returned when a directory list is requested.
FILEClient - Interface in com.tibco.ax.fw.runtime.transport.file
FTP_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The name of the slot, which returns the ftp client itself.
FTP_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The name of the slot, which returns the ftp client itself.
FTP_STATUS_ERROR - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Generic failure, possibly due to unknown reasons.
FTP_STATUS_ERROR - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Generic failure, possibly due to unknown reasons.
FTP_STATUS_OK - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Generic successful completion.
FTP_STATUS_OK - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Generic successful completion.
FTPClient - Interface in com.tibco.ax.fw.runtime.transport.ftp
  FTPClient interface models an FTP client that can connect to an FTP server.
FTPReply - Interface in com.tibco.ax.fw.runtime.transport.ftp
  This class contains constants and methods that simplify handling FTP server replies.

## G

get(String) - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
getClientObject() - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Retrieve a client object, which can provide more context specific information about the transaction.
getClientObject() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Retrieve a client object, which can provide more context specific information about the transaction.
getClientObject() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve a client object, which can provide more context specific information about the transaction.
getFileName() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Returns the fileName after executing FTPClient#executeGetCmd() or FTPClient#executeMgetCmd() etc.
getFTPMode() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Gets the FTP mode that is set.
getHost() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Gets the hostname of the FTP server.
getHost() - Method in interface com.tibco.ax.fw.runtime.transport.IClientObject
  Returns host name in context of protocol plugn specfic implementation
getHost() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Gets the hostname of the SSHFTP server.
getLastAccess() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Retrieve the time and date of the last access to this file.
getLastMod() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Retrieve the time and date of the last modification to this file.
getName() - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Retrieve the name of the file client instance.
getName() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
getName() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Obtain the name of the file.
getName() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve the name of the ssh client instance.
getOperationID() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Get the operation ID on this FTP or SSHFTP reply instance.
getPartner() - Method in interface com.tibco.ax.fw.runtime.transport.IClientObject
  Returns partner name in context of protocol plugin specfic implementation
getPassword() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Gets the password that is used to connect to the FTP server.
getPassword() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Gets the password that is used to connect to the SSHFTP server.
getPort() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Gets the port number that is used to connect to the FTP server.
getPort() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Gets the port number that is used to connect to the SSHFTP server.
getProtocol() - Method in interface com.tibco.ax.fw.runtime.transport.IClientObject
  Returns protocol name in context of protocol plugin specfic implementation
getRemoteDir() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve the effective remote directory, which is currently used by the sshftp client instance.
getRemoteFileList() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Returns the remote fileList returned as a Vector after executing commands like NLST ( FTPClient#executeLsCmd()), LIST (FTPClient#executeDirCmd()).
getReturnCode() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Returns the three digit return code returned from the Server after executing the Command.
getReturnMsg() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Returns the original message returned by the server after executing the command.
getSize() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Obtain the size of the file in bytes.
getTimeout() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Retrieve the timeout on a connected tunnel awaiting the peer's reply
getTransportType() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Only when secure transport is used.
getUsername() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Gets the username that is used to connect to the FTP server.
getUsername() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Gets the username that is used to connect to the SSHFTP server.
getUserStatusCode() - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Get the specified status code
getUserStatusMsg() - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Get the specified status message

## H

HELP_MESSAGE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Help message.
HOSTNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The host name
HOSTNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The host name
HOSTNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The host name

## I

IBPGP_HANDLER - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The Inbound PGPHandler name
IClientObject - Interface in com.tibco.ax.fw.runtime.transport
  Protocol plugin specific implementation to provide more context specific information about the transaction.
IFTPFlavorReply - Interface in com.tibco.ax.fw.runtime.transport
  Constants and methods for handling FTP server replies.
IIBScriptPGPHandler - Interface in com.tibco.ax.fw.runtime.inbound.impl
  IIBScriptPGPHandler interface exposes the methods to setup and conduct inbound PGP processing.
INPUT_SOURCE_DIR - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  For FTP Get this is the path where the fetched files are to be stored
INPUT_SOURCE_DIR - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  For FTP Get this is the path where the fetched files are to be stored
IOBScriptPGPHandler - Interface in com.tibco.ax.fw.runtime.outbound.impl
  IOBScriptPGPHandler interface exposes the methods to setup and conduct outbound PGP processing.
isBinaryTransfer() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Get the transfer mode.
isDir() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Check if the object defined by this attribute is a directory.
isFile() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.FileAttr
  Check if the object defined by this attribute is a file.
isSecureMode() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Checks if the FTP connection is secure or unsecure.

## L

log(String, int, String) - Method in interface com.tibco.ax.fw.runtime.util.UserLogAccess
  Creates an entry in the Audit Log with the given state, status and description.
LOG_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The log client extension handle for custom scripts to log.
LOG_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The log client extension handle for custom scripts to log.
LOG_OBJ - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The log client extension handle for custom scripts to log.

## M

MSGOBJECT - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  If the payload exists in memory and therefore it is not referenced by a filename, this slot holds the object, which can be retrieved through the method get("dataObj").

## N

NEED_ACCOUNT_FOR_LOGIN_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Need account for login.
NEED_ACCOUNT_FOR_STORING_FILES_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Need account for storing files.
NOT_LOGGED_IN_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Not logged in.

## O

OBPGP_HANDLER - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The Outbound PGPHandler name
OPERATION_ID - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The operation ID of the message.
OPERATION_ID - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The operation ID of the message.
OPERATIONID - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The operation ID of the message.
ORIG_FILE_NAME - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Optional, it can be used by business protocols to indicate the original file name location of a file reference.
ORIG_FILE_NAME - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Optional, it can be used by business protocols to indicate the original file name location of a file reference.
ORIG_FILE_PATH - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Optional, it can be used by business protocols to indicate the original path of a file reference.
ORIG_FILE_PATH - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Optional, it can be used by business protocols to indicate the original path of a file reference.
OUTPUT_SOURCE_DIR - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  For FTP Put this is the path where the referenced file is taken from.
OUTPUT_SOURCE_DIR - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  For FTP Put this is the path where the referenced file is taken from.

## P

packageMessage() - Method in interface com.tibco.ax.fw.runtime.outbound.impl.IOBScriptPGPHandler
  Packages the payload in the outbound FTP session with PGP processing
PAGE_TYPE_UNKNOWN_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested action aborted: page type unknown.
PASSIVE_MODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  FTP passive mode to be set so that FTP server can listen on a port and send the ip and port information to the FTP client when the client issues PASV command.
PATHNAME_CREATED_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  "PATHNAME" created.
PENDING - Static variable in interface com.tibco.ax.fw.runtime.util.UserLogAccess
  PENDING status to be specified for the log entry.
PERMANENT_NEGATIVE_COMPLETION_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Syntax error, command unrecognized.
PERMANENT_NEGATIVE_COMPLETION_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  Command execution failed, there is no reason to attempts further retries with the supplied data.
PERMANENTLY_UNAVAILABLE_FILE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested action not taken.
PERMANENTLY_UNAVAILABLE_FILE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  The requested file or object has not been found.
POSITIVE_COMPLETION_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Command okay.
POSITIVE_COMPLETION_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  Command executed without errors.
put(String, Object) - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
put(String, boolean) - Method in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  Regardless of the prop value, set the 'DELETEREF' slot to the value of 'del'

## R

REQUESTED_FILE_ACTION_OK_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested file action okay, completed.
REQUESTED_FILE_ACTION_PENDING_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested file action pending further information.
RESTART_MARKER_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Restart marker reply.
RETRY_SLOT - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The value "true" or "false" depending on whether the custom script wants BusinessConnect to re-execute itself.
RETRY_SLOT - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The value "true" or "false" depending on whether the custom script wants BusinessConnect to re-execute itself.

## S

SERVICE_NOT_AVAILABLE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Service not available, closing control connection.
setBinaryTransfer(boolean) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Set the transfer mode.
setCompressionAlgo(String) - Method in interface com.tibco.ax.fw.runtime.outbound.impl.IOBScriptPGPHandler
  Sets the algorithms of compression
setControlConnectionTimeout(int) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Enable/disable the SO_TIMEOUT with the specified timeout, in seconds.
setDataConnectionTimeout(int) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Enable/disable the SO_TIMEOUT with the specified timeout, in seconds for the data connection.
setFormat(String) - Method in interface com.tibco.ax.fw.runtime.outbound.impl.IOBScriptPGPHandler
  Sets the format of the resulting payload after PGP processing
setFTPMode(int) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Sets the FTP mode to be either Active or Passive for the data connection.
setHostPrivateKey(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The ssh private key, which the custom script wants to use instead of the one configured for the transport.
setOperationID(String) - Method in interface com.tibco.ax.fw.runtime.inbound.impl.IIBScriptPGPHandler
  Sets the operation id for this inbound FTP session, so the PGP configuration can be retrieved for PGP processing.
setOperationID(String) - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Set a custom operation ID on this FTP or SSHFTP reply instance.
setPeerPublicKey(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The ssh public key, which the custom script wants to use instead of the one configured for the transport.
setPGPOptions(boolean, boolean, boolean) - Method in interface com.tibco.ax.fw.runtime.outbound.impl.IOBScriptPGPHandler
  Sets the PGP process options for signing, encryption and compression
setPGPPolicy(String) - Method in interface com.tibco.ax.fw.runtime.inbound.impl.IIBScriptPGPHandler
  Set the policy for inbound PGP Processing.
setRemoteDir(String) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Set the effective remote directory, which will be used by the sshftp client instance.
setSecureMode(boolean) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Deprecated.
  The FTP transport configuration provides a way to set the secure mode and associate a certificate for SSL.
setSSLCertificate(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Set the SSL certificate name to do SSL handshake.
setSSLHostKey(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Set the host private key to be used for SSL handshake that requires client authentication.
setTimeout(int) - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Set the timeout on a connected tunnel awaiting the peer's reply
setTransportType(String) - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Only when secure transport is used.
SRC_FILE_NAME - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The file name used specifically for outbound referenced payload.
SRC_FILE_NAME - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The file name used specifically for outbound referenced payload.
SRCFILENAME - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The file name used for outbound referenced payload.
SRCFILEPATH - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The file path used for outbound referenced payload.
SRCFILEURL - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The transport url for outbound referenced payload.
SSHFTPClient - Interface in com.tibco.ax.fw.runtime.transport.sshftp
  The SSHFTPClient interface models an SSHFTP client that can connect to an SSH server utilzing its sftp subsystem and perform file manipulation based based on the SSH File Transfer Protocol.
SSHFTPReply - Interface in com.tibco.ax.fw.runtime.transport.sshftp
  This interface collects several status codes that can be the result of ssh ftp operations.
SUPERFLOUS_COMMAND_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Command not implemented, superfluous at this site.
SYNTAX_ERROR_IN_ARGUMENTS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Syntax error in parameters or arguments.
SYNTAX_ERROR_IN_ARGUMENTS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPReply
  Syntax error in parameters or arguments.
SYSTEM_STATUS_OR_HELP_REPLY_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  System status, or system help reply.
SYSTEM_TYPE_NAME_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  `NAME` system type.

## T

toString() - Method in interface com.tibco.ax.fw.runtime.transport.IFTPFlavorReply
  Returns a string representation of this SSH/FTPReply including the code, message text, Remote fileList if present and the filename if present.
TPNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The partner name
TPNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The partner name
TPNAME - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The partner name
TRANSACTION_ID - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The transaction ID of the message.
TRANSACTION_ID - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The transaction ID of the message.
TRANSACTIONID - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The transaction ID of the message.
TRANSIENT_INSUFFICIENT_STORAGE_SPACE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested action not taken.
TRANSIENT_LOCAL_PROCESSING_ERROR_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested action aborted: local error in processing.
TRANSIENT_UNAVAILABLE_FILE_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Requested file action not taken.

## U

unpackageMessage(String) - Method in interface com.tibco.ax.fw.runtime.inbound.impl.IIBScriptPGPHandler
  Unpackage the PGP packaged inbound FTP file specified by filename
useHttpProxyServer() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Checks if an HTTP proxy server is used to connect to the FTP server.
useProxyServer() - Method in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  Checks if a proxy server is used to connect to the FTP server.
useProxyServer() - Method in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  Checks if a proxy server is used to connect to the SSHFTP server.
USER_LOGGED_IN_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  User logged in, proceed.
USER_STATUS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The custom script can return a status code in this slot.
USER_STATUS_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The custom script can return a status code in this slot.
USER_STATUS_MSG - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPClient
  The custom script can return a status message in this slot.
USER_STATUS_MSG - Static variable in interface com.tibco.ax.fw.runtime.transport.sshftp.SSHFTPClient
  The custom script can return a status message in this slot.
UserLogAccess - Interface in com.tibco.ax.fw.runtime.util
  UserLogAccess interface creates an entry in the Audit Log.
USERNAME_OK_NEED_PASSWORD_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  User name okay, need password.
USERSTATUSCODE - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The custom script can return a status code in this slot.
USERSTATUSMSG - Static variable in interface com.tibco.ax.fw.runtime.transport.file.FILEClient
  The custom script can return a status message in this slot.

## W

WILL_BE_READY_IN_MINUTES_CODE - Static variable in interface com.tibco.ax.fw.runtime.transport.ftp.FTPReply
  Service ready in `nnn` minutes.

A B C D E F G H I L M N O P R S T U W