FileCatalyst SDK

FileCatalyst bietet eine Vielzahl von Integrationsoptionen für ISVs (Independent Software Vendors) von Drittanbietern, um die beschleunigte Dateiübertragung innerhalb ihrer Produkte zu unterstützen. Das FileCatalyst SDK bietet eine Vielzahl von Komponenten, Entwicklungssprachen und Umgebungen.

FileCatalyst kann mit minimalem Programmieraufwand in jede Anwendung / jeden Workflow integriert werden und bietet eine breite Palette von Methodenaufrufen mit Zugriff auf alle gängigen und erweiterten Funktionen.

Produkt	APIs verfügbar	Anwendungsbereich
FileCatalyst Server	Java, CLI, REST	Administration von FileCatalyst Server (Beispiel: Benutzer hinzufügen / entfernen, Aktuelle Übertragungen verwalten
FileCatalyst-Hotfolder	REST	Volle Kontrolle über die gesamte Anwendung (Beispiel: Neue Site hinzufügen, Scheduler ändern, Bandbreite ändern)
FileCatalyst TransferAgent	JavaScript, RUHE	Webtransfers in beliebige Webanwendungen integrieren (Beispiel: Lokale / Remote-Dateien holen, Upload ausführen)
FileCatalyst Mobile	Android, iOS, C ++	Integrieren Sie die beschleunigte Dateiübertragung in jede mobile Anwendung
FileCatalyst-Client-API	Java, C ++, CLI, .NET	Integration in Desktop-Anwendungen
FileCatalyst Workflow-Auftragseinreichung	Java	Jobeinreichung / -verteilung in jede Anwendung integrieren
FileCatalyst-Workflowverwaltung	REST	Integrieren Sie die Erstellung von Benutzern, Feldern und Formularen
FileCatalyst Central	REST	Verwalten, überwachen Sie die gesamte FileCatalyst-Bereitstellung. Steuern Sie einen angeschlossenen Knoten remote. Führen Sie die Übertragung remote aus
FileCatalyst TransferController	REST	Integrieren Sie Knoten zu Knoten Übertragungen in jede Anwendung

* Transfer zum und vom Workflow.

Das Development Kit ist die Grundlage unserer Produkte; Wenn Sie qualifizierende Produkte besitzen, kann das Development Kit als Add-on lizenziert werden. Für die eigenständige Entwicklung wird das SDK in der Regel zu FileCatalyst Direct hinzugefügt. Einige Komponenten sind jedoch so konzipiert, dass sie mit FileCatalyst Workflow interagieren.

Sehen Sie sich unser Java SDK-Webinar an

Begleitend herunterladen Beispiel Quellcode hier

Sehen Sie sich unser C ++ SDK-Webinar an

Client-API

TransferController - TransferController ist über die REST-API integriert und bietet die Möglichkeit, Übertragungen zwischen mehreren Knoten als einen einzigen Prozess durchzuführen. Der TransferController zeigt auch den Echtzeitstatus der Übertragung an.

Java Client API - Bietet Methoden zum Herstellen einer Verbindung mit einem FileCatalyst-Server, zum Hochladen und Herunterladen von Dateien sowie zur vollständigen Kontrolle über laufende Übertragungen. Standardwerte werden für allgemeine Funktionen verwendet, die API bietet jedoch eine Reihe von Methodenaufrufen für erweiterte Funktionen. Die API ermöglicht es Benutzern auch, Jobs und Dateien programmgesteuert an FileCatalyst Workflow zu senden.

Einfaches Java-Beispiel

In die Zwischenablage kopieren

importiere unlimited.fc.client.api. *; import java.io. *; öffentliche Klasse UploadSample {public static void main (String args []) löst eine Ausnahme aus {FCClient fc = new FCClient ("192.168.1.30", 21); fc.setShowConsoleLog (true); fc.initialize (); fc.connect (); fc.login ("anonym", "me@email.com"); fc.setMode (TransferMode.UDP); // Startrate und Zielrate gleich einstellen. Es wird langsamer, wenn eine Überlastung auftritt. fc.setStartRate (10000); fc.setTargetRate (10000); fc.setVerifyIntegrity (true); TransferHook upload = fc.upload (neue Datei ("c: /temp/500MB.zip")); while (! upload.isTransferComplete ()) {// Sie können hier einige Fortschrittsinformationen mithilfe der verschiedenen Methoden im TransferHook-Objekt anzeigen, wenn (upload.getStatusCode () == upload.TRANSFERRING) {System.out.println (upload .getPercent () + "%" + upload.getRate () + "Kbps"); } try {Thread.sleep (1000); } catch (InterruptedException ex) {}} // Verbindung zum Server trennen fc.disconnect (); // Bereinige fc.finish (); }}

Erweitertes Java-Beispiel (Verwendung von Observablen)

In die Zwischenablage kopieren

importiere unlimited.fc.client.api. *; import java.io. *; import java.util. *; import java.util.Observable; import java.io.IOException; importiere unlimited.fc.com.FCException; / ** * Dieses Beispiel veranschaulicht die Verwendung von Observables zur Überwachung eines TransferHook-Objekts. * / public class UploadSampleAdvanced implementiert Observer {TransferHook upload = null; public void go () wirft IOException, FCException {FCClient fc = neuer FCClient ("192.168.1.30", 2057); fc.setShowConsoleLog (true); fc.initialize (); fc.connect (); fc.login ("anonym", "me@email.com"); // Lassen Sie uns den Übertragungsmodus automatisch erkennen. Sofern RTT nicht hoch genug ist, wird FTP verwendet. fc.setMode (TransferMode.AUTO); // Lässt Senden mit einer konstanten 1500 Kbps, keine Überlastungskontrolle. // Die Überlastungskontrolle kommt nur ins Spiel, wenn FC als bester Übertragungsmodus erkannt wird. fc.setUseCongestionControl (false); fc.setTargetRate (1500); // überprüfe die Datei danach fc.setVerifyIntegrity (true); upload = fc.upload (neue Datei ("c: / bigfiles / 500MB")); upload.addObserver (this); try {synchronized (this) {wait (); }} catch (InterruptedException ex) {} // Verbindung zum Server trennen fc.disconnect (); // Bereinige 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 {// alle Dateien sind vollständig synchronisiert (this) {notifyAll (); }}} public void printProgress (int rate, int percent) {System.out.println (Prozent + "%"); System.out.println (Rate + "kbps"); } public static void main (String args []) löst eine Ausnahme aus {new UploadSampleAdvanced (). go (); }}

C ++ Native Client Library - Eine native C ++ - Client-API, die auch als ausführbare Befehlszeile verfügbar ist. Hiermit kann FileCatalyst in Systeme ohne Java eingebettet werden. Diese API bietet dieselben Funktionen wie die Java-API und kann auf Plattformen kompiliert / verwendet werden, die Java nicht unterstützen.

C ++ Beispiel

In die Zwischenablage kopieren

#include #include int main (int argc, char * argv []) {int rc = 0; std :: cout << "Übertragen Sie eine Datei und drucken Sie dann einige Statistiken aus." << std :: endl; try {// FTP-Verbindung einrichten: fc :: Options options; options.setFtpServer ("192.168.1.80"); options.setUsernameAndPassword ("Benutzer", "Test"); options.setBandwidth (20000); fc :: Control ftp (Optionen); ftp.connect (); // Eine Datei über UDP übertragen std :: cout << "Herunterladen einer Datei ..." << std :: endl; ftp.downloadFile ("numbers.txt", "numbers.txt"); // Einige Statistiken anzeigen const fc :: TransferStats & stats = ftp.getTransferStats (); std :: cout << "Timestamp (begin):" << stats.timeTransferBegan << std :: endl << "Timestamp (finish):" << stats.timePreviousBlockFinished << std :: endl << "Verbleibende Blöcke: "<< stats.blocksRemaining << std :: endl <<" Blocks abgeschlossen: "<< stats.blocksCompleted << std :: endl <<" Erwartete Bytes: "<< stats.ulPayloadBytesExpected << std :: endl << "Erhaltene Bytes:" << stats.ulPayloadBytesReceived << std :: endl << "Vom FTP-Server empfangene Pakete:" << stats.ulPacketsReceived << std :: endl << "An den FTP-Server gesendete Pakete:" < <stats.ulPacketsSent << std :: endl << "Pakete wurden aufgrund empfangener Duplikate verworfen:" << stats.ulDuplicatePacketDropped << std :: endl << "Pakete, die manuell angefordert werden mussten:" << stats.ulRequestRetransmit < <std :: endl; } catch (const fc :: Exception & e) {e.display (); rc = 1; } return rc; }}

Server-APIs (Java und REST) - Zeigt alle Methoden an, die zum Verwalten von Benutzern, Gruppen und virtuellen Dateien / Ordnern sowie zum Anfordern von Sitzungsinformationen von einem FileCatalyst-Server erforderlich sind.

Server-API-Beispiel (Java)

In die Zwischenablage kopieren

// Beispiel unten ist Beispielcode, in dem die Anwendung versucht, einen Benutzer zu erstellen, und // die Logik für Wiederverbindungsversuche einschließt, falls die Kommunikation zwischen der ServerAPI // und dem Server unterbrochen wird. // Aufruf zum Einrichten der ersten Verbindung zu FileCatalyst Server public void init () löst eine Ausnahme aus {FCServer fcserver = new FCServer (); // Verbindungsparameter fcserver.setHostname ("localhost"); fcserver.setPort (12400); fcserver.setUserName ("admin"); fcserver.setPassword ("system"); // connect fcserver.connect (); } // versucht eine erneute Verbindung private void reconnect () löst eine Ausnahme aus {try {fcserver.disconnect (); } catch (Ausnahme e) {} fcserver.connect (); } // // Methode zum Ändern der Anmeldeinformationen für einen Benutzer. Wenn der Benutzer noch nicht vorhanden ist, erstellen Sie auch den // Benutzer. // @param fcUserName FTP-Anmeldename // @param fcPassword Passwort, das der Benutzer haben möchte // @throws Ausnahme Wenn Sie nach 3 Versuchen keine Verbindung zum Server herstellen können oder der Server es Ihnen nicht erlaubt, // den Benutzer zu erstellen / zu ändern . // public void createOrModifyUserCredentials (String fcUserName, String fcPassword) löst eine Ausnahme aus {// Den FileCatalyst-Benutzer abrufen. int MAXATTEMPTS = 3; UserContainer fcUser = null; int retryAttempts = 0; while (fcUser == null && retryAttempts <MAXATTEMPTS) {// versuche eine Verbindung herzustellen, wenn die Verbindung unterbrochen wurde if (! fcserver.isConnected ()) {reconnect (); } try {fcUser = fcserver.getUser (fcUserName); if (fcUser == null) {// null return zeigt an, dass der Benutzer nicht existiert - create fcserver.addUser (fcUserName, fcPassword); // teste, ob der Benutzer wirklich da ist fcserver.resynchConfigurationFiles (); fcUser = fcserver.getUser (fcUserName); if (fcUser == null) {neue Ausnahme auslösen ("FileCatalyst-Benutzer konnte nicht mit Benutzername '" + fcUserName + "'" erstellt werden); } Rückkehr; } else {fcserver.modUserPassword (fcUserName, fcPassword); Rückkehr; }} catch (AdminConnectionException e) {// Verbindung foobared. Versuchen wir es noch einmal retryAttempts ++; }} neue Ausnahme auslösen ("Verbindung zum FCServer kann nicht hergestellt werden, maximale Anzahl von Versuchen erreicht"); }}

Mobile APIs - Ermöglicht die Integration schneller Dateiübertragungen in iOS- und Android-Apps. FileCatalyst bietet eine native Objective-C-API für iOS und eine Java-API für Android Dalvik. Die FileCatalyst-App wurde mit diesen mobilen APIs erstellt und ist auch für Android und iOS in den jeweiligen App Stores verfügbar.

Objekt-C-Beispiel

In die Zwischenablage kopieren

// // FCAViewController.m // Beispiel // // Copyright (c) 2012 Unlimi-Tech Software Inc.  Alle Rechte vorbehalten.
 // // Mit diesem Beispielcode wird eine Datei mit dem Namen // "nature-qc-320-320-7.jpg" (im SDK enthalten) hochgeladen und anschließend heruntergeladen. #Import "FCAViewController.h" #import "NSString + FCAUtils. h "@interface FCAViewController () @property (stark, nichtatomar) FCAControl * control; @end @implementation FCAViewController @synthesize connectionStatusLabel; @synthesize connectionDetailLabel; @synthesize transferStatusLabel; @synthesize transferDetailLabel; @synthesize cancelButton; @synthesize downloadButton; @synthesize uploadButton; @synthesize connectButton; @synthesize Kontrolle; - (void) reportError: (NSError *) error {if (! error) return; UIAlertView * alert = [[UIAlertView alloc] initWithTitle: @ "Error" Nachricht: error.localizedDescription Delegat: nil cancelButtonTitle: @ "OK" otherButtonTitles: nil]; [alert show]; } // Grundlegender Dateiupload.  Die Steuerinstanz hat eine eigene private Arbeitswarteschlange, auf der alle Befehle (außer cancelTransfer) // ausgeführt werden müssen.  Zu diesem Zweck gibt es zwei Hilfsmethoden: performBlock: completion: und performBlockAndWait: // Wenn ein Befehl im Block fehlschlägt, wird er in der an den Beendigungsblock // übergebenen NSError-Instanz gemeldet oder vom Aufruf performBlockAndWait: zurückgegeben .
 - (IBAction) uploadAction: (id) Absender {[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) {// dieser Rückruf wird in der Hauptwarteschlange aufgerufen self.transferStatusLabel.text = filename; self.cancelButton.hidden = NO; NSLog (@ "transfer has started"); } transferCompleted: ^ (FCAFileTransferStats * stats) {// dieser Rückruf wird in der Hauptwarteschlange NSLog aufgerufen (@ "transfer has completed"); self.transferStatusLabel.text = [NSString stringWithFormat: @ "% @ finished", Dateiname]; self.cancelButton.hidden = YES; }]; } Vervollständigung: ^ (NSError * error) {[self reportError: error]; [self.uploadButton setTitle: @ "Test Upload" forState: UIControlStateNormal]; self.uploadButton.enabled = YES; }]; } - (IBAction) downloadAction: (UIButton *) Absender {[self.downloadButton setTitle: @ "Downloading ..."  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; }]; } Vervollständigung: ^ (NSError * error) {[self reportError: error]; [self.downloadButton setTitle: @ "Test Download" forState: UIControlStateNormal]; self.downloadButton.enabled = YES; }]; } // Diese Methode zeigt, wie die nicht blockierenden Verbindungs- / Trennungsanrufe verwendet werden - (IBAction) connectAction: (UIButton *) sender {if ([self.control isConnected]) {sender.enabled = NO; [sender setTitle: @ "Verbindung wird getrennt ..."  forState: UIControlStateNormal]; [self.control performBlock: ^ {[self.control disconnect]; } Vervollständigung: ^ (NSError * Fehler) {sender.enabled = YES; [self reportError: error]; }]; } else {sender.enabled = NO; [sender setTitle: @ "Connecting ..."  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 - Diese API bietet die vollständige Kontrolle über jede HotFolder-Instanz. Es werden Methoden verfügbar gemacht, mit denen Sie neue Überwachungsordner und Websites hinzufügen sowie Aufgaben erstellen, bearbeiten und ausführen können.

TransferAgent (JavaScript- und REST-API) - Ermöglicht die enge Integration von FileCatalyst in jede Webanwendung. Webanwendungen, die TransferAgent verwenden, können auf lokale Dateisysteme zugreifen / diese durchsuchen, Dateien zu einer Warteschlange hinzufügen und Dateiübertragungen über JavaScript oder direkt über REST-Aufrufe initiieren oder überwachen.

Zentrale REST-API - Bietet vollständigen Zugriff auf Berichtsdaten für alle verbundenen Knoten. Die API fungiert auch als Reverse-HTTP-Proxy für den Zugriff auf die REST-APIs einzelner verbundener Knoten wie Server, HotFolder und TransferAgent.

Befehlszeilentools (CLIs) - Bietet Schnittstellen, mit denen Sie Dateien über eine Befehlszeilenkonsole übertragen können, um eine einfache Skripterfahrung zu ermöglichen. Diese Tools sind sowohl in JAVA als auch in C ++ verfügbar und können in vorhandene Shell-Skripte integriert werden, die derzeit FTP, SCP oder rsync verwenden.