Class SessionAdministration

The SessionAdministration class is used for administering the current transmission sessions. It has a list of all the transmission sessions that are currently open and publishes all API related events.

Inheritance

java.lang.Object

SessionAdministration

Inherited Members

java.lang.Object.clone()

java.lang.Object.equals(java.lang.Object)

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.hashCode()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.toString()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Namespace:

Assembly: .dll

Syntax

public class SessionAdministration

Constructors

SessionAdministration()

Declaration

public SessionAdministration()

Methods

closeSession(UUID sessionId)

Closes a transmission session and publishes a SessionClosedEvent.

Declaration

public boolean closeSession(UUID sessionId)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId of the transmission session to close

Returns

Type	Description
boolean	True

getActiveSessionStatuses()

A list containing the session statuses for all currently active tranmission sessions.

Declaration

public List<SessionStatus> getActiveSessionStatuses()

Returns

Type	Description
java.util.List<SessionStatus>

getCanceledSessionStatuses()

A list containing the session statuses for all currently canceled tranmission sessions.

Declaration

public List<SessionStatus> getCanceledSessionStatuses()

Returns

Type	Description
java.util.List<SessionStatus>

getSessionStatuses()

A list containing the session statuses for all transmission sessions of the current runtime.

Declaration

public List<SessionStatus> getSessionStatuses()

Returns

Type	Description
java.util.List<SessionStatus>

getStatus(UUID sessionId)

Gets the SessionStatus of a tranmission session.

Declaration

public SessionStatus getStatus(UUID sessionId)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId whose session status to get

Returns

Type	Description
SessionStatus	The SessionStatus of the tranmission session if found, null else

getTimeoutedSessionStatuses()

A list containing the session statuses for all currently timeouted tranmission sessions.

Declaration

public List<SessionStatus> getTimeoutedSessionStatuses()

Returns

Type	Description
java.util.List<SessionStatus>

isSessionActive(UUID sessionId)

Checks if the transmission session is active.

Declaration

public boolean isSessionActive(UUID sessionId)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId whose session status to check

Returns

Type	Description
boolean	True if session is active

openSession(UUID sessionId, IMetaInformation metaInformation, String remoteCallerIp)

Opens a new transmission session and publishes a SessionOpenedEvent.

Declaration

public boolean openSession(UUID sessionId, IMetaInformation metaInformation, String remoteCallerIp)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId to open a session for
IMetaInformation	metaInformation	The IMetaInformation of the session
java.lang.String	remoteCallerIp	The ip of the device that made the API call

Returns

Type	Description
boolean	True

receiveImage(UUID sessionId, String game, String imageJson)

Deserializes an IImageContainer object from a json string and publishes a ImageReceivedEvent.

Declaration

public void receiveImage(UUID sessionId, String game, String imageJson)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId of the tranmission session who sent the images
java.lang.String	game	The game of the tranmission session who sent the images
java.lang.String	imageJson	The IImageContainer json

receiveStatistics(UUID sessionId, String game, String statisticsJson)

Deserializes an IStatistics object from a json string and publishes a ImageReceivedEvent.

Declaration

public void receiveStatistics(UUID sessionId, String game, String statisticsJson)

Parameters

Type	Name	Description
java.util.UUID	sessionId	The sessionId of the tranmission session who sent the images
java.lang.String	game	The game of the tranmission session who sent the images
java.lang.String	statisticsJson

removeByUUID(UUID sessionId)

Removes a session status entirely from the list.

Declaration

public void removeByUUID(UUID sessionId)

Parameters

Type	Name	Description
java.util.UUID	sessionId	the ID of the session that shall be removed.