org.miloss.fgsms.services.rs.impl

Class Reporting

java.lang.Object

org.miloss.fgsms.services.rs.impl.Reporting

All Implemented Interfaces:

ReportingService, OpStatusService

public class Reporting
extends Object
implements ReportingService, OpStatusService

The Reporting Service for fgsms Returns user selectable reports and csv files

Author:

AO

Field Summary

Fields

Modifier and Type	Field and Description
static String	allitems
protected static String	delimiter
static Logger	log
protected static String	name

Constructor Summary

Constructors

Constructor and Description
Reporting()
Reporting(WebServiceContext w) constructor used for unit testing, do not remove

Method Summary

Methods

Modifier and Type	Method and Description
ExportDataToCSVResponseMsg	exportDataToCSV(ExportCSVDataRequestMsg request) Exports transactions logs for a given set of services, requires audit level permissions or higher for each service requested service
ExportDataToHTMLResponseMsg	exportDataToHTML(ExportDataRequestMsg request) Creates an HTML report with charts for the selected services, time range, and report types in a zip file.
protected ExportDataToHTMLResponseMsg	generateHtmlReport(String currentUser, ExportDataRequestMsg request)
protected static byte[]	generateZipFileandDelete(List<String> files, String path)
protected SecurityWrapper	getClassLevelFromDB()
static String	getFilePathDelimitor()
protected String	getFooter()
protected String	getHeader()
GetOperatingStatusResponseMessage	getOperatingStatus(GetOperatingStatusRequestMessage request) Get the operating status of this service
static boolean	isPolicyTypeOf(String uri, PolicyType p)
static int	pixelHeightCalc(int items)
protected static String	readAllText(InputStream stream) input stream remains open after exiting
protected static String	stripCommas(String string)
protected static String	toSafeFileName(String url)
protected void	writeAllText(String filename, String text)

Methods inherited from class java.lang.Object

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

Field Detail

delimiter

protected static final String delimiter

See Also:

Constant Field Values

name

protected static final String name

See Also:

Constant Field Values

log

public static final Logger log

allitems

public static final String allitems

See Also:

Constant Field Values

Constructor Detail

Reporting

public Reporting()
          throws DatatypeConfigurationException

Throws:

DatatypeConfigurationException

Reporting

public Reporting(WebServiceContext w)
          throws DatatypeConfigurationException

constructor used for unit testing, do not remove

Parameters:

w -

Throws:

DatatypeConfigurationException

Method Detail

exportDataToHTML

@RequestWrapper(localName="ExportDataToHTML",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:reportingService",
                className="org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToHTML")
@ResponseWrapper(localName="ExportDataToHTMLResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:reportingService",
                 className="org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToHTMLResponse")
public ExportDataToHTMLResponseMsg exportDataToHTML(ExportDataRequestMsg request)
                                             throws AccessDeniedException,
                                                    ServiceUnavailableException

Description copied from interface: ReportingService

Creates an HTML report with charts for the selected services, time range, and report types in a zip file.

Specified by:

exportDataToHTML in interface ReportingService

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToHTMLResponseMsg

Throws:

ServiceUnavailableException

AccessDeniedException

generateHtmlReport

protected ExportDataToHTMLResponseMsg generateHtmlReport(String currentUser,
                                             ExportDataRequestMsg request)
                                                  throws AccessDeniedException,
                                                         ServiceUnavailableException

Throws:

AccessDeniedException

ServiceUnavailableException

getHeader

protected String getHeader()

getFooter

protected String getFooter()

readAllText

protected static String readAllText(InputStream stream)

input stream remains open after exiting

Parameters:

stream -

Returns:

writeAllText

protected void writeAllText(String filename,
                String text)

generateZipFileandDelete

protected static byte[] generateZipFileandDelete(List<String> files,
                              String path)

getClassLevelFromDB

protected SecurityWrapper getClassLevelFromDB()

pixelHeightCalc

public static int pixelHeightCalc(int items)

exportDataToCSV

@RequestWrapper(localName="ExportDataToCSV",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:reportingService",
                className="org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToCSV")
@ResponseWrapper(localName="ExportDataToCSVResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:reportingService",
                 className="org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToCSVResponse")
public ExportDataToCSVResponseMsg exportDataToCSV(ExportCSVDataRequestMsg request)
                                           throws ServiceUnavailableException

Exports transactions logs for a given set of services, requires audit level permissions or higher for each service requested service

Specified by:

exportDataToCSV in interface ReportingService

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.reportingservice.ExportDataToCSVResponseMsg

Throws:

AccessDeniedException

ServiceUnavailableException

getFilePathDelimitor

public static String getFilePathDelimitor()

isPolicyTypeOf

public static boolean isPolicyTypeOf(String uri,
                     PolicyType p)

toSafeFileName

protected static String toSafeFileName(String url)

stripCommas

protected static String stripCommas(String string)

getOperatingStatus

@RequestWrapper(localName="GetOperatingStatus",
                targetNamespace="urn:org:miloss:fgsms:services:interfaces:common",
                className="org.miloss.fgsms.services.interfaces.common.GetOperatingStatus")
@ResponseWrapper(localName="GetOperatingStatusResponse",
                 targetNamespace="urn:org:miloss:fgsms:services:interfaces:common",
                 className="org.miloss.fgsms.services.interfaces.common.GetOperatingStatusResponse")
public GetOperatingStatusResponseMessage getOperatingStatus(GetOperatingStatusRequestMessage request)

Get the operating status of this service

Specified by:

getOperatingStatus in interface OpStatusService

Parameters:

request -

Returns:

returns org.miloss.fgsms.services.interfaces.common.GetOperatingStatusResponseMessage