org.perfcake.reporting.reporter

Class GeolocationReporter

java.lang.Object

org.perfcake.reporting.reporter.AbstractReporter

org.perfcake.reporting.reporter.GeolocationReporter

All Implemented Interfaces:

Reporter

public class GeolocationReporter
extends AbstractReporter

Reports geolocation of PerfCake by its external IP address. Uses a 3rd party public REST API. Obtains the location just once and keeps it reporting. It does not make sense to configure this reporter to report more than once. As a bonus, it also reports iterations per second in the same way as IterationsPerSecondReporter does.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
GeolocationReporter()

Method Summary

Modifier and Type	Method and Description
String	getServiceUrl() Gets the URL of the service used to obtain the location.
void	publishResult(PeriodType periodType, Destination destination) Publishes results to the destination.
GeolocationReporter	setServiceUrl(String serviceUrl) Sets the URL of the service used to obtain the location.

Methods inherited from class org.perfcake.reporting.reporter.AbstractReporter

getDestinations, getReportingPeriods, newMeasurement, registerDestination, registerDestination, report, reset, setReportManager, setRunInfo, start, stop, unregisterDestination

Methods inherited from class java.lang.Object

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

Constructor Detail

GeolocationReporter

public GeolocationReporter()

Method Detail

publishResult

public void publishResult(PeriodType periodType,
                          Destination destination)
                   throws ReportingException

Description copied from interface: Reporter

Publishes results to the destination. This method is called only when the results should be published.

Parameters:

periodType - A period type that caused the invocation of this method.

destination - A destination to which the result should be reported.

Throws:

ReportingException - When it was not possible to publish results to the given destination.

getServiceUrl

public String getServiceUrl()

Gets the URL of the service used to obtain the location.

Returns:

The URL of the service used to obtain the location.

setServiceUrl

public GeolocationReporter setServiceUrl(String serviceUrl)

Sets the URL of the service used to obtain the location.

Parameters:

serviceUrl - The URL of the service used to obtain the location.

Returns:

Instance of this to support fluent API.