Package nzilbb.labbcat.server.api
Class KeepAlive
- java.lang.Object
-
- nzilbb.labbcat.server.api.APIRequestHandler
-
- nzilbb.labbcat.server.api.KeepAlive
-
public class KeepAlive extends APIRequestHandler
/keepalive or /api/keepalive : Keeps the current session/task alive.This enpoint is intended to that the user's session, and a given task, is not disposed of even if they don't browse to a new page for a long time.
The only method supported is:
- GET
-
- Optional parameter
- threadId A thread to keep from being cleaned up.
- Response Body - no body is returned.
- Response Status - always 200 .
- Optional parameter
- Author:
- Robert Fromont
-
-
Field Summary
-
Fields inherited from class nzilbb.labbcat.server.api.APIRequestHandler
SC_BAD_REQUEST, SC_CONFLICT, SC_FORBIDDEN, SC_INTERNAL_SERVER_ERROR, SC_METHOD_NOT_ALLOWED, SC_NOT_FOUND, SC_OK, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE
-
-
Constructor Summary
Constructors Constructor Description KeepAlive()
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
get(RequestParameters parameters, Consumer<Integer> refreshHeader)
Keeps session/task alive.-
Methods inherited from class nzilbb.labbcat.server.api.APIRequestHandler
GetSystemAttribute, init, writeResponse
-
-
-
-
Method Detail
-
get
public void get(RequestParameters parameters, Consumer<Integer> refreshHeader)
Keeps session/task alive.- Parameters:
parameters
- Request parameter map.refreshHeader
- Receives the value for the Refresh header.
-
-