org.aerogear.mobile.security

Class SecurityService

java.lang.Object

org.aerogear.mobile.security.SecurityService

All Implemented Interfaces:

org.aerogear.mobile.core.ServiceModule

public class SecurityService
extends java.lang.Object
implements org.aerogear.mobile.core.ServiceModule

Service for running security checks in an application. Security checks can be run individually using check(SecurityCheckType). Security checks can also be chained together to execute security checks synchronously or asynchronously. Invoking getCheckExecutor() will return a SyncSecurityCheckExecutor where security checks can be executed synchronously. Invoking getAsyncCheckExecutor() will return AsyncSecurityCheckExecutor where security checks can be executed asynchronously.

Constructor Summary

Constructors

Constructor and Description
SecurityService()

Method Summary

Modifier and Type	Method and Description
SecurityCheckResult	check(SecurityCheck securityCheck) Used with a custom check to perform a single SecurityCheck and get the result for it.
SecurityCheckResult	check(SecurityCheckType securityCheckType) Used with enumeration to perform a single SecurityCheckType and get the result for it.
SecurityCheckResult	checkAndSendMetric(SecurityCheck securityCheck, org.aerogear.mobile.core.metrics.MetricsService metricsService) Perform a single SecurityCheck and return a SecurityCheckResult.
SecurityCheckResult	checkAndSendMetric(SecurityCheckType securityCheckType, org.aerogear.mobile.core.metrics.MetricsService metricsService) Perform a single SecurityCheckType , get the result and publish a SecurityCheckResultMetric based on the result.
void	configure(org.aerogear.mobile.core.MobileCore core, org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration) Configures the security service.
void	destroy() Invoked when security service needs to be destroyed.
AsyncSecurityCheckExecutor	getAsyncCheckExecutor() Retrieve a check executor that can asynchronously run multiple security checks.
SyncSecurityCheckExecutor	getCheckExecutor() Retrieve a check executor that can synchronously run multiple security checks.
boolean	requiresConfiguration() Checks if the service requires a service configuration.
java.lang.String	type() Gets the service type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityService

public SecurityService()

Method Detail

type

public java.lang.String type()

Gets the service type.

Specified by:

type in interface org.aerogear.mobile.core.ServiceModule

Returns:

String

configure

public void configure(@NonNull
                      org.aerogear.mobile.core.MobileCore core,
                      @Nullable
                      org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration)

Configures the security service.

Specified by:

configure in interface org.aerogear.mobile.core.ServiceModule

Parameters:

core - MobileCore instance

serviceConfiguration - ServiceConfiguration for the security service. Can be null

requiresConfiguration

public boolean requiresConfiguration()

Checks if the service requires a service configuration. This service does not require a service configuration.

Specified by:

requiresConfiguration in interface org.aerogear.mobile.core.ServiceModule

Returns:

false

destroy

public void destroy()

Invoked when security service needs to be destroyed.

Specified by:

destroy in interface org.aerogear.mobile.core.ServiceModule

getCheckExecutor

public SyncSecurityCheckExecutor getCheckExecutor()

Retrieve a check executor that can synchronously run multiple security checks.

Returns:

SyncSecurityCheckExecutor

getAsyncCheckExecutor

public AsyncSecurityCheckExecutor getAsyncCheckExecutor()

Retrieve a check executor that can asynchronously run multiple security checks.

Returns:

AsyncSecurityCheckExecutor

check

public SecurityCheckResult check(@NonNull
                                 SecurityCheckType securityCheckType)

Used with enumeration to perform a single SecurityCheckType and get the result for it.

Parameters:

securityCheckType - The SecurityCheckType to execute

Returns:

SecurityCheckResult

Throws:

java.lang.IllegalArgumentException - if securityCheckType is null

check

public SecurityCheckResult check(@NonNull
                                 SecurityCheck securityCheck)

Used with a custom check to perform a single SecurityCheck and get the result for it.

Parameters:

securityCheck - The SecurityCheck to execute

Returns:

SecurityCheckResult

Throws:

java.lang.IllegalArgumentException - if securityCheck is null

checkAndSendMetric

public SecurityCheckResult checkAndSendMetric(SecurityCheckType securityCheckType,
                                              org.aerogear.mobile.core.metrics.MetricsService metricsService)

Perform a single SecurityCheckType , get the result and publish a SecurityCheckResultMetric based on the result.

Parameters:

securityCheckType - The SecurityCheckType to execute

metricsService - MetricsService

Returns:

SecurityCheckResult

checkAndSendMetric

public SecurityCheckResult checkAndSendMetric(SecurityCheck securityCheck,
                                              @NonNull
                                              org.aerogear.mobile.core.metrics.MetricsService metricsService)

Perform a single SecurityCheck and return a SecurityCheckResult.

Parameters:

securityCheck - The SecurityCheck to execute

metricsService - MetricsService

Returns:

SecurityCheckResult

Throws:

java.lang.IllegalArgumentException - if metricsService is null