org.aerogear.mobile.security.metrics

Class SecurityCheckResultMetric

java.lang.Object

org.aerogear.mobile.security.metrics.SecurityCheckResultMetric

All Implemented Interfaces:

org.aerogear.mobile.core.metrics.Metrics<org.json.JSONArray>

public class SecurityCheckResultMetric
extends java.lang.Object
implements org.aerogear.mobile.core.metrics.Metrics<org.json.JSONArray>

Metric representation of SecurityCheckResult. This is intended to be used with the MetricsService.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENTIFIER
static java.lang.String	KEY_ID
static java.lang.String	KEY_NAME
static java.lang.String	KEY_VALUE

Constructor Summary

Constructors

Constructor and Description
SecurityCheckResultMetric(java.lang.Iterable<SecurityCheckResult> results) Creates a SecurityCheckResultMetric object.
SecurityCheckResultMetric(SecurityCheckResult... results) Creates a SecurityCheckResultMetric object.

Method Summary

Modifier and Type	Method and Description
org.json.JSONArray	data() Gets the data from the result which contains whether the check passed or not.
java.lang.String	identifier() Gets the name of the check performed.

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

KEY_ID

public static final java.lang.String KEY_ID

See Also:

Constant Field Values

KEY_NAME

public static final java.lang.String KEY_NAME

See Also:

Constant Field Values

KEY_VALUE

public static final java.lang.String KEY_VALUE

See Also:

Constant Field Values

Constructor Detail

SecurityCheckResultMetric

public SecurityCheckResultMetric(@NonNull
                                 java.lang.Iterable<SecurityCheckResult> results)

Creates a SecurityCheckResultMetric object.

Parameters:

results - the list of SecurityCheckResult of the tests executed

Throws:

java.lang.IllegalArgumentException - if result is null

SecurityCheckResultMetric

public SecurityCheckResultMetric(@NonNull
                                 SecurityCheckResult... results)

Creates a SecurityCheckResultMetric object.

Parameters:

results - the list of SecurityCheckResult of the tests executed

Throws:

java.lang.IllegalArgumentException - if result is null

Method Detail

identifier

public java.lang.String identifier()

Gets the name of the check performed.

Specified by:

identifier in interface org.aerogear.mobile.core.metrics.Metrics<org.json.JSONArray>

Returns:

String name of security check

data

public org.json.JSONArray data()

Gets the data from the result which contains whether the check passed or not.

Specified by:

data in interface org.aerogear.mobile.core.metrics.Metrics<org.json.JSONArray>

Returns:

JSONArray containing the results for self-defence checks