Routify Documentation
Loading...
Searching...
No Matches
ch.routify.controllers.StatusController Class Reference

Public Member Functions

ResponseEntity< JSONObject > getStatus ()
 
ResponseEntity< JSONObject > getBoundary () throws FileNotFoundException, ParseException
 
ResponseEntity< JSONObject > fetchMeta () throws Exception
 

Detailed Description

Controller responsible for handling API endpoints related to the system status within the Routifys application. This controller provides endpoints for retrieving general system status information such as vertex and edge counts in the system's graph, as well as detailed boundary information.

Author
Alexander Eggerth
Version
1.0

Member Function Documentation

◆ fetchMeta()

ResponseEntity< JSONObject > ch.routify.controllers.StatusController.fetchMeta ( ) throws Exception
inline

Triggers update of cached metadata and updates graph datastructure according to new metadata.

Returns
ResponseEntity containing a empty JSONObject
Exceptions
Exception

◆ getBoundary()

ResponseEntity< JSONObject > ch.routify.controllers.StatusController.getBoundary ( ) throws FileNotFoundException, ParseException
inline

Retrieves the geographical boundary information for the system.

Returns
ResponseEntity containing a JSONObject with the system's boundary information, wrapped in an HTTP OK response.
Exceptions
FileNotFoundExceptionif the boundary information file cannot be found.
ParseExceptionif there is an error parsing the boundary information file.

◆ getStatus()

ResponseEntity< JSONObject > ch.routify.controllers.StatusController.getStatus ( )
inline

Retrieves the current status of the system, including counts of vertices and edges in the graph.

Returns
ResponseEntity containing a JSONObject with the vertex and edge count of the system's graph, wrapped in an HTTP OK response.

The documentation for this class was generated from the following file: