Package services.publix.idcookie

Class IdCookieService

java.lang.Object

services.publix.idcookie.IdCookieService

@Singleton
public class IdCookieService
extends java.lang.Object

Service class for JATOS ID cookie handling. It generates, extracts and discards ID cookies. An ID cookie is used by the JATOS server to tell jatos.js about several IDs the current study run has (e.g. worker ID, study ID, study result ID). This cookie is created when the study run is started and discarded when it's done. If all possible cookies are used, the start of a new study will cause the oldest ID cookie to be overwritten.

Constructor Summary

Constructors

Constructor	Description
IdCookieService(IdCookieAccessor idCookieAccessor)

Method Summary

Modifier and Type	Method	Description
void	discardIdCookie(java.lang.Long studyResultId)	Discards the ID cookie if the given study result ID is equal to the one in the cookie.
IdCookieModel	getIdCookie(java.lang.Long studyResultId)	Returns the IdCookieModel that corresponds to the given study result ID.
IdCookieModel	getOldestIdCookie()	Checks the creation time of each ID cookie in the given IdCookieCollection and returns the oldest one.
java.lang.Long	getStudyResultIdFromOldestIdCookie()	Checks the creation time of each ID cookie in the given IdCookieCollection and returns the study result ID of the oldest one.
boolean	hasIdCookie(java.lang.Long studyResultId)
boolean	maxIdCookiesReached()	Returns true if the max number of ID cookies has been reached and false otherwise.
boolean	oneIdCookieHasThisStudyAssets(java.lang.String studyAssets)	Returns true if the study assets of at least one ID cookie is equal to the given study assets.
void	writeIdCookie(StudyResult studyResult)	Generates an ID cookie from the given parameters and sets it in the response object.
void	writeIdCookie(StudyResult studyResult, JatosPublix.JatosRun jatosRun)	Generates an ID cookie from the given parameters and sets it in the response object.
void	writeIdCookie(StudyResult studyResult, ComponentResult componentResult)	Generates an ID cookie from the given parameters and sets it in the response object.
void	writeIdCookie(StudyResult studyResult, ComponentResult componentResult, JatosPublix.JatosRun jatosRun)	Generates an ID cookie from the given parameters and sets it in the Response object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdCookieService

@Inject
public IdCookieService(IdCookieAccessor idCookieAccessor)

Method Detail

hasIdCookie

public boolean hasIdCookie(java.lang.Long studyResultId)
                    throws InternalServerErrorPublixException

Throws:

InternalServerErrorPublixException

getIdCookie

public IdCookieModel getIdCookie(java.lang.Long studyResultId)
                          throws BadRequestPublixException,
                                 InternalServerErrorPublixException

Returns the IdCookieModel that corresponds to the given study result ID. If the cookie doesn't exist it throws a BadRequestPublixException.

Throws:

BadRequestPublixException

InternalServerErrorPublixException

oneIdCookieHasThisStudyAssets

public boolean oneIdCookieHasThisStudyAssets(java.lang.String studyAssets)
                                      throws InternalServerErrorPublixException

Returns true if the study assets of at least one ID cookie is equal to the given study assets. Otherwise, returns false.

Throws:

InternalServerErrorPublixException

writeIdCookie

public void writeIdCookie(StudyResult studyResult)
                   throws InternalServerErrorPublixException

Generates an ID cookie from the given parameters and sets it in the response object.

Throws:

InternalServerErrorPublixException

writeIdCookie

public void writeIdCookie(StudyResult studyResult,
                          ComponentResult componentResult)
                   throws InternalServerErrorPublixException

Generates an ID cookie from the given parameters and sets it in the response object.

Throws:

InternalServerErrorPublixException

writeIdCookie

public void writeIdCookie(StudyResult studyResult,
                          JatosPublix.JatosRun jatosRun)
                   throws InternalServerErrorPublixException

Generates an ID cookie from the given parameters and sets it in the response object.

Throws:

InternalServerErrorPublixException

writeIdCookie

public void writeIdCookie(StudyResult studyResult,
                          ComponentResult componentResult,
                          JatosPublix.JatosRun jatosRun)
                   throws InternalServerErrorPublixException

Generates an ID cookie from the given parameters and sets it in the Response object. Checks if there is an existing ID cookie with the same study result ID and if so overwrites it. If there isn't it writes a new one. It expects a free spot in the cookie collection and if not throws an InternalServerErrorPublixException (should never happen). The deletion of the oldest cookie must have happened beforehand.

Throws:

InternalServerErrorPublixException

discardIdCookie

public void discardIdCookie(java.lang.Long studyResultId)
                     throws InternalServerErrorPublixException

Discards the ID cookie if the given study result ID is equal to the one in the cookie.

Throws:

InternalServerErrorPublixException

maxIdCookiesReached

public boolean maxIdCookiesReached()
                            throws InternalServerErrorPublixException

Returns true if the max number of ID cookies has been reached and false otherwise.

Throws:

InternalServerErrorPublixException

getOldestIdCookie

public IdCookieModel getOldestIdCookie()
                                throws InternalServerErrorPublixException

Checks the creation time of each ID cookie in the given IdCookieCollection and returns the oldest one. Returns null if the IdCookieCollection is empty.

Throws:

InternalServerErrorPublixException

getStudyResultIdFromOldestIdCookie

public java.lang.Long getStudyResultIdFromOldestIdCookie()
                                                  throws InternalServerErrorPublixException

Checks the creation time of each ID cookie in the given IdCookieCollection and returns the study result ID of the oldest one. Returns null if the IdCookieCollection is empty.

Throws:

InternalServerErrorPublixException