FileCatalyst SDK

FileCatalyst为第三方独立软件供应商（ISV）提供了多种集成选项，以支持其产品中的加速文件传输。 FileCatalyst SDK拥有大量组件，开发语言和环境。

FileCatalyst可以通过最少的编码集成到任何应用程序/工作流程中，并提供全方位的方法调用，并可访问所有常见和高级功能。

产品	API可用	用法
FileCatalyst服务器	Java，CLI，REST	管理FileCatalyst服务器（示例：添加/删除用户，管理当前传输
FileCatalyst Hotfolder	REST的	完全控制整个应用程序（例如：添加新站点，修改调度程序，更改带宽）
FileCatalyst TransferAgent	JavaScript，REST	在任何Web应用程序中集成Web传输（示例：获取本地/远程文件，执行上载）
FileCatalyst Mobile	Android，iOS，C ++	在任何移动应用程序中集成加速文件传输
FileCatalyst客户端API	Java，C ++，CLI，.NET	集成到桌面应用程序中
FileCatalyst工作流作业提交	Java的	将作业提交/分发集成到任何应用程序中。
FileCatalyst工作流管理	REST的	整合用户，字段和表单的创建
FileCatalyst Central	REST的	管理，监控整个FileCatalyst部署。远程控制任何连接的节点。远程执行传输
FileCatalyst TransferController	REST的	将节点集成到节点转移到任何应用程序

*转入和转出工作流程。

开发套件是我们产品的基础; 如果您拥有任何合格产品，则可以将开发套件许可为附加产品。对于独立开发，SDK通常添加到FileCatalyst Direct; 但是，某些组件旨在与FileCatalyst Workflow交互。

观看我们的Java SDK网络研讨会

随附下载示例源代码在这里

观看我们的C ++ SDK网络研讨会

客户端API

TransferController – 通过REST API集成，TransferController提供了在多个节点之间作为单个进程执行传输的功能。 TransferController还提供传输的实时状态。

Java客户端API – 提供与FileCatalyst Server建立连接，上载和下载文件以及对正在进行的传输的完全控制的方法。默认值用于常用功能，但API为高级功能提供了全方位的方法调用。 API还允许用户以编程方式将作业和文件提交到FileCatalyst Workflow。

