com.cultofbits.integrationm.service.actionpack

Class ReportmActionPack

java.lang.Object

com.cultofbits.integrationm.service.actionpack.ReportmActionPack

public class ReportmActionPack
extends Object

Action pack for interacting with ReportM.
The action pack should be configured in com.cultofbits.integrationm.service.properties file with the reportm key; for example:

  action.names=...,<reportm-ap-name>

  action.<reportm-ap-name>=reportm
  action.<reportm-ap-name>.reportm.base-url=<url form ReportM service> (Optional. Defaults to "http://localhost:40580" )
 

Recomended reportm-ap-name: reportm

In case <reportm-ap-name> is reportm, in the IntegrationM scripts, you can refer to it only by `reportm.generate(...)` otherwise you have to refer to it using `actionpacks.<reportm-ap-name>.generate(...)`

Constructor Summary

Constructors

Constructor and Description
ReportmActionPack(String url, com.cultofbits.integrationm.service.internal.security.UserCookiesGenerator userCookiesGenerator)

Method Summary

Modifier and Type	Method and Description
ReportmResponse	generate(String reportTemplatePath) Generates a report based on the specified report template path.
ReportmResponse	generate(String reportTemplatePath, Map<String,Object> arguments) Generates a report based on the specified report template path, with the provided arguments.
ReportmResponse	generate(String reportTemplatePath, Map<String,Object> arguments, String runAsUser) Generates a report based on the specified report template path, with the provided arguments, and optionally runs the operation as a different user.
ReportmResponse	generate(String reportTemplatePath, String runAsUser) Generates a report based on the specified report template path, and optionally runs the operation as a different user.
AsyncReportmResponse	generateAsync(String reportTemplatePath, Map<String,Object> arguments, Map<String,String> extracts, String callbackUri) Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.
AsyncReportmResponse	generateAsync(String reportTemplatePath, Map<String,Object> arguments, Map<String,String> extracts, String callbackUri, String runAsUser) Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.
AsyncReportmResponse	generateAsync(String reportTemplatePath, Map<String,Object> arguments, String callbackUri) Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.
AsyncReportmResponse	generateAsync(String reportTemplatePath, String callbackUri) Generates a report asynchronously based on the specified report template path and invokes the specified callback URI after the report is generated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportmActionPack

public ReportmActionPack(String url,
                         com.cultofbits.integrationm.service.internal.security.UserCookiesGenerator userCookiesGenerator)

Method Detail

generate

public ReportmResponse generate(@NotNull
                                String reportTemplatePath)

Generates a report based on the specified report template path.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

Returns:

a ReportmResponse object containing the result of the report generation operation. The response includes information about the success or failure of the operation, any error messages, and the generated report data if the operation was successful.

Throws:

IllegalArgumentException - if report template path is not provided

generate

public ReportmResponse generate(@NotNull
                                String reportTemplatePath,
                                Map<String,Object> arguments)

Generates a report based on the specified report template path, with the provided arguments.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

arguments - a Map containing the arguments to be passed to the report generation process.

Returns:

a ReportmResponse object containing the result of the report generation operation. The response includes information about the success or failure of the operation, any error messages, and the generated report data if the operation was successful.

Throws:

IllegalArgumentException - if report template path is not provided

generate

public ReportmResponse generate(@NotNull
                                String reportTemplatePath,
                                Map<String,Object> arguments,
                                String runAsUser)

Generates a report based on the specified report template path, with the provided arguments, and optionally runs the operation as a different user.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

arguments - a Map containing the arguments to be passed to the report generation process.

runAsUser - the username of the user running the operation, or null if not applicable.

Returns:

a ReportmResponse object containing the result of the report generation operation. The response includes information about the success or failure of the operation, any error messages, and the generated report data if the operation was successful.

Throws:

IllegalArgumentException - if report template path is not provided

generate

public ReportmResponse generate(@NotNull
                                String reportTemplatePath,
                                String runAsUser)

Generates a report based on the specified report template path, and optionally runs the operation as a different user.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

runAsUser - the username of the user running the operation, or null if not applicable.

Returns:

a ReportmResponse object containing the result of the report generation operation. The response includes information about the success or failure of the operation, any error messages, and the generated report data if the operation was successful.

Throws:

IllegalArgumentException - if report template path is not provided

generateAsync

public AsyncReportmResponse generateAsync(@NotNull
                                          String reportTemplatePath,
                                          Map<String,Object> arguments,
                                          Map<String,String> extracts,
                                          @NotNull
                                          String callbackUri)

Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

arguments - a Map containing the arguments to be passed to the report generation process.

extracts - A Map specifying the values to be extracted after the report has been generated. The keys represent the name of the extract name and the value a cell address.

callbackUri - the URI to be invoked after the report is generated.

Returns:

an AsyncReportmResponse object representing the asynchronous report generation operation. The response includes information about the success or failure of the operation and any error messages.

Throws:

IllegalArgumentException - if report template path is not provided

IllegalArgumentException - if callback uri is not provided

generateAsync

public AsyncReportmResponse generateAsync(@NotNull
                                          String reportTemplatePath,
                                          Map<String,Object> arguments,
                                          Map<String,String> extracts,
                                          @NotNull
                                          String callbackUri,
                                          String runAsUser)

Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

arguments - a Map containing the arguments to be passed to the report generation process.

extracts - A Map specifying the values to be extracted after the report has been generated. The keys represent the name of the extract name and the value a cell address.

callbackUri - the URI to be invoked after the report is generated.

runAsUser - the username of the user running the operation, or null if not applicable.

Returns:

an AsyncReportmResponse object representing the asynchronous report generation operation. The response includes information about the success or failure of the operation and any error messages.

Throws:

IllegalArgumentException - if report template path is not provided

IllegalArgumentException - if callback uri is not provided

generateAsync

public AsyncReportmResponse generateAsync(@NotNull
                                          String reportTemplatePath,
                                          Map<String,Object> arguments,
                                          @NotNull
                                          String callbackUri)

Generates a report asynchronously based on the specified report template path and arguments, and invokes the specified callback URI after the report is generated.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

arguments - a Map containing the arguments to be passed to the report generation process.

callbackUri - the URI to be invoked after the report is generated.

Returns:

an AsyncReportmResponse object representing the asynchronous report generation operation. The response includes information about the success or failure of the operation and any error messages.

Throws:

IllegalArgumentException - if report template path is not provided

IllegalArgumentException - if callback uri is not provided

generateAsync

public AsyncReportmResponse generateAsync(@NotNull
                                          String reportTemplatePath,
                                          @NotNull
                                          String callbackUri)

Generates a report asynchronously based on the specified report template path and invokes the specified callback URI after the report is generated.

Parameters:

reportTemplatePath - the path of the report template to be used for generating the report.

callbackUri - the URI to be invoked after the report is generated.

Returns:

an AsyncReportmResponse object representing the asynchronous report generation operation. The response includes information about the success or failure of the operation and any error messages.

Throws:

IllegalArgumentException - if report template path is not provided

IllegalArgumentException - if callback uri is not provided