Java API reference

AMaasClient class is the main class of the SDK and provides methods to use the AMaaS scanning services.

Create a new instance of the AmaasClient class and provision essential settings including authentication/authorization credentials (API key), for example the preferred service region.

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

Return An AMaaS Client instance.

Create a new instance of the AmaasClient class, and provisions essential settings, including authentication/authorization credentials (API key), preferred service region, etc. The enabledTLS is default to true.

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

Return An AMaasClient instance

Scan a file for malware and retrieves response data from the API.

public String scanFile(string fileName) throws AMaasException

Return String the scanned result in JSON format.

Scan a buffer for malware and retrieves response data from the API.

ReturnString the scanned result in JSON format.

The AmaasScanResult has the data elements of the response data that is retrieved from the Trend Vision One™ API. The class has the following private members. Each of the members have getter and setter methods.

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.
}

The MalwareItem contains a detected malware information in the response data that is retrieved from our API. The class has the following private members. There are getter and setter methods for each of the members.

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.
}

The AMaasException class is the AMaaS SDK exception class.

public final class AMaasException extends Exception {
  private AMaasErrorCode erroCode;

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

AMaasErrorCode is a enum type containing all the error conditions thrown by the AMaasException class.

Both scanFile() and scanBuffer() are designed to be thread-safe. They should be able to invoke scanFile() concurrently from multiple threads without protecting scanFile() with mutex or other synchronization mechanisms.