com.smartdevicelink.transport

Class RouterServiceValidator

java.lang.Object

com.smartdevicelink.transport.RouterServiceValidator

public class RouterServiceValidator
extends Object

This class will tell us if the currently running router service is valid or not. To use this class simply create a new instance of RouterServiceValidator with a supplied context. After that, you have the option to set if you want to test in a production setting. If not, it will default to a debug setting. Once you are ready to check if the router service is trusted you simply call routerServiceValidator.validate();

This validator should be passed into the multiplexing transport construction as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouterServiceValidator.SdlApp Class that holds all the info we want to send/receive from the validation server
static class	RouterServiceValidator.TrustedAppStore
static interface	RouterServiceValidator.TrustedListCallback This interface is used as a callback to know when we have either obtained a list or at least returned from our attempt.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_DEBUG_INSTALLED_FROM_CHECK
static int	FLAG_DEBUG_NONE
static int	FLAG_DEBUG_PACKAGE_CHECK
static int	FLAG_DEBUG_PERFORM_ALL_CHECKS
static int	FLAG_DEBUG_USE_TIMESTAMP_CHECK
static int	FLAG_DEBUG_VERSION_CHECK This will flag the validator to check for app version during debugging.
static String	ROUTER_SERVICE_PACKAGE

Constructor Summary

Constructors

Constructor and Description
RouterServiceValidator(Context context)
RouterServiceValidator(Context context, ComponentName service)
RouterServiceValidator(MultiplexTransportConfig config)

Method Summary

Modifier and Type	Method and Description
protected static boolean	cacheSecurityLevel(Context context, int securityLevel)
ComponentName	componentNameForServiceRunning(PackageManager pm) This method will find which router service is running.
static boolean	createTrustedListRequest(Context context, boolean forceRefresh) Performs a look up against installed SDL apps that support the router service.
protected static boolean	createTrustedListRequest(Context context, boolean forceRefresh, HttpRequestTask.HttpRequestTaskCallback cb, RouterServiceValidator.TrustedListCallback listCallback)
static boolean	createTrustedListRequest(Context context, boolean forceRefresh, RouterServiceValidator.TrustedListCallback listCallback)
protected static String	getLastRequest(Context context) Gets the last request JSON object we sent to the RSVP server.
protected static long	getRefreshRate()
protected static int	getSecurityLevel(Context context)
ComponentName	getService()
protected static Long	getTrustedAppListTimeStamp(Context context) Retrieves the time stamp from the user's shared prefs.
protected static String	getTrustedList(Context context) Retrieves the list of available applications from user's shared prefs.
boolean	inDebugMode() This method will check to see if this app is a debug build.
static boolean	invalidateList(Context context)
protected boolean	isServiceRunning(Context context, ComponentName service) This method will determine if our supplied component name is really running.
void	setFlags(int flags) Use this method if you would like to test your app in a production setting rather than defaulting to a debug mode where you connect to whatever router service is running.
protected static boolean	setLastRequest(Context context, String request)
void	setSecurityLevel(int securityLevel)
protected static boolean	setTrustedList(Context context, String jsonString) Saves the list of available applications into user's shared prefs.
protected JSONObject	stringToJson(String json) Parses a string into a JSON array
void	validateAsync(com.smartdevicelink.transport.RouterServiceValidator.ValidationStatusCallback callback) Asynchronously validate the target RouterService, which includes finding the right RouterService.
protected boolean	verifyVersion(int version, JSONArray versions)
boolean	wasInstalledByAppStore(String packageName) Check to see if the app was installed from a trusted app store.

Methods inherited from class java.lang.Object

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

Field Detail

ROUTER_SERVICE_PACKAGE

public static final String ROUTER_SERVICE_PACKAGE

See Also:

Constant Field Values

FLAG_DEBUG_NONE

public static final int FLAG_DEBUG_NONE

See Also:

Constant Field Values

FLAG_DEBUG_PACKAGE_CHECK

public static final int FLAG_DEBUG_PACKAGE_CHECK

See Also:

Constant Field Values

FLAG_DEBUG_VERSION_CHECK

public static final int FLAG_DEBUG_VERSION_CHECK

This will flag the validator to check for app version during debugging.

NOTE: This flag will include a package check as well.

See Also:

Constant Field Values

FLAG_DEBUG_INSTALLED_FROM_CHECK

