org.miloss.fgsms.services.rs.impl

Interface ReportGeneratorPlugin

public interface ReportGeneratorPlugin

This interface is a plugin type of interface for generating user facing reports based on their specifiied criteria, namely service policy URI, time range, and report type. The output is formatted HTML content. Implementations must be thread safe as instances can be shared across threads

Since:

7.1

Author:

AO

Method Summary

Methods

Modifier and Type	Method and Description
void	generateReport(OutputStreamWriter data, List<String> urls, String path, List<String> files, TimeRange range, String currentuser, SecurityWrapper classification, WebServiceContext ctx) Generates the content of the report Implementors must check access control urls using UserIdentityUtil prior to report generation.
List<PolicyType>	getAppliesTo() a list of all policy types that this report applies to
String	getDescription() a human readable description, it will be html encoded
String	getDisplayName() human friendly display name of the report type

Method Detail

getDisplayName

String getDisplayName()

human friendly display name of the report type

Returns:

getDescription

String getDescription()

a human readable description, it will be html encoded

Returns:

getAppliesTo

List<PolicyType> getAppliesTo()

a list of all policy types that this report applies to

Returns:

generateReport

void generateReport(OutputStreamWriter data,
                  List<String> urls,
                  String path,
                  List<String> files,
                  TimeRange range,
                  String currentuser,
                  SecurityWrapper classification,
                  WebServiceContext ctx)
                    throws IOException

Generates the content of the report Implementors must check access control urls using UserIdentityUtil prior to report generation. The expected behavior is to skip the url if the appropriate access is not granted to the requestor Use Utility#getPerformanceDBConnection() for database connections be sure to close all database records when done. See aksi {@link DBUtils}

Parameters:

data - write your html content here

urls - this the policy uris from which to generate reports from

path - this is the temporary output path, if creating charts, produce them here then add the filename to the files list

files - the list of files, these files are added to the report at completion

range - time range from which to generate the report

currentuser - the current user

classification - classification level

Throws:

IOException