Package africa.absa.inception.reporting

Class ReportingService

java.lang.Object

africa.absa.inception.reporting.ReportingService

All Implemented Interfaces:

IReportingService

@Service
public class ReportingService
extends Object
implements IReportingService

The ReportingService class provides the Reporting Service implementation.

Author:

Marcus Portmann

Field Summary

Fields inherited from interface africa.absa.inception.reporting.IReportingService

SYSTEM_USERNAME

Constructor Summary

Constructors

Constructor	Description
ReportingService(javax.validation.Validator validator, DataSource dataSource, ReportDefinitionRepository reportDefinitionRepository, ReportDefinitionSummaryRepository reportDefinitionSummaryRepository)	Constructs a new ReportingService.

Method Summary

Modifier and Type	Method	Description
void	createReportDefinition(ReportDefinition reportDefinition)	Create the new report definition.
byte[]	createReportPDF(String reportDefinitionId, Map<String,Object> parameters)	Create the PDF for the report using a connection retrieved from the application data source.
byte[]	createReportPDF(String reportDefinitionId, Map<String,Object> parameters, Connection connection)	Create the PDF for the report.
byte[]	createReportPDF(String reportDefinitionId, Map<String,Object> parameters, Document document)	Create the PDF for the report.
void	deleteReportDefinition(String reportDefinitionId)	Delete the existing report definition.
String	getLocalReportFolderPath()	Returns the real path to the folder where the local Jasper reports are stored.
ReportDefinition	getReportDefinition(String reportDefinitionId)	Retrieve the report definition.
String	getReportDefinitionName(String reportDefinitionId)	Retrieve the name of the report definition.
List<ReportDefinition>	getReportDefinitions()	Returns all the report definitions.
List<ReportDefinitionSummary>	getReportDefinitionSummaries()	Returns the summaries for all the report definitions.
ReportDefinitionSummary	getReportDefinitionSummary(String reportDefinitionId)	Retrieve the summary for the report definition.
boolean	reportDefinitionExists(String reportDefinitionId)	Check whether the report definition exists.
void	setLocalReportFolderPath(String localReportFolderPath)	Set the real path to the folder where the local Jasper reports are stored.
void	updateReportDefinition(ReportDefinition reportDefinition)	Update the report definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportingService

public ReportingService(javax.validation.Validator validator,
                        @Qualifier("applicationDataSource")
                        DataSource dataSource,
                        ReportDefinitionRepository reportDefinitionRepository,
                        ReportDefinitionSummaryRepository reportDefinitionSummaryRepository)

Constructs a new ReportingService.

Parameters:

validator - the JSR-303 validator

dataSource - the data source used to provide connections to the application database

reportDefinitionRepository - the Report Definition Repository

reportDefinitionSummaryRepository - the Report Definition Summary Repository

Method Detail

createReportDefinition

@Transactional
public void createReportDefinition(ReportDefinition reportDefinition)
                            throws InvalidArgumentException,
                                   DuplicateReportDefinitionException,
                                   ServiceUnavailableException

Description copied from interface: IReportingService

Create the new report definition.

Specified by:

createReportDefinition in interface IReportingService

Parameters:

reportDefinition - the ReportDefinition instance containing the information for the new report definition

Throws:

InvalidArgumentException - if an argument is invalid

DuplicateReportDefinitionException - if the report definition already exists

ServiceUnavailableException - if the report definition could not be created

createReportPDF

public byte[] createReportPDF(String reportDefinitionId,
                              Map<String,Object> parameters)
                       throws InvalidArgumentException,
                              ReportDefinitionNotFoundException,
                              ServiceUnavailableException

Description copied from interface: IReportingService

Create the PDF for the report using a connection retrieved from the application data source.

Specified by:

createReportPDF in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

parameters - the parameters for the report

Returns:

the PDF data for the report

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the report definition could not be created

createReportPDF

public byte[] createReportPDF(String reportDefinitionId,
                              Map<String,Object> parameters,
                              Connection connection)
                       throws InvalidArgumentException,
                              ReportDefinitionNotFoundException,
                              ServiceUnavailableException

Description copied from interface: IReportingService

Create the PDF for the report.

Specified by:

createReportPDF in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

parameters - the parameters for the report

connection - the database connection used to retrieve the report data

Returns:

the PDF data for the report

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the PDF for the report could not be created

createReportPDF

