com.SIMRacingApps.servlets

Class DataService

java.lang.Object

com.SIMRacingApps.servlets.DataService

public class DataService
extends java.lang.Object

This class implements the Data Caching Service for the servlets. It starts up a background thread that waits for events from the SIM, where it updates the cache with any new values.

It is implemented as a singleton, where the all you have to do is call the static method getJSON(String) with the sessionid. This method returns a JSON formatted string with all the data that has changed since the last call.

Other configuration options are available and must be called before your first call to getJSON().

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors

Constructor and Description
DataService()

Method Summary

Modifier and Type	Method and Description
static void	deleteSession(java.lang.String sessionid) Used by the servlets to delete a session from the cache.
static Data	getData(java.lang.String datapath) Used by the servlets to return a data from the SIM directly, bypassing the cache.
static java.lang.StringBuffer	getJSON(java.lang.String sessionid) Returns the results as a JSON String.
static java.lang.StringBuffer	getJSON(java.lang.String sessionid, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> data) This method is called to subscribe to the data and return the results as a JSON string.
static Data	getRecord()
static Data	getSIMName()
static Data	getSIMVersion()
static void	setEndingVersion(java.lang.String endingVersion) If playing back a recorded file, this sets the position to stop playing it at.
static void	setPlay(java.lang.String playfile) Sets the file to use to play back a recorded session.
static void	setRecord(java.lang.String recordfile) Sets the file to record the session to.
static void	setSIMname(java.lang.String SIMName) Sets the name of the SIM to connect to.
static void	setStartingVersion(java.lang.String startingVersion) If playing back a recorded file, this sets the position to start playing it at.
static void	start() starts the background thread to wait for events from the SIM.
static void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataService

public DataService()

Method Detail

stop

public static void stop()

setSIMname

public static void setSIMname(java.lang.String SIMName)

Sets the name of the SIM to connect to. By default, it is set to iRacing. If a different SIM is running, it will stop it.

Parameters:

SIMName - The name of the SIM. Defaults to iRacing.

setStartingVersion

public static void setStartingVersion(java.lang.String startingVersion)

If playing back a recorded file, this sets the position to start playing it at.

Parameters:

startingVersion - The SIM specific version to start at.

setEndingVersion

public static void setEndingVersion(java.lang.String endingVersion)

If playing back a recorded file, this sets the position to stop playing it at.

Parameters:

endingVersion - The SIM specific version to end at.

setPlay

public static void setPlay(java.lang.String playfile)

Sets the file to use to play back a recorded session.

Parameters:

playfile - The filename to use.

getRecord

public static Data getRecord()

setRecord

public static void setRecord(java.lang.String recordfile)

Sets the file to record the session to.

Parameters:

recordfile - The file to record to. Can be null or blank to stop recording.

deleteSession

public static void deleteSession(java.lang.String sessionid)

Used by the servlets to delete a session from the cache.

Parameters:

sessionid - The session to delete.

getData

public static Data getData(java.lang.String datapath)
                    throws SIMPlugin.SIMPluginException

Used by the servlets to return a data from the SIM directly, bypassing the cache.

Parameters:

datapath - The path to the data.

Returns:

The result as a Data object.

Throws:

SIMPlugin.SIMPluginException - If there's an error during the call.

getJSON

public static java.lang.StringBuffer getJSON(java.lang.String sessionid,
                                             java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> data)

This method is called to subscribe to the data and return the results as a JSON string. If data is null, then only the results are returned.

Parameters:

sessionid - The session identifier.

data - The data to subscribe to.

Returns:

A JSON String with the results.

getJSON

public static java.lang.StringBuffer getJSON(java.lang.String sessionid)

Returns the results as a JSON String.

Parameters:

sessionid - The session identifier

Returns:

The results.

getSIMName

public static Data getSIMName()
                       throws SIMPlugin.SIMPluginException

Throws:

SIMPlugin.SIMPluginException

getSIMVersion

public static Data getSIMVersion()
                          throws SIMPlugin.SIMPluginException

Throws:

SIMPlugin.SIMPluginException

start

public static void start()

starts the background thread to wait for events from the SIM.