Package nzilbb.labbcat.server.api
Class Versions
- java.lang.Object
-
- nzilbb.labbcat.server.api.APIRequestHandler
-
- nzilbb.labbcat.server.api.Versions
-
public class Versions extends APIRequestHandler
/api/versions : version information about LaBB-CAT, its modules, and 3rd-party integrations.Allows access to information about the current user, returning a JSON-encoded object with the following top level attributes:
- System
- Versions of different components of LaBB-CAT as a whole.
- Formats
- Versions of format conversion modules.
- Layer Managers
- Versions of legacy layer manager modules.
- Annotator modules
- Versions of annotator modules.
- 3rd Party Software
- Versions of Praat, ffmpeg, etc.
- RDBMS
- Version information for the SQL database.
Each attribute value is a object where each attribute name is a sub-component name, and its value is a string representing the version of that sub-component.
Only the GET HTTP method is supported:
- GET
-
- Response Body - the standard JSON envelope, with the model as an object with the above structure.
- Response Status n- 200 : Success.
- 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 Versions()
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
get(javax.json.stream.JsonGenerator jsonOut, Consumer<Integer> httpStatus)
Generate the response to a request.-
Methods inherited from class nzilbb.labbcat.server.api.APIRequestHandler
GetSystemAttribute, init, writeResponse
-
-
-
-
Method Detail
-
get
public void get(javax.json.stream.JsonGenerator jsonOut, Consumer<Integer> httpStatus)
Generate the response to a request.This returns information about the current user - their ID and the roles they have.
- Parameters:
jsonOut
- A JSON generator for writing the response to.httpStatus
- Receives the response status code, in case of error.
-
-