public class FtpQueue extends Object
FtpQueue
class allows administrators to create FTP queues.
A FTP queue is special destinations allowing to transfer file by FTP. It wraps the FTP transfer of a file through a message exchange. The sender starts the transfer by sending a JMS message, and the receiver is notified of the transfer completion by a JMS message.
Modifier and Type | Field and Description |
---|---|
static String |
DefaultFTPImpl
Class name of default handler allowing to transfer file through FTP.
|
static String |
JFTPImpl
Class name of handler allowing to transfer file using JFTP.
|
Constructor and Description |
---|
FtpQueue() |
Modifier and Type | Method and Description |
---|---|
static Queue |
create(int serverId,
String name)
Administration method creating and deploying a FTP queue on a given server.
|
static Queue |
create(int serverId,
String name,
Properties props)
Administration method creating and deploying a FTP queue on a given server.
|
static Queue |
create(String name)
Administration method creating and deploying a FTP queue on the local server.
|
public static final String DefaultFTPImpl
public static final String JFTPImpl
public static Queue create(String name) throws ConnectException, AdminException
The request fails if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
name
- The name of the created queue.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String)
public static Queue create(int serverId, String name) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.public static Queue create(int serverId, String name, Properties props) throws ConnectException, AdminException
A set of properties is used to configure the FTP destination:
msg.setStringProperty("url", "ftp://user:pass@host/file;type=i");
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.props
- A Properties object containing all needed parameters.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.Copyright © 2019 ScalAgent D.T.. All rights reserved.