import unlimited.fc.client.api。*; import java.io. *; import java.util。*; import java.util.Observable; import java.io.IOException; import unlimited.fc.com.FCException; / ** *此示例说明了使用Observables监视TransferHook对象。 * / public class UploadSampleAdvanced实现Observer {TransferHook upload = null; public void go（）抛出IOException，FCException {FCClient fc = new FCClient（“192.168.1.30”，2057）; fc.setShowConsoleLog（真）; fc.initialize（）; fc.connect（）; fc.login（“anonymous”，“me@email.com”）; //让我们自动检测传输模式。 除非RTT足够高，否则将使用FTP。 fc.setMode（TransferMode.AUTO）; //让我们以恒定的1500 Kbps发送，没有拥塞控制。 //如果FC被检测为最佳传输模式fc.setUseCongestionControl（false），则拥塞控制才会起作用; fc.setTargetRate（1500）; //之后验证文件fc.setVerifyIntegrity（true）; upload = fc.upload（新文件（“c：/ bigfiles / 500MB”））; upload.addObserver（本）; try {synchronized（this）{wait（）; catch（InterruptedException ex）{} //断开与服务器的连接fc.disconnect（）; //清理fc.finish（）; public void update（Observable observable，Object object）{if（！upload.isTransferComplete（）&&！upload.isTransferCancelled（）&&！upload.isTransferError（））{if（upload.getStatusCode（）== upload.TRANSFERRING && upload .getCurrentPercent（）！= 100）{printProgress（upload.getRate（），upload.getCurrentPercent（））; } else if（upload.getStatusCode（）== upload.DONEFILE）{printProgress（upload.getRate（），100）; }} else {//所有文件完全同步（this）{notifyAll（）; public void printProgress（int rate，int percent）{System.out.println（percent +“％”）; System.out.println（rate +“kbps”）; public static void main（String args []）throws Exception {new UploadSampleAdvanced（）。go（）; }}

C ++本机客户端库– 本机C ++客户端API，也可用作命令行可执行文件。它允许FileCatalyst嵌入到没有Java的系统中。此API提供与Java API相同的功能，可以在不支持Java的平台上编译/使用。

C ++示例

复制到剪贴板

#include #include int main（int argc，char * argv []）{int rc = 0; “ std :: cout <<”传输文件，然后打印一些统计信息。“ << std :: endl; 尝试{//设置FTP连接：fc :: Options选项； options.setFtpServer（“ 192.168.1.80”）; options.setUsernameAndPassword（“ user”，“ test”）; options.setBandwidth（20000）; fc :: Control ftp（options）; ftp.connect（）; //通过UDP std :: cout <<“正在下载文件...” << std :: endl; ftp.downloadFile（“ numbers.txt”，“ numbers.txt”）; //显示一些统计信息const fc :: TransferStats＆stats = ftp.getTransferStats（）; std :: cout <<“时间戳（开始）：” << stats.timeTransferBegan << std :: endl <<“时间戳（完成）：” << stats.timePreviousBlockFinished << std :: endl <<“ “ << stats.blocksRemaining << std :: endl <<”完成的块：“ << stats.blocksCompleted << std :: endl <<”期望的字节数：“ << stats.ulPayloadBytesExpected << std :: endl << “收到的字节：” << stats.ulPayloadBytesReceived << std :: endl <<“从FTP服务器收到的数据包：” << stats.ulPacketsReceived << std :: endl <<“发送至FTP服务器的数据包：” < <stats.ulPacketsSent << std :: endl <<“由于接收到重复数据包而丢弃了这些数据包：” << stats.ulDuplicatePacketDropped << std :: endl <<“必须手动请求的数据包：” << stats.ulRequestRetransmit < <std :: endl; } catch（const fc :: Exception＆e）{e.display（）; rc = 1; } return rc; }

服务器API（Java和REST） –公开了管理用户，组和虚拟文件/文件夹以及从FileCatalyst Server请求会话信息所需的每种方法。

服务器API示例（Java）

复制到剪贴板

//以下示例是示例代码，在该示例代码中，如果ServerAPI和服务器之间的通信中断，应用程序将尝试创建用户并//封装用于重新连接尝试的逻辑。 //呼叫建立与FileCatalyst Server的初始连接public void init（）引发异常{FCServer fcserver = new FCServer（）; //连接参数fcserver.setHostname（“ localhost”）; fcserver.setPort（12400）; fcserver.setUserName（“ admin”）; fcserver.setPassword（“ system”）; //连接fcserver.connect（）; } //尝试重新连接私有void reconnect（）引发异常{try {fcserver.disconnect（）; } catch（Exception e）{} fcserver.connect（）; } // //修改用户登录凭据的方法。 如果该用户尚不存在，则也创建//用户。 // @param fcUserName FTP登录名// @param fcPassword用户希望拥有的密码// @throws异常如果尝试3次后仍无法连接到服务器，或者服务器不允许您//创建/修改用户。 // public void createOrModifyUserCredentials（String fcUserName，String fcPassword）throws Exception {//获取FileCatalyst用户。 int MAXATTEMPTS = 3; UserContainer fcUser = null; int retryAttempts = 0; while（fcUser == null && retryAttempts <MAXATTEMPTS）{//如果我们丢失了连接，请尝试连接（fcserver.isConnected（））{reconnect（）; }试试{fcUser = fcserver.getUser（fcUserName）; if（fcUser == null）{//返回null表示用户不存在-创建fcserver.addUser（fcUserName，fcPassword）; //测试看看用户是否真的在那里fcserver.resynchConfigurationFiles（）; fcUser = fcserver.getUser（fcUserName）; 如果（fcUser == null）{抛出新异常（“ FileCatalyst用户无法使用用户名'” + fcUserName +“'”创建）； } return; } else {fcserver.modUserPassword（fcUserName，fcPassword）; 返回; }} catch（AdminConnectionException e）{//上空的连接。 让我们再试一次retryAttempts ++; 抛出新的异常（“无法连接到FCServer，已达到最大尝试次数”）； }

移动API – 允许在iOS和Android应用程序中集成快速文件传输。 FileCatalyst为iOS提供本机Objective-C API，为Android Dalvik提供Java API。 FileCatalyst应用程序使用这些移动API构建，也可在各自的应用程序商店中用于Android和iOS。

Object-C示例

复制到剪贴板

// // FCAViewController.m //示例// //版权所有（c）2012 Unlimi-Tech Software Inc ..  版权所有。
 // //此示例代码将上传并下载名为//“nature-qc-320-320-7.jpg”的文件（与SDK捆绑在一起）#import“FCAViewController.h”#import“NSString + FCAUtils。 h“@interface FCAViewController（）@ property（强，非原子）FCAControl *控制; @end @implementation FCAViewController @synthesize connectionStatusLabel; @synthesize connectionDetailLabel; @synthesize transferStatusLabel; @synthesize transferDetailLabel; @synthesize cancelButton; @synthesize downloadButton; @synthesize uploadButton; @synthesize connectButton; @synthesize控制;  - （void）reportError：（NSError *）error {if（！error）return; UIAlertView * alert = [[UIAlertView alloc] initWithTitle：@“Error”消息：error.localizedDescription delegate：nil cancelButtonTitle：@“OK”otherButtonTitles：nil]; [警示显示]; } //基本文件上传。  控件实例有自己的私有工作队列，必须//执行所有命令（cancelTransfer除外）。  为此，有两个辅助方法，performBlock：completion：和performBlockAndWait：//如果块中的任何命令失败，它将在传递给完成块的NSError实例中报告，//或者从performBlockAndWait：call返回。
 - （IBAction）uploadAction：（id）sender {[self.uploadButton setTitle：@“Uploading ...”  forState：UIControlStateNormal]; self.uploadButton.enabled = NO; [self.control performBlock：^ {NSString * filename = @“nature-qc-320-320-7.jpg”; NSURL * fileURL = [NSURL fileURLWithPath：[[NSBundle mainBundle] pathForResource：@“nature-qc-320-320-7”ofType：@“jpg”]]; [control uploadFile：fileURL toPath：filename transferStarted：^（FCAFileTransferStats * stats）{//在主队列self.transferStatusLabel.text = filename上调用此回调; self.cancelButton.hidden = NO; NSLog（@“转移已开始”）; } transferCompleted：^（FCAFileTransferStats * stats）{//在主队列NSLog上调用此回调（@“传输已完成”）; self.transferStatusLabel.text = [NSString stringWithFormat：@“％@ finished”，filename]; self.cancelButton.hidden = YES; }]; } completion：^（NSError * error）{[self reportError：error]; [self.uploadButton setTitle：@“Test Upload”forState：UIControlStateNormal]; self.uploadButton.enabled = YES; }]; }  - （IBAction）downloadAction：（UIButton *）sender {[self.downloadButton setTitle：@“正在下载...”  forState：UIControlStateNormal]; self.downloadButton.enabled = NO; [self.control performBlock：^ {NSString * filename = @“nature-qc-320-320-7.jpg”; NSURL * documentsDirectory = [[[NSFileManager defaultManager] URLsForDirectory：NSDocumentDirectory inDomains：NSUserDomainMask] lastObject]; NSURL * fileURL = [documentsDirectory URLByAppendingPathComponent：filename]; [control downloadFile：filename toURL：fileURL transferStarted：^（FCAFileTransferStats * stats）{self.transferStatusLabel.text = filename; self.cancelButton.hidden = NO; } transferCompleted：^（FCAFileTransferStats * stats）{self.transferStatusLabel.text = [NSString stringWithFormat：@“％@ finished”，filename]; self.cancelButton.hidden = YES; }]; } completion：^（NSError * error）{[self reportError：error]; [self.downloadButton setTitle：@“Test Download”forState：UIControlStateNormal]; self.downloadButton.enabled = YES; }]; } //此方法显示如何使用非阻塞连接/断开调用 - （IBAction）connectAction：（UIButton *）sender {if（[self.control isConnected]）{sender.enabled = NO; [发送者setTitle：@“断开连接......”  forState：UIControlStateNormal]; [self.control performBlock：^ {[self.control disconnect]; } completion：^（NSError * error）{sender.enabled = YES; [self reportError：错误]; }]; } else {sender.enabled = NO; [发送者setTitle：@“正在连接......”  forState:UIControlStateNormal];

[self.control performBlock:^{
            [self.control connect];
        } completion:^(NSError *error) {
            sender.enabled = YES;
            [self reportError:error];
        }];
    }
}

- (IBAction)cancelAction:(UIButton *)sender {
    [self.control cancelTransfer];
}

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
    if (self) {
        // create an FCAControl instance and set the connection options
        self.control = [[FCAControl alloc] init];
        self.control.username = @"user";
        self.control.password = @"test";
        self.control.hostname = @"10.0.1.2";
        self.control.port = 8123;

// some options that are not required to set
        control.useSSL = NO;
        control.autoResumeEnabled = NO;
        control.fileExistsOverride = YES;
    }
    return self;
}

- (void)configureControlStats {
    self.connectionDetailLabel.text = [NSString stringOfTransferRate:self.control.bitsPerSecondAverageTransferRate];
}

- (void)configureView {
    NSString *connectionStatus = nil;

if ([self.control isConnected]) {
        [self.connectButton setTitle:@"Disconnect" forState:UIControlStateNormal];
        self.uploadButton.hidden = NO;
        self.downloadButton.hidden = NO;
        connectionStatus = @"connected";
    } else {
        [self.connectButton setTitle:@"Connect" forState:UIControlStateNormal];
        self.uploadButton.hidden = YES;
        self.downloadButton.hidden = YES;
        connectionStatus = @"not connected";
    }

self.connectionStatusLabel.text = [NSString stringWithFormat:@"%@:%d (%@)",
                                       self.control.hostname, self.control.port, connectionStatus];
}

- (void)viewDidLoad
{
    [super viewDidLoad];

// there are notifications for the connect and disconnect events
    [[NSNotificationCenter defaultCenter] addObserverForName:FCAControlConnectedKey
                                                      object:self.control
                                                       queue:[NSOperationQueue mainQueue]
                                                  usingBlock:^(NSNotification *note) {
                                                      [self configureView];
                                                  }];

[[NSNotificationCenter defaultCenter] addObserverForName:FCAControlDisconnectedKey
                                                      object:self.control
                                                       queue:[NSOperationQueue mainQueue]
                                                  usingBlock:^(NSNotification *note) {
                                                      [self configureView];
                                                  }];

// during transfers, the Control instance will periodically send out a notification with updated
    // connection statistics
    [[NSNotificationCenter defaultCenter] addObserverForName:FCAControlUpdatedKey
                                                      object:self.control
                                                       queue:[NSOperationQueue mainQueue]
                                                  usingBlock:^(NSNotification *note) {
                                                      [self configureControlStats];
                                                  }];

[self configureView];
}

- (void)viewDidUnload
{
    [self setConnectionStatusLabel:nil];
    [self setConnectionDetailLabel:nil];
    [self setTransferStatusLabel:nil];
    [self setTransferDetailLabel:nil];
    [self setCancelButton:nil];
    [self setDownloadButton:nil];
    [self setUploadButton:nil];
    [self setConnectButton:nil];
    [super viewDidUnload];
    // Release any retained subviews of the main view.

HotFolder REST API – 该API可以完全控制任何HotFolder实例。它提供了使您可以添加新监视文件夹，新站点以及创建，操作和执行任务的方法。

TransferAgent（JavaScript和REST API）– 在任何Web应用程序中实现FileCatalyst的紧密集成。使用TransferAgent的Web应用程序能够访问/浏览本地文件系统，将文件添加到队列，以及通过JavaScript或直接通过REST调用启动或监视文件传输。

中央REST API – 提供对所有连接节点的报告数据的完全访问。 API还充当反向HTTP代理，以访问各个连接节点（如Server，HotFolder和TransferAgent）的REST API。

命令行工具（CLI）– 提供允许您通过命令行控制台传输文件的界面，提供简单的脚本编写体验。这些工具可以在JAVA和C ++中使用，可以集成到当前使用FTP，SCP或rsync的现有shell脚本中。

FileCatalyst SDK

客户端API

简单的Java示例

高级Java示例（使用Observables）

C ++示例

服务器API示例（Java）

Object-C示例