org.miloss.fgsms.services.rs.impl.reports.ws

Class ThroughputByService

java.lang.Object

org.miloss.fgsms.services.rs.impl.reports.BaseReportGenerator

org.miloss.fgsms.services.rs.impl.reports.ws.BaseWebServiceReport

org.miloss.fgsms.services.rs.impl.reports.ws.ThroughputByService

All Implemented Interfaces:

PluginCommon, ReportGeneratorPlugin

public class ThroughputByService
extends BaseWebServiceReport

Author:

AO

Field Summary

Fields inherited from class org.miloss.fgsms.services.rs.impl.reports.BaseReportGenerator

allitems, format, log, name

Constructor Summary

Constructors

Constructor and Description
ThroughputByService()

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.
String	GetDisplayName() end user facing display name
String	GetHtmlFormattedHelp() returns html formatted help to guide users towards proper usage.

Methods inherited from class org.miloss.fgsms.services.rs.impl.reports.ws.BaseWebServiceReport

GetAppliesTo, getSoapActions

Methods inherited from class org.miloss.fgsms.services.rs.impl.reports.BaseReportGenerator

GetOptionalParameters, getPolicyDisplayName, GetRequiredParameters, isPolicyTypeOf

Methods inherited from class java.lang.Object

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

Constructor Detail

ThroughputByService

public ThroughputByService()

Method Detail

GetDisplayName

public String GetDisplayName()

end user facing display name

Returns:

GetHtmlFormattedHelp

public String GetHtmlFormattedHelp()

returns html formatted help to guide users towards proper usage. Always include the following fields

• Applies to - what policies types it applies to
• Required and optional parameters
• Description
• State if this is processed as data comes in, or periodically (some aggregated data)

Html is allowed, javascript is not

Specified by:

GetHtmlFormattedHelp in interface PluginCommon

Overrides:

GetHtmlFormattedHelp in class BaseWebServiceReport

Returns:

generateReport

public 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