Java APIリファレンス

ビュー:

Trend Vision One用Java SDKのAPIリファレンス™ファイルセキュリティ

AMaasClient

AMaasClientクラスはSDKのメインクラスで、AMaaS検索サービスを使用するためのメソッドを提供します。

の新しいインスタンスを作成します。 AmaasClient優先サービス地域など、認証/認可認証情報(APIキー) を含む重要な設定をクラスおよびプロビジョニングします。

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

AMaaSクライアントのインスタンスパラメータ

パラメータ	説明
地域	APIキーに対応するリージョン。指定する値は、次のいずれかのTrend Vision Oneリージョンである必要があります。 `ap-northeast-1` `ap-south-1` `ap-southeast-1` `ap-southeast-2` `eu-central-1` `us-east-1`
APIキー	Trend Vision One APIキー。
timeoutInSecs	サーバ接続のキャンセルのタイムアウト (秒)。初期設定は0で、最大値は180秒です。
enabledTLS	TLSを有効または無効にします。 AMaaSサーバに接続するときは、TLSを常に有効にする必要があります。

返却 AMaaSクライアントのインスタンス。

インスタンスの作成

の新しいインスタンスを作成します。 AmaasClientクラスを設定し、認証/認可認証情報(APIキー)、優先サービスリージョンなどの重要な設定をプロビジョニングします。 enabledTLSは、初期設定でtrueに設定されています。

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

AMaasClientのインスタンスパラメータ

パラメータ	説明
地域	APIキーに対応するリージョン。指定する値は、次のいずれかのTrend Vision Oneリージョンである必要があります。 `ap-northeast-1` `ap-south-1` `ap-southeast-1` `ap-southeast-2` `eu-central-1` `us-east-1`
APIキー	Trend Vision One APIキー
timeoutInSecs	サーバへの接続をキャンセルするタイムアウト (秒)。初期設定は0秒で、最大値は180秒です。

[Return] AMaasClientインスタンス

ファイルの検索

ファイルの不正プログラムを検索し、APIから対応データを取得します。

public String scanFile(string fileName) throws AMaasException

パラメータ

パラメータ	説明
ファイル名	ファイルの名前と、検索するファイルを含むファイルディレクトリパス。

[戻る]JSON形式の検索結果の文字列。

スキャンバッファ

バッファで不正プログラムを検索し、APIから対応データを取得します。

[public String scanBuffer(byte[] buffer, String identifier) throws AMaasException]

パラメータ

パラメータ	説明
バッファ	検索するバイトバッファ
識別子	バッファを識別する一意の名前

[Return]JSON形式の検索結果の文字列。

AmaasScanResult

AmaasScanResultには、 Trend Vision Oneから取得された対応データのデータ要素が含まれます。™ API。このクラスには次のプライベートメンバがあります。各メンバには、getterメソッドとsetterメソッドがあります。

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

不正プログラム項目

MalwareItemには、APIから取得した対応データに検出された不正プログラム情報が含まれています。このクラスには次のプライベートメンバがあります。メンバーごとにgetterメソッドとsetterメソッドがあります。

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

AMaasException

AMaasExceptionクラスは、AMaaS SDKの例外クラスです。

public final class AMaasException extends Exception {
  private AMaasErrorCode erroCode;

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

AMaasErrorCode

AMaasErrorCodeは、 AMaasExceptionクラス。

エラー条件

列挙型	エラーメッセージテンプレート	説明
MSG_ID_ERR_INVALID_REGION	%s はサポートされているリージョンではありません。	AMaasClientコンストラクタに指定された地域コードは有効な地域ではありません。
MSG_ID_ERR_MISSING_AUTH	クライアントを使用するには、APIキーを指定する必要があります。	AMaasClientのコンストラクタに指定するAPIキーを空にすることはできません。 `null` 。
MSG_ID_ERR_KEY_AUTH_FAILED	認証されていません。 C1トークンまたはAPIキーが無効です。	APIキーが無効です。正しいTrend Vision One APIキーが使用されていることを確認してください。
MSG_ID_ERR_FILE_NOT_FOUND	ファイルを開けませんでした。そのようなディレクトリまたはファイル%sはありません。	指定されたファイルが見つかりません。ファイルが存在することを確認してください。
MSG_ID_ERR_FILE_NO_PERMISSION	ファイルを開けませんでした。%sを開く権限がありません。	ファイルアクセス権限に問題があります。 SDKにファイルに対する読み取り権限があることを確認してください。
MSG_ID_GRPC_ERROR	gRPCステータスコード%d, msg: %sを受信しました。	ステータスコード付きのgRPCエラーが報告されました。詳細については、 gRPCステータスコード。
MSG_ID_ERR_UNEXPECTED_INTERRUPT	予期しない割り込みが発生しました。	クライアントで予期しない割り込み信号を受信しました。

スレッドセーフ

scanFile() と scanBuffer() はどちらもスレッドセーフに設計されています。ミューテックスやその他の同期メカニズムで scanFile() を保護せずに、複数のスレッドから同時に scanFile() を呼び出せる必要があります。