org.alfresco.bm.manager.api.v1

Class StatusAPI

java.lang.Object

org.alfresco.bm.manager.api.AbstractRestResource

org.alfresco.bm.manager.api.v1.StatusAPI

@RestController
 @RequestMapping(value="api/v1/status")
public class StatusAPI
extends AbstractRestResource

REST API V1

The url pattern:

• <API URL>/v1/status

Delegate the request to service layer and responds with json.

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields inherited from class org.alfresco.bm.manager.api.AbstractRestResource

gson, logger

Constructor Summary

Constructors

Constructor and Description
StatusAPI(LifecycleController lifeCycleController, LogService logService)

Method Summary

Modifier and Type	Method and Description
String	getLogs(String driverId, String test, String run, String levelStr, Long from, Long to, int skip, int count)
String	getStartupStatus()

Methods inherited from class org.alfresco.bm.manager.api.AbstractRestResource

copyDBObject, maskValues

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusAPI

public StatusAPI(LifecycleController lifeCycleController,
                 LogService logService)

Parameters:

lifeCycleController - used to report on startup issues

logService - get log messages

Method Detail

getStartupStatus

@GetMapping(path="/startup",
            produces="text/plain")
public String getStartupStatus()

getLogs

@GetMapping(path="/logs",
            produces="application/json")
public String getLogs(@RequestParam(value="driverId",required=false)
                                                                                         String driverId,
                                                                                         @RequestParam(value="test")
                                                                                         String test,
                                                                                         @RequestParam(value="run")
                                                                                         String run,
                                                                                         @RequestParam(value="level",defaultValue="INFO")
                                                                                         String levelStr,
                                                                                         @RequestParam(value="from",defaultValue="0")
                                                                                         Long from,
                                                                                         @RequestParam(value="to",defaultValue="9223372036854775807")
                                                                                         Long to,
                                                                                         @RequestParam(value="skip",defaultValue="0")
                                                                                         int skip,
                                                                                         @RequestParam(value="count",defaultValue="50")
                                                                                         int count)