org.aerogear.mobile.core.metrics

Class MetricsService

java.lang.Object

org.aerogear.mobile.core.metrics.MetricsService

All Implemented Interfaces:

ServiceModule

public class MetricsService
extends java.lang.Object
implements ServiceModule

Constructor Summary

Constructors

Constructor and Description
MetricsService()

Method Summary

Modifier and Type	Method and Description
void	configure(MobileCore core, ServiceConfiguration serviceConfiguration) A method how create/configure the singleThreadService
void	destroy() Called when singleThreadService destroyed
MetricsPublisher	getPublisher()
MetricsService	publish(Metrics... metrics) Send metrics
boolean	requiresConfiguration() Whether the singleThreadService module requires its singleThreadService configuration to be defined or if it can be null.
void	sendAppAndDeviceMetrics() Send default metrics
MetricsService	setPublisher(MetricsPublisher publisher)
java.lang.String	type() Type/name used in the mobile-singleThreadService.json

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsService

public MetricsService()

Method Detail

getPublisher

public MetricsPublisher getPublisher()

setPublisher

public MetricsService setPublisher(@NonNull
                                   MetricsPublisher publisher)

type

public java.lang.String type()

Description copied from interface: ServiceModule

Type/name used in the mobile-singleThreadService.json

Specified by:

type in interface ServiceModule

Returns:

return the type/name used to identify the singleThreadService config in the JSON file

configure

public void configure(@NonNull
                      MobileCore core,
                      @NonNull
                      ServiceConfiguration serviceConfiguration)

Description copied from interface: ServiceModule

A method how create/configure the singleThreadService

Specified by:

configure in interface ServiceModule

Parameters:

core - MobileCore instance

serviceConfiguration - the configuration for the singleThreadService

requiresConfiguration

public boolean requiresConfiguration()

Description copied from interface: ServiceModule

Whether the singleThreadService module requires its singleThreadService configuration to be defined or if it can be null. If this is true then an exception will be thrown if singleThreadService configuration cannot be found.

Specified by:

requiresConfiguration in interface ServiceModule

Returns:

true if the singleThreadService configuration should be defined.

destroy

public void destroy()

Description copied from interface: ServiceModule

Called when singleThreadService destroyed

Specified by:

destroy in interface ServiceModule

sendAppAndDeviceMetrics

public void sendAppAndDeviceMetrics()

Send default metrics

publish

public MetricsService publish(Metrics... metrics)

Send metrics

Parameters:

metrics - Metrics to send

Returns:

this MetricsService instance