public static final int FLAG_DEBUG_INSTALLED_FROM_CHECK

See Also:

Constant Field Values

FLAG_DEBUG_USE_TIMESTAMP_CHECK

public static final int FLAG_DEBUG_USE_TIMESTAMP_CHECK

See Also:

Constant Field Values

FLAG_DEBUG_PERFORM_ALL_CHECKS

public static final int FLAG_DEBUG_PERFORM_ALL_CHECKS

See Also:

Constant Field Values

Constructor Detail

RouterServiceValidator

public RouterServiceValidator(Context context)

RouterServiceValidator

public RouterServiceValidator(Context context,
                              ComponentName service)

RouterServiceValidator

public RouterServiceValidator(@NonNull
                              MultiplexTransportConfig config)

Method Detail

validateAsync

public void validateAsync(com.smartdevicelink.transport.RouterServiceValidator.ValidationStatusCallback callback)

Asynchronously validate the target RouterService, which includes finding the right RouterService.

Parameters:

callback: - callback gets called when validation finishes.

getService

public ComponentName getService()

setFlags

public void setFlags(int flags)

Use this method if you would like to test your app in a production setting rather than defaulting to a debug mode where you connect to whatever router service is running.

These flags are only used in debugging mode. During production they will be ignored.

Parameters:

flags -

setSecurityLevel

public void setSecurityLevel(int securityLevel)

getRefreshRate

protected static long getRefreshRate()

componentNameForServiceRunning

public ComponentName componentNameForServiceRunning(PackageManager pm)

This method will find which router service is running. Use that info to find out more about that app and service. It will store the found service for later use and return the package name if found.

Parameters:

pm - An instance of a package manager. This is no longer used so null can be sent.

Returns:

wasInstalledByAppStore

public boolean wasInstalledByAppStore(String packageName)

Check to see if the app was installed from a trusted app store.

Parameters:

packageName - the package name of the app to be tested

Returns:

whether or not the app was installed from a trusted app store

inDebugMode

public boolean inDebugMode()

This method will check to see if this app is a debug build. If it is, we will attempt to connect to any router service. If false, it will only connect to approved apps with router services.

Returns:

verifyVersion

protected boolean verifyVersion(int version,
                                JSONArray versions)

createTrustedListRequest

public static boolean createTrustedListRequest(Context context,
                                               boolean forceRefresh)

Performs a look up against installed SDL apps that support the router service. When it receives a list back from the server it will store it for later use.

Parameters:

context -

createTrustedListRequest

public static boolean createTrustedListRequest(Context context,
                                               boolean forceRefresh,
                                               RouterServiceValidator.TrustedListCallback listCallback)

createTrustedListRequest

protected static boolean createTrustedListRequest(Context context,
                                                  boolean forceRefresh,
                                                  HttpRequestTask.HttpRequestTaskCallback cb,
                                                  RouterServiceValidator.TrustedListCallback listCallback)

isServiceRunning

protected boolean isServiceRunning(Context context,
                                   ComponentName service)

This method will determine if our supplied component name is really running.

Parameters:

context -

service -

Returns:

stringToJson

protected JSONObject stringToJson(String json)

Parses a string into a JSON array

Parameters:

json -

Returns:

invalidateList

public static boolean invalidateList(Context context)

setTrustedList

protected static boolean setTrustedList(Context context,
                                        String jsonString)

Saves the list of available applications into user's shared prefs.

Parameters:

context - The application's environment

jsonString - The JSON string to save.

getTrustedList

protected static String getTrustedList(Context context)

Retrieves the list of available applications from user's shared prefs.

Parameters:

context - The application's environment.

Returns:

The JSON string that was retrieved.

getTrustedAppListTimeStamp

protected static Long getTrustedAppListTimeStamp(Context context)

Retrieves the time stamp from the user's shared prefs.

Parameters:

context - The application's environment.

Returns:

The time stamp that was retrieved.

setLastRequest

protected static boolean setLastRequest(Context context,
                                        String request)

getLastRequest

protected static String getLastRequest(Context context)

Gets the last request JSON object we sent to the RSVP server. It basically contains a list of sdl enabled apps

Parameters:

context -

Returns:

cacheSecurityLevel

protected static boolean cacheSecurityLevel(Context context,
                                            int securityLevel)

getSecurityLevel

protected static int getSecurityLevel(Context context)