org.jitsi.service.neomedia

Interface SrtpControl

All Known Subinterfaces:

DtlsControl, SDesControl, ZrtpControl

All Known Implementing Classes:

AbstractSrtpControl, DtlsControlImpl, NullSrtpControl, SDesControlImpl, ZrtpControlImpl

public interface SrtpControl

Controls SRTP encryption in the MediaStream.

Author:

Damian Minkov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SrtpControl.TransformEngine Adds a cleanup() method to org.jitsi.impl.neomedia.transform.TransformEngine which is to go in hand with the cleanup() method of SrtpControl.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RTP_SAVP
static String	RTP_SAVPF

Method Summary

Modifier and Type	Method and Description
void	cleanup(Object user) Cleans up this SrtpControl and its TransformEngine.
boolean	getSecureCommunicationStatus() Gets the default secure/insecure communication status for the supported call sessions.
SrtpControlType	getSrtpControlType() Gets the SrtpControlType of this instance.
SrtpListener	getSrtpListener() Returns the SrtpListener which listens for security events.
SrtpControl.TransformEngine	getTransformEngine() Returns the transform engine currently used by this stream.
void	registerUser(Object user) Registers user as an instance which is currently using this SrtpControl.
boolean	requiresSecureSignalingTransport() Indicates if the key exchange method is dependent on secure transport of the signaling channel.
void	setConnector(AbstractRTPConnector connector) Sets the RTPConnector which is to use or uses this SRTP engine.
void	setMasterSession(boolean masterSession) When in multistream mode, enables the master session.
void	setMultistream(SrtpControl master) Sets the multistream data, which means that the master stream has successfully started and this will start all other streams in this session.
void	setSrtpListener(SrtpListener srtpListener) Sets a SrtpListener that will listen for security events.
void	start(org.jitsi.utils.MediaType mediaType) Starts and enables zrtp in the stream holding this control.

Field Detail

RTP_SAVP

static final String RTP_SAVP

See Also:

Constant Field Values

RTP_SAVPF

static final String RTP_SAVPF

See Also:

Constant Field Values

Method Detail

cleanup

void cleanup(Object user)

Cleans up this SrtpControl and its TransformEngine.

Parameters:

user - the Object which requests the clean-up and is supposedly currently using this SrtpControl (i.e. has already used registerUser(Object)).

getSecureCommunicationStatus

boolean getSecureCommunicationStatus()

Gets the default secure/insecure communication status for the supported call sessions.

Returns:

default secure communication status for the supported call sessions.

getSrtpControlType

SrtpControlType getSrtpControlType()

Gets the SrtpControlType of this instance.

Returns:

the SrtpControlType of this instance

getSrtpListener

SrtpListener getSrtpListener()

Returns the SrtpListener which listens for security events.

Returns:

the SrtpListener which listens for security events

getTransformEngine

SrtpControl.TransformEngine getTransformEngine()

Returns the transform engine currently used by this stream.

Returns:

the RTP stream transformation engine

requiresSecureSignalingTransport

boolean requiresSecureSignalingTransport()

Indicates if the key exchange method is dependent on secure transport of the signaling channel.

Returns:

true when secure signaling is required to make the encryption secure; false, otherwise.

setConnector

void setConnector(AbstractRTPConnector connector)

Sets the RTPConnector which is to use or uses this SRTP engine.

Parameters:

connector - the RTPConnector which is to use or uses this SRTP engine

setMasterSession

void setMasterSession(boolean masterSession)

When in multistream mode, enables the master session.

Parameters:

masterSession - whether current control, controls the master session.

setMultistream

void setMultistream(SrtpControl master)

Sets the multistream data, which means that the master stream has successfully started and this will start all other streams in this session.

Parameters:

master - The security control of the master stream.

setSrtpListener

void setSrtpListener(SrtpListener srtpListener)

Sets a SrtpListener that will listen for security events.

Parameters:

srtpListener - the SrtpListener that will receive the events

start

void start(org.jitsi.utils.MediaType mediaType)

Starts and enables zrtp in the stream holding this control.

Parameters:

mediaType - the media type of the stream this control controls.

registerUser

void registerUser(Object user)

Registers user as an instance which is currently using this SrtpControl.

Parameters:

user - the Object which is currently using this SrtpControl