Package org.odpi.openmetadata.frameworks.integration.reports

Class IntegrationReportWriter

java.lang.Object

org.odpi.openmetadata.frameworks.integration.reports.IntegrationReportWriter

public class IntegrationReportWriter
extends Object

IntegrationReportWriter is responsible for managing the assembly and production of IntegrationReports. It offers methods to turn reporting on and off, define the time span (start capturing data/publish report) of a report; to record information that should be included in the report.

Constructor Summary

Constructors

Constructor	Description
IntegrationReportWriter(String serverName, String connectorId, String integrationConnectorGUID, String connectorName, String userId, OpenIntegrationClient openIntegrationClient)	Set up the integration report writer.

Method Summary

Modifier and Type	Method	Description
void	publishReport()	Assemble the data collected and write out a report (if configured).
void	reportElementCreation(String elementGUID)	Save information about a newly created element.
void	reportElementDelete(String elementGUID)	Save information about a newly archived or deleted element.
void	reportElementUpdate(String elementGUID)	Save information about a newly updated element.
void	setActiveReportPublishing(boolean flag)	Set whether an integration report should be assembled and published.
void	startRecording()	Set up properties ready for a new report.

Methods inherited from class java.lang.Object

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

Constructor Details

IntegrationReportWriter

public IntegrationReportWriter(String serverName,
 String connectorId,
 String integrationConnectorGUID,
 String connectorName,
 String userId,
 OpenIntegrationClient openIntegrationClient)

Set up the integration report writer.

Parameters:

serverName - name of this integration daemon

connectorId - identifier of this running integration connector instance

integrationConnectorGUID - identifier of the integration connector entity

connectorName - name of this integration connector

userId - calling user

openIntegrationClient - client used to publish reports.

Method Details

startRecording

public void startRecording()

Set up properties ready for a new report.

publishReport

public void publishReport()
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Assemble the data collected and write out a report (if configured).

Throws:

InvalidParameterException - an invalid property has been passed

UserNotAuthorizedException - the user is not authorized

PropertyServerException - there is a problem communicating with the metadata server (or it has a logic error).

setActiveReportPublishing

public void setActiveReportPublishing(boolean flag)

Set whether an integration report should be assembled and published.

Parameters:

flag - required behaviour

reportElementCreation

public void reportElementCreation(String elementGUID)

Save information about a newly created element.

Parameters:

elementGUID - unique identifier of the element

reportElementUpdate

public void reportElementUpdate(String elementGUID)

Save information about a newly updated element.

Parameters:

elementGUID - unique identifier of the element

reportElementDelete

public void reportElementDelete(String elementGUID)

Save information about a newly archived or deleted element.

Parameters:

elementGUID - unique identifier of the element