メイン コンテンツにスキップ

スタンドアロン

概要 - スタンドアロン​

スタンドアロンのファイルサマリーは、com.glasswall.analysissummary.FileSummary オブジェクトを作成することで生成できます。

API​

コンストラクター​

public FileSummary(
    Path inputFilePath,
    int sessionStatus,
    String lastErrorMessage,
    String processMessage,
    InputStream analysisInputStream,
    boolean skipUnsupportedFileTypes
) throws SAXException, ParserConfigurationException, IOException

パラメーター:

  • Path inputFilePath - 処理されたファイルのファイルパス。
  • int sessionStatus - GW2RunSession からの戻りステータス。
  • String lastErrorMessage - GW2FileErrorMsg からのエラーメッセージです。これが null または空の場合、サマリーには含まれません。
  • String processMessage - GW2FileSessionStatus からのプロセスメッセージです。これが null または空の場合、サマリーには含まれません。
  • InputStream analysisInputStream - 含める分析レポートを含む入力ストリーム。
  • boolean skipUnsupportedFileTypes - サポートされていないファイルタイプをスキップするかどうかを示す boolean 値です。

インスタンスメソッド​

public String getFileName()

処理されたファイルのファイル名を返します。

Returns: 処理されたファイルの絶対ファイルパス。

public String getProcessMessage()

ファイルセッションのプロセスメッセージを返します。プロセスメッセージが指定されていない場合、これは null になります。

Returns: ファイルセッションのプロセスメッセージ。

public EngineOutcome getEngineOutcome()

Returns an EngineOutcome enum indicating whether the processed file was Managed, NonConforming, or Unsupported.

戻り値: EngineOutcome enum。

public String getErrorMessage()

ファイルが non-conforming の場合は、エラーメッセージを返します。ファイルが managed の場合、これは null になります。

戻り値: エラーメッセージ。

public Map<String, Long> getSanitisedItems()

サニタイズされた項目とその件数のマップを返します。

戻り値: サニタイズされた項目とその件数のマップ。

public Map<String, Long> getAllowedItems()

許可された項目とその件数のマップを返します。

戻り値: 許可された項目とその件数のマップ。

public Map<String, Long> getRemedyItems()

修復項目とその件数のマップを返します。

戻り値: 修復項目とその件数のマップ。

API の例​

File input_directory = new File("Input");
File output_directory = new File("Output");

output_directory.mkdirs();

for (File file : input_directory.listFiles())
{
    if (file.isDirectory())
        continue;

    try (Core2JavaBridge gw = new Core2JavaBridge())
    {
        // Create the output path for file and analysis report
        String file_output_path = Paths.get(output_directory.getAbsolutePath().toString(), file.getName()).toString();
        String analysis_output_path = file_output_path + ".xml";

        // Run the file through the Glasswall engine
        int session = gw.GW2OpenSession();
        gw.GW2RegisterInputFile(session, file.getAbsolutePath());
        gw.GW2RegisterAnalysisFile(session, analysis_output_path, 0);
        gw.GW2RegisterOutFile(session, file_output_path);
        int run_status = gw.GW2RunSession(session);

        // Retrieve the error message if the file is non-conforming
        String error_message = null;

        if (run_status < 0)
            error_message = gw.GW2FileErrorMsgString(session);

        // Retrieve the session status along with the session description
        FileSessionStatus session_status = gw.GW2FileSessionStatusResult(session);

        // Create a file summary
        try (FileInputStream stream = new FileInputStream(analysis_output_path))
        {
            FileSummary file_summary = new FileSummary(
                file.toPath(),
                run_status,
                error_message,
                session_status.summaryDescription,
                stream,
                true // true to skip unsupported file types
            );
            
            // TODO - do something with the file summary
        }
    }
    catch (Exception ex)
    {
        System.err.println("Exception occurred: " + ex.getMessage());
    }
}
最終更新日: