com.smartdevicelink.session

Class BaseSdlSession

java.lang.Object

com.smartdevicelink.session.BaseSdlSession

All Implemented Interfaces:

ISdlProtocol, ISecurityInitializedListener

Direct Known Subclasses:

SdlSession

public abstract class BaseSdlSession
extends Object
implements ISdlProtocol, ISecurityInitializedListener

Field Summary

Fields

Modifier and Type	Field and Description
protected VideoStreamingParameters	acceptedVideoParams
protected VideoStreamingParameters	desiredVideoParams
protected CopyOnWriteArrayList<SessionType>	encryptedServices
protected SdlProtocolBase	sdlProtocol
protected SdlSecurityBase	sdlSecurity
protected HashMap<SessionType,CopyOnWriteArrayList<ISdlServiceListener>>	serviceListeners
protected int	sessionId
protected ISdlSessionListener	sessionListener
protected BaseTransportConfig	transportConfig

Constructor Summary

Constructors

Constructor and Description
BaseSdlSession(ISdlSessionListener listener, BaseTransportConfig config)

Method Summary

Modifier and Type	Method and Description
void	addServiceListener(SessionType serviceType, ISdlServiceListener sdlServiceListener)
void	close()
void	endService(SessionType serviceType)
protected SystemInfo	extractSystemInfo(SdlPacket packet) Extracts the SystemInfo out of a packet
VideoStreamingParameters	getAcceptedVideoParams()
List<TransportRecord>	getActiveTransports() Retrieves list of the active transports
TransportType	getCurrentTransportType()
VideoStreamingParameters	getDesiredVideoParams() Returns the currently set desired video streaming parameters.
boolean	getIsConnected()
int	getMtu()
long	getMtu(SessionType type)
Version	getProtocolVersion() Get the current protocol version used by this session
protected abstract SdlProtocolBase	getSdlProtocolImplementation()
SdlSecurityBase	getSdlSecurity() A method that should be implemented by the hosting class of the SdlProtocol instance that will return the currently being used security library if any.
HashMap<SessionType,CopyOnWriteArrayList<ISdlServiceListener>>	getServiceListeners()
int	getSessionId() Method that the protocol layer will use to obtain the session ID
BaseTransportConfig	getTransportConfig()
boolean	isServiceProtected(SessionType sType)
boolean	isTransportForServiceAvailable(SessionType sessionType) Check to see if a transport is available to start/use the supplied service.
void	onAuthTokenReceived(String authToken) A callback to indicate the SDL connected device has supplied an authentication token to this application.
void	onProtocolError(String info, Exception e) Called to indicate that a protocol error was detected in received data.
void	onProtocolMessageReceived(ProtocolMessage msg) Called to indicate that a complete message (RPC, BULK, etc.) has been received.
void	onSecurityInitialized()
abstract void	onServiceEnded(SdlPacket packet, SessionType sessionType, int sessionID) This will get called when a service has ended
abstract void	onServiceError(SdlPacket packet, SessionType sessionType, int sessionID, String error) If there is an error with starting or stopping the service or any other error this method will be called.
abstract void	onServiceStarted(SdlPacket packet, SessionType sessionType, int sessionID, Version version, boolean isEncrypted) Called to indicate that a service has been started
void	onTransportDisconnected(String info, boolean altTransportAvailable, BaseTransportConfig transportConfig) Called when a transport disconnects
protected void	processControlService(ProtocolMessage msg)
boolean	removeServiceListener(SessionType serviceType, ISdlServiceListener sdlServiceListener)
void	sendMessage(ProtocolMessage msg)
void	setAcceptedVideoParams(VideoStreamingParameters params) A callback that will be called when the video service has been successfully started and the streaming parameters have been negotiated.
void	setDesiredVideoParams(VideoStreamingParameters params)
void	setSdlSecurity(SdlSecurityBase sec)
void	shutdown(String info) A request made by the protocol layer to shutdown the layers above it.
void	startService(SessionType serviceType, boolean isEncrypted)
void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

sdlProtocol

protected final SdlProtocolBase sdlProtocol

transportConfig

protected final BaseTransportConfig transportConfig

sessionListener

protected ISdlSessionListener sessionListener

sdlSecurity

protected SdlSecurityBase sdlSecurity

desiredVideoParams

protected VideoStreamingParameters desiredVideoParams

acceptedVideoParams

protected VideoStreamingParameters acceptedVideoParams

sessionId

protected int sessionId

serviceListeners

protected HashMap<SessionType,CopyOnWriteArrayList<ISdlServiceListener>> serviceListeners

encryptedServices

protected final CopyOnWriteArrayList<SessionType> encryptedServices

Constructor Detail

BaseSdlSession

public BaseSdlSession(ISdlSessionListener listener,
                      BaseTransportConfig config)

Method Detail

getSdlProtocolImplementation

protected abstract SdlProtocolBase getSdlProtocolImplementation()

getMtu

public int getMtu()

getMtu

public long getMtu(SessionType type)

close

public void close()

startService

public void startService(SessionType serviceType,
                         boolean isEncrypted)

endService

public void endService(SessionType serviceType)

startSession

public void startSession()
                  throws SdlException

Throws:

SdlException

sendMessage

public void sendMessage(ProtocolMessage msg)

getCurrentTransportType

public TransportType getCurrentTransportType()

getIsConnected

public boolean getIsConnected()

getProtocolVersion

public Version getProtocolVersion()

Get the current protocol version used by this session

Returns:

Version that represents the Protocol version being used

getTransportConfig

public BaseTransportConfig getTransportConfig()

setSdlSecurity

public void setSdlSecurity(SdlSecurityBase sec)

processControlService

protected void processControlService(ProtocolMessage msg)

extractSystemInfo

protected SystemInfo extractSystemInfo(SdlPacket packet)

Extracts the SystemInfo out of a packet

Parameters:

packet - should be a StartServiceACK for the RPC service

Returns:

an instance of SystemInfo if the information is available, null otherwise

isServiceProtected

public boolean isServiceProtected(SessionType sType)

addServiceListener

public void addServiceListener(SessionType serviceType,
                               ISdlServiceListener sdlServiceListener)

removeServiceListener

public boolean removeServiceListener(SessionType serviceType,
                                     ISdlServiceListener sdlServiceListener)

getServiceListeners

public HashMap<SessionType,CopyOnWriteArrayList<ISdlServiceListener>> getServiceListeners()

setDesiredVideoParams

public void setDesiredVideoParams(VideoStreamingParameters params)

getAcceptedVideoParams

public VideoStreamingParameters getAcceptedVideoParams()

onProtocolMessageReceived

public void onProtocolMessageReceived(ProtocolMessage msg)

Description copied from interface: ISdlProtocol

Called to indicate that a complete message (RPC, BULK, etc.) has been received.

Specified by:

onProtocolMessageReceived in interface ISdlProtocol

Parameters:

msg - the message that was received

onServiceStarted

public abstract void onServiceStarted(SdlPacket packet,
                                      SessionType sessionType,
                                      int sessionID,
                                      Version version,
                                      boolean isEncrypted)

Description copied from interface: ISdlProtocol

Called to indicate that a service has been started

Specified by:

onServiceStarted in interface ISdlProtocol

Parameters:

packet - the control packet StartServiceACK received from the connected device

sessionType - the service type that has been started

sessionID - the session ID that this service has been started on

version - the protocol version used for this session and service

isEncrypted - if the service is encrypted

onServiceEnded

public abstract void onServiceEnded(SdlPacket packet,
                                    SessionType sessionType,
                                    int sessionID)

Description copied from interface: ISdlProtocol

This will get called when a service has ended

Specified by:

onServiceEnded in interface ISdlProtocol

Parameters:

packet - the packet received that ended this service

sessionType - the service type that has ended

sessionID - the id of the session that this service was operating on

onServiceError

public abstract void onServiceError(SdlPacket packet,
                                    SessionType sessionType,
                                    int sessionID,
                                    String error)

Description copied from interface: ISdlProtocol

If there is an error with starting or stopping the service or any other error this method will be called. This will also be called if the service was operating on a transport that has been disconnected.

Specified by:

onServiceError in interface ISdlProtocol

Parameters:

packet - if there is a packet that caused this error it will be included, however this can be null.

sessionType - the service type that experienced the error

sessionID - the session ID that this service was associated with

error - a human readable string of the error

onProtocolError

public void onProtocolError(String info,
                            Exception e)

Description copied from interface: ISdlProtocol

Called to indicate that a protocol error was detected in received data.

Specified by:

onProtocolError in interface ISdlProtocol

Parameters:

info - a human readable string of the error

e - the exception if one occurred

getSessionId

public int getSessionId()

Description copied from interface: ISdlProtocol

Method that the protocol layer will use to obtain the session ID

Specified by:

getSessionId in interface ISdlProtocol

Returns:

the session ID associated with the protocol instance

shutdown

public void shutdown(String info)

Description copied from interface: ISdlProtocol

A request made by the protocol layer to shutdown the layers above it. Likely due to the RPC service being shutdown or the primary transport disconnecting.

Specified by:

shutdown in interface ISdlProtocol

Parameters:

info - human readable string on why the shutdown should occur

onTransportDisconnected

public void onTransportDisconnected(String info,
                                    boolean altTransportAvailable,
                                    BaseTransportConfig transportConfig)

Description copied from interface: ISdlProtocol

Called when a transport disconnects

Specified by:

onTransportDisconnected in interface ISdlProtocol

Parameters:

info - a human readable string including information on the disconnected transport

altTransportAvailable - a boolean flag indicating if there is another transport that can be used to connect with the SDL enabled device.

transportConfig - the previously supplied transport config

getSdlSecurity

public SdlSecurityBase getSdlSecurity()

Description copied from interface: ISdlProtocol

A method that should be implemented by the hosting class of the SdlProtocol instance that will return the currently being used security library if any.

Specified by:

getSdlSecurity in interface ISdlProtocol

Returns:

the security library to be used to encrypt/decrypt packets

getDesiredVideoParams

public VideoStreamingParameters getDesiredVideoParams()

Returns the currently set desired video streaming parameters. If there haven't been any set, the default options will be returned and set for this instance.

Specified by:

getDesiredVideoParams in interface ISdlProtocol

Returns:

the desired video streaming parameters

setAcceptedVideoParams

public void setAcceptedVideoParams(VideoStreamingParameters params)

Description copied from interface: ISdlProtocol

A callback that will be called when the video service has been successfully started and the streaming parameters have been negotiated. This should be called prior to the video service started callback.

Specified by:

setAcceptedVideoParams in interface ISdlProtocol

Parameters:

params - the negotiated and accepted video parameters that should be used to stream to the SDL enabled device.

onAuthTokenReceived

public void onAuthTokenReceived(String authToken)

Description copied from interface: ISdlProtocol

A callback to indicate the SDL connected device has supplied an authentication token to this application. It will be called after the service start callback.

Specified by:

onAuthTokenReceived in interface ISdlProtocol

onSecurityInitialized

public void onSecurityInitialized()

Specified by:

onSecurityInitialized in interface ISecurityInitializedListener

isTransportForServiceAvailable

public boolean isTransportForServiceAvailable(SessionType sessionType)

Check to see if a transport is available to start/use the supplied service.

Parameters:

sessionType - the session that should be checked for transport availability

Returns:

true if there is either a supported transport currently connected or a transport is available to connect with for the supplied service type.
false if there is no transport connected to support the service type in question and no possibility in the foreseeable future.

getActiveTransports

@Nullable
public List<TransportRecord> getActiveTransports()

Retrieves list of the active transports

Returns:

a list of active transports