com.smartdevicelink.transport

Class MultiplexTransportConfig

java.lang.Object

com.smartdevicelink.transport.BaseTransportConfig

com.smartdevicelink.transport.MultiplexTransportConfig

public class MultiplexTransportConfig
extends BaseTransportConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultiplexTransportConfig.TransportListener Callback to be used if the state of the transports needs to be monitored for any reason.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_MULTI_SECURITY_HIGH Multiplexing security will be very strict.
static int	FLAG_MULTI_SECURITY_LOW Multiplexing security will be minimal.
static int	FLAG_MULTI_SECURITY_MED Multiplexing security will be on at a normal level.
static int	FLAG_MULTI_SECURITY_OFF Multiplexing security will be turned off.

Fields inherited from class com.smartdevicelink.transport.BaseTransportConfig

iHeartBeatTimeout

Constructor Summary

Constructors

Constructor and Description
MultiplexTransportConfig(Context context, String appId)
MultiplexTransportConfig(Context context, String appId, int securityLevel)

Method Summary

Modifier and Type	Method and Description
Context	getContext() Gets the context attached to this config
List<TransportType>	getPrimaryTransports() Get the list of primary transports that are set to be accepted by this config
List<TransportType>	getSecondaryTransports() Get the list of secondary transports that are set to be accepted by this config
int	getSecurityLevel() Get the security level that will be used to verify a router service before binding
ComponentName	getService() Gets the ComponentName of the router service attached to this config
MultiplexTransportConfig.TransportListener	getTransportListener() Getter for the supplied transport listener
TransportType	getTransportType() Overridden abstract method which returns specific type of this transport configuration.
Boolean	requiresAudioSupport() Get the setting from this config to see whether the app should be treated as requiring an audio streaming output device
boolean	requiresHighBandwidth() Get the setting from this config to see whether the app should be treated as requiring a high bandwidth transport.
void	setPrimaryTransports(List<TransportType> transports) This will set the order in which a primary transport is determined to be accepted or not.
void	setRequiresAudioSupport(boolean requiresAudioSupport) Set whether or not this app requires the use of an audio streaming output device
void	setRequiresHighBandwidth(boolean requiresHighBandwidth) Set whether or not this app requires the use of a transport that supports high bandwidth services.
void	setSecondaryTransports(List<TransportType> transports) This will set the order in which a primary transport is determined to be accepted or not.
void	setSecurityLevel(int securityLevel) Sets the security level that should be used to verify a router service that is to be bound
void	setService(ComponentName service) Supplies the config with the router service that should be bound to
void	setTransportListener(MultiplexTransportConfig.TransportListener listener) Set a lister for transport events.

Methods inherited from class com.smartdevicelink.transport.BaseTransportConfig

getHeartBeatTimeout, setHeartBeatTimeout

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_MULTI_SECURITY_OFF

public static final int FLAG_MULTI_SECURITY_OFF

Multiplexing security will be turned off. All router services will be trusted.

See Also:

Constant Field Values

FLAG_MULTI_SECURITY_LOW

public static final int FLAG_MULTI_SECURITY_LOW

Multiplexing security will be minimal. Only trusted router services will be used. Trusted router list will be obtain from server. List will be refreshed every 30 days or during next connection session if an SDL enabled app has been installed or uninstalled.

See Also:

Constant Field Values

FLAG_MULTI_SECURITY_MED

public static final int FLAG_MULTI_SECURITY_MED

Multiplexing security will be on at a normal level. Only trusted router services will be used. Trusted router list will be obtain from server. List will be refreshed every 7 days or during next connection session if an SDL enabled app has been installed or uninstalled.

See Also:

Constant Field Values

FLAG_MULTI_SECURITY_HIGH

public static final int FLAG_MULTI_SECURITY_HIGH

Multiplexing security will be very strict. Only trusted router services installed from trusted app stores will be used. Trusted router list will be obtain from server. List will be refreshed every 7 days or during next connection session if an SDL enabled app has been installed or uninstalled.

See Also:

Constant Field Values

Constructor Detail

MultiplexTransportConfig

public MultiplexTransportConfig(Context context,
                                String appId)