public byte[] createReportPDF(String reportDefinitionId,
                              Map<String,Object> parameters,
                              Document document)
                       throws InvalidArgumentException,
                              ReportDefinitionNotFoundException,
                              ServiceUnavailableException

Description copied from interface: IReportingService

Create the PDF for the report.

Specified by:

createReportPDF in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

parameters - the parameters for the report

document - the XML document containing the report data

Returns:

the PDF data for the report

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the PDF for the report could not be created

deleteReportDefinition

@Transactional
public void deleteReportDefinition(String reportDefinitionId)
                            throws InvalidArgumentException,
                                   ReportDefinitionNotFoundException,
                                   ServiceUnavailableException

Description copied from interface: IReportingService

Delete the existing report definition.

Specified by:

deleteReportDefinition in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the report definition could not be deleted

getLocalReportFolderPath

public String getLocalReportFolderPath()

Description copied from interface: IReportingService

Returns the real path to the folder where the local Jasper reports are stored.

Specified by:

getLocalReportFolderPath in interface IReportingService

Returns:

the real path to the folder where the local Jasper reports are stored

getReportDefinition

public ReportDefinition getReportDefinition(String reportDefinitionId)
                                     throws InvalidArgumentException,
                                            ReportDefinitionNotFoundException,
                                            ServiceUnavailableException

Description copied from interface: IReportingService

Retrieve the report definition.

Specified by:

getReportDefinition in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

Returns:

the report definition

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the report definition could not be retrieved

getReportDefinitionName

public String getReportDefinitionName(String reportDefinitionId)
                               throws InvalidArgumentException,
                                      ReportDefinitionNotFoundException,
                                      ServiceUnavailableException

Description copied from interface: IReportingService

Retrieve the name of the report definition.

Specified by:

getReportDefinitionName in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

Returns:

the name of the report definition

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the name of the report definition could not be retrieved

getReportDefinitionSummaries

public List<ReportDefinitionSummary> getReportDefinitionSummaries()
                                                           throws ServiceUnavailableException

Description copied from interface: IReportingService

Returns the summaries for all the report definitions.

Specified by:

getReportDefinitionSummaries in interface IReportingService

Returns:

the summaries for all the report definitions

Throws:

ServiceUnavailableException - if the report definition summaries could not be retrieved

getReportDefinitionSummary

public ReportDefinitionSummary getReportDefinitionSummary(String reportDefinitionId)
                                                   throws InvalidArgumentException,
                                                          ReportDefinitionNotFoundException,
                                                          ServiceUnavailableException

Description copied from interface: IReportingService

Retrieve the summary for the report definition.

Specified by:

getReportDefinitionSummary in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

Returns:

the summary for the report definition

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the report definition summary could not be retrieved

getReportDefinitions

public List<ReportDefinition> getReportDefinitions()
                                            throws ServiceUnavailableException

Description copied from interface: IReportingService

Returns all the report definitions.

Specified by:

getReportDefinitions in interface IReportingService

Returns:

the report definitions

Throws:

ServiceUnavailableException - if the report definitions could not be retrieved

reportDefinitionExists

public boolean reportDefinitionExists(String reportDefinitionId)
                               throws InvalidArgumentException,
                                      ServiceUnavailableException

Description copied from interface: IReportingService

Check whether the report definition exists.

Specified by:

reportDefinitionExists in interface IReportingService

Parameters:

reportDefinitionId - the ID for the report definition

Returns:

true if the report definition exists or false otherwise

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the check for the existing report definition failed

setLocalReportFolderPath

public void setLocalReportFolderPath(String localReportFolderPath)

Description copied from interface: IReportingService

Set the real path to the folder where the local Jasper reports are stored.

Specified by:

setLocalReportFolderPath in interface IReportingService

Parameters:

localReportFolderPath - the real path to the folder where the local Jasper reports are stored

updateReportDefinition

@Transactional
public void updateReportDefinition(ReportDefinition reportDefinition)
                            throws InvalidArgumentException,
                                   ReportDefinitionNotFoundException,
                                   ServiceUnavailableException

Description copied from interface: IReportingService

Update the report definition.

Specified by:

updateReportDefinition in interface IReportingService

Parameters:

reportDefinition - the ReportDefinition instance containing the updated information for the report definition

Throws:

InvalidArgumentException - if an argument is invalid

ReportDefinitionNotFoundException - if the report definition could not be found

ServiceUnavailableException - if the report definition could not be updated