com.smartdevicelink.managers.lifecycle

Class LifecycleManager

java.lang.Object

com.smartdevicelink.managers.lifecycle.LifecycleManager

public class LifecycleManager
extends Object

The lifecycle manager creates a central point for all SDL session logic to converge. It should only be used by the library itself. Usage outside the library is not permitted and will not be protected for in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.AppConfig
static interface	com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.LifecycleListener

Field Summary

Fields

Modifier and Type	Field and Description
static Version	MAX_SUPPORTED_RPC_VERSION

Constructor Summary

Constructors

Constructor and Description
LifecycleManager(com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.AppConfig appConfig, BaseTransportConfig config, com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.LifecycleListener listener)

Method Summary

Modifier and Type	Method and Description
String	getAuthToken() Retrieves the auth token, if any, that was attached to the StartServiceACK for the RPC service from the module.
OnHMIStatus	getCurrentHMIStatus() Get the current OnHMIStatus
ISdl	getInternalInterface(SdlManager sdlManager) This method is used to ensure all of the methods in this class can remain private and no grantees can be made to the developer what methods are available or not.
RegisterAppInterfaceResponse	getRegisterAppInterfaceResponse() Method to retrieve the RegisterAppInterface Response message that was sent back from the module.
SystemCapabilityManager	getSystemCapabilityManager(SdlManager sdlManager) This method is used to ensure all of the methods in this class can remain private and no grantees can be made to the developer what methods are available or not.
void	setContext(Context context)
void	setSdlSecurity(List<Class<? extends SdlSecurityBase>> secList, ServiceEncryptionListener listener) Sets the security libraries and a callback to notify caller when there is update to encryption service
void	start()
void	startRPCEncryption() Start a secured RPC service
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SUPPORTED_RPC_VERSION

public static final Version MAX_SUPPORTED_RPC_VERSION

Constructor Detail

LifecycleManager

public LifecycleManager(com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.AppConfig appConfig,
                        BaseTransportConfig config,
                        com.smartdevicelink.managers.lifecycle.BaseLifecycleManager.LifecycleListener listener)

Method Detail

setContext

public void setContext(Context context)

start

public void start()

startRPCEncryption

public void startRPCEncryption()

Start a secured RPC service

stop

public void stop()

getSystemCapabilityManager

public SystemCapabilityManager getSystemCapabilityManager(SdlManager sdlManager)

This method is used to ensure all of the methods in this class can remain private and no grantees can be made to the developer what methods are available or not. NOTE: THERE IS NO GUARANTEE THIS WILL BE A VALID SYSTEM CAPABILITY MANAGER

Parameters:

sdlManager - this must be a working manager instance

Returns:

the system capability manager.

getRegisterAppInterfaceResponse

public RegisterAppInterfaceResponse getRegisterAppInterfaceResponse()

Method to retrieve the RegisterAppInterface Response message that was sent back from the module. It contains various attributes about the connected module and can be used to adapt to different module types and their supported features.

Returns:

RegisterAppInterfaceResponse received from the module or null if the app has not yet registered with the module.

getCurrentHMIStatus

public OnHMIStatus getCurrentHMIStatus()

Get the current OnHMIStatus

Returns:

OnHMIStatus object represents the current OnHMIStatus

getInternalInterface

public ISdl getInternalInterface(SdlManager sdlManager)

This method is used to ensure all of the methods in this class can remain private and no grantees can be made to the developer what methods are available or not.

Parameters:

sdlManager - this must be a working manager instance

Returns:

the internal interface that hooks into this manager

getAuthToken

public String getAuthToken()

Retrieves the auth token, if any, that was attached to the StartServiceACK for the RPC service from the module. For example, this should be used to login to a user account.

Returns:

the string representation of the auth token

setSdlSecurity

public void setSdlSecurity(@NonNull
                           List<Class<? extends SdlSecurityBase>> secList,
                           ServiceEncryptionListener listener)

Sets the security libraries and a callback to notify caller when there is update to encryption service

Parameters:

secList - The list of security class(es)

listener - The callback object