MultiplexTransportConfig

public MultiplexTransportConfig(Context context,
                                String appId,
                                int securityLevel)

Method Detail

getTransportType

public TransportType getTransportType()

Overridden abstract method which returns specific type of this transport configuration.

Specified by:

getTransportType in class BaseTransportConfig

Returns:

Constant value TransportType.MULTIPLEX.

See Also:

TransportType

getContext

public Context getContext()

Gets the context attached to this config

Returns:

context supplied during creation

getService

public ComponentName getService()

Gets the ComponentName of the router service attached to this config

Returns:

ComponentName of the router service that will be bound to

setService

public void setService(ComponentName service)

Supplies the config with the router service that should be bound to

Parameters:

service - the router service that should be bound to

setSecurityLevel

public void setSecurityLevel(int securityLevel)

Sets the security level that should be used to verify a router service that is to be bound

Parameters:

securityLevel - the security level that will be used to perform certain tests

See Also:

FLAG_MULTI_SECURITY_OFF, FLAG_MULTI_SECURITY_LOW, FLAG_MULTI_SECURITY_MED, FLAG_MULTI_SECURITY_HIGH

getSecurityLevel

public int getSecurityLevel()

Get the security level that will be used to verify a router service before binding

Returns:

the set security level

See Also:

FLAG_MULTI_SECURITY_OFF, FLAG_MULTI_SECURITY_LOW, FLAG_MULTI_SECURITY_MED, FLAG_MULTI_SECURITY_HIGH

setRequiresHighBandwidth

public void setRequiresHighBandwidth(boolean requiresHighBandwidth)

Set whether or not this app requires the use of a transport that supports high bandwidth services. Common use is when an app uses the video/audio streaming services and there is no other integration that could be useful to the user.

For example:
1. If an app intends to perform audio or video streaming and does not wish to appear on the module when that isn't possible, a value of true should be sent.
2. If the same app wishes to appear on the module even when those services aren't available a value of true should be sent. In this case, the app could display a message prompting the user to "Please connect USB or Wifi" or it could have a separate integration like giving turn by turn directions in place of streaming the full navigation map.

Parameters:

requiresHighBandwidth - whether the app should be treated as requiring a high bandwidth transport.

requiresHighBandwidth

public boolean requiresHighBandwidth()

Get the setting from this config to see whether the app should be treated as requiring a high bandwidth transport.

Returns:

whether the app should be treated as requiring a high bandwidth transport.

setRequiresAudioSupport

public void setRequiresAudioSupport(boolean requiresAudioSupport)

Set whether or not this app requires the use of an audio streaming output device

Parameters:

requiresAudioSupport - whether the app should be treated as requiring an audio streaming output device

requiresAudioSupport

public Boolean requiresAudioSupport()

Get the setting from this config to see whether the app should be treated as requiring an audio streaming output device

Returns:

whether the app should be treated as requiring an audio streaming output device

setPrimaryTransports

public void setPrimaryTransports(List<TransportType> transports)

This will set the order in which a primary transport is determined to be accepted or not. In the case of previous protocol versions ( < 5.1)

Parameters:

transports - list of transports that can be used as primary

getPrimaryTransports

public List<TransportType> getPrimaryTransports()

Get the list of primary transports that are set to be accepted by this config

Returns:

acceptable primary transports

setSecondaryTransports

public void setSecondaryTransports(List<TransportType> transports)

This will set the order in which a primary transport is determined to be accepted or not. In the case of previous protocol versions ( < 5.1)

Parameters:

transports - list of transports that can be used as secondary

getSecondaryTransports

public List<TransportType> getSecondaryTransports()

Get the list of secondary transports that are set to be accepted by this config

Returns:

acceptable secondary transports

setTransportListener

public void setTransportListener(MultiplexTransportConfig.TransportListener listener)

Set a lister for transport events. Useful when connected high bandwidth services like audio or video streaming

Parameters:

listener - the TransportListener that will be called back when transport events happen

getTransportListener

public MultiplexTransportConfig.TransportListener getTransportListener()

Getter for the supplied transport listener

Returns:

the transport listener if any