Java-API-Referenz

Die AMaasClient-Klasse ist die Hauptklasse des SDK und bietet Methoden zur Nutzung der AMaaS-Scan-Dienste.

Erstellen Sie eine neue Instanz der AmaasClient-Klasse und richten Sie die wesentlichen Einstellungen ein, einschließlich Authentifizierungs-/Autorisierungsanmeldeinformationen (API-Schlüssel), zum Beispiel die bevorzugte Dienstregion.

public AMaasClient (String region, String apikey, long timeoutInSecs, boolean enabledTLS) throw AMaasException

Gibt eine AMaaS-Client-Instanz zurück.

Erstellen Sie eine neue Instanz der AmaasClient-Klasse und richten Sie die wesentlichen Einstellungen ein, einschließlich Authentifizierungs-/Autorisierungsanmeldeinformationen (API-Schlüssel), bevorzugte Dienstregion usw. Der enabledTLS ist standardmäßig auf true gesetzt.

public AMaasClient(String region, String apiKey, long timeoutInSecs) throws AMaasException

Return Eine AMaasClient-Instanz

Eine Datei auf Malware durchsuchen und Antwortdaten von der API abrufen.

public String scanFile(string fileName) throws AMaasException

Return String das gescannte Ergebnis im JSON-Format.

Einen Puffer auf Malware durchsuchen und Antwortdaten von der API abrufen.

ReturnString das gescannte Ergebnis im JSON-Format.

Der AmaasScanResult enthält die Datenelemente der Antwortdaten, die von der Trend Vision One™ API abgerufen werden. Die Klasse hat die folgenden privaten Mitglieder. Jedes der Mitglieder verfügt über Getter- und Setter-Methoden.

public class AmaasScanResult {
  private String version;               // API version
  private int scanResult;               // Number of malwares found. A value of 0 means no malware was found
  private String scanId;                // ID of the scan
  private String scanTimestamp;         // Timestamp of the scan in ISO 8601 format
  private String fileName:              // Name of the file scanned
  private MalwareItem[] foundMalwares;  // A list of malware names and the filenames found by AMaaS

  // getter and seter methods for the above private variables.
}

Das MalwareItem enthält Informationen über erkannte Malware in den Antwortdaten, die von unserer API abgerufen werden. Die Klasse hat die folgenden privaten Mitglieder. Es gibt Getter- und Setter-Methoden für jedes der Mitglieder.

public class MalwareItem {
  private String malwareName;           // A detected Malware name
  private String fileName:              // File name that the malware is detected.

  // getter and seter methods for the above private variables.
}

Die AMaasException-Klasse ist die Ausnahme-Klasse des AMaaS SDK.

public final class AMaasException extends Exception {
  private AMaasErrorCode erroCode;

  public AMaasException(AMaasErrorCode erroCode, Object... params) {
    ...
  }
}

AMaasErrorCode ist ein Enum-Typ, der alle Fehlerbedingungen enthält, die von der AMaasException-Klasse ausgelöst werden.

Sowohl scanFile() als auch scanBuffer() sind darauf ausgelegt, threadsicher zu sein. Sie sollten in der Lage sein, scanFile() gleichzeitig aus mehreren Threads aufzurufen, ohne scanFile() mit einem Mutex oder anderen Synchronisationsmechanismen zu schützen.