services.publix.idcookie

Class IdCookieCollection

java.lang.Object

services.publix.idcookie.IdCookieCollection

public class IdCookieCollection
extends java.lang.Object

Wrapper around a collection of JATOS ID cookies. Adds some useful methods. The number of ID cookies is limited by the jatos.idCookies.limit value in the jatos.conf.

Constructor Summary

Constructors

Constructor and Description
IdCookieCollection()

Method Summary

Modifier and Type	Method and Description
protected IdCookieModel	add(IdCookieModel idCookie) Stores the given ID cookie.
protected IdCookieModel	findWithStudyResultId(long studyResultId) Returns the ID cookie to which the specified study result ID is mapped, or null if nothing maps to the ID.
protected java.util.Collection<IdCookieModel>	getAll()
protected int	getNextAvailableIdCookieIndex() Returns the ID cookie's index, a number from 0 to the limit set in jatos.conf.
protected boolean	isFull()
protected IdCookieModel	put(IdCookieModel idCookie) Stores the given IdCookieModel.
protected IdCookieModel	remove(IdCookieModel idCookie)
protected int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IdCookieCollection

public IdCookieCollection()

Method Detail

isFull

protected boolean isFull()

size

protected int size()

add

protected IdCookieModel add(IdCookieModel idCookie)
                     throws IdCookieAlreadyExistsException

Stores the given ID cookie. If an IdCookieModel with the same study result ID is already stored an IdCookieAlreadyExistsException is thrown. If the max number of cookies is reached an IdCookieCollectionFullException is thrown.

Throws:

IdCookieAlreadyExistsException

put

protected IdCookieModel put(IdCookieModel idCookie)
                     throws IdCookieCollectionFullException

Stores the given IdCookieModel. If an ID cookie with the same study result ID is already stored it gets overwritten. If the max number of cookies is reached an IdCookieCollectionFullException is thrown.

Throws:

IdCookieCollectionFullException

remove

protected IdCookieModel remove(IdCookieModel idCookie)

getAll

protected java.util.Collection<IdCookieModel> getAll()

getNextAvailableIdCookieIndex

protected int getNextAvailableIdCookieIndex()

Returns the ID cookie's index, a number from 0 to the limit set in jatos.conf. It iterates through the ID cookies and returns the first index that isn't used. Index refers here to the index of the ID cookie which is the suffix of its name. If this IdCookieCollection is full a IndexOutOfBoundsException will be thrown.

findWithStudyResultId

protected IdCookieModel findWithStudyResultId(long studyResultId)

Returns the ID cookie to which the specified study result ID is mapped, or null if nothing maps to the ID.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object