Package org.craftercms.commons.monitoring.rest

Class MonitoringRestControllerBase

java.lang.Object

org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

@RestController
public abstract class MonitoringRestControllerBase
extends Object

Base controller for all monitoring related APIs

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MEMORY_URL
static final String	ROOT_URL
static final String	STATUS_URL
static final String	VERSION_URL

Constructor Summary

Constructors

Constructor	Description
MonitoringRestControllerBase(String configuredToken)

Method Summary

Modifier and Type	Method	Description
MemoryInfo	getCurrentMemory(String token)
org.springframework.http.ResponseEntity	getCurrentStatus(String site, String token)
VersionInfo	getCurrentVersion(String token)
protected final void	validateToken(String requestToken)

Methods inherited from class java.lang.Object

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

Field Details

ROOT_URL

public static final String ROOT_URL

See Also:

• Constant Field Values

MEMORY_URL

public static final String MEMORY_URL

See Also:

• Constant Field Values

STATUS_URL

public static final String STATUS_URL

See Also:

• Constant Field Values

VERSION_URL

public static final String VERSION_URL

See Also:

• Constant Field Values

Constructor Details

MonitoringRestControllerBase

public MonitoringRestControllerBase(String configuredToken)

Method Details

getCurrentMemory

@GetMapping("/monitoring/memory")
public MemoryInfo getCurrentMemory(@RequestParam(name="token",required=true)
 String token)
                            throws InvalidManagementTokenException

Throws:

InvalidManagementTokenException

getCurrentStatus

@GetMapping("/monitoring/status")
public org.springframework.http.ResponseEntity getCurrentStatus(@RequestParam(name="site",required=false)
 String site,
 @RequestParam(name="token")
 String token)
                                                         throws InvalidManagementTokenException

Throws:

InvalidManagementTokenException

getCurrentVersion

@GetMapping("/monitoring/version")
public VersionInfo getCurrentVersion(@RequestParam(name="token",required=true)
 String token)
                              throws InvalidManagementTokenException,
IOException

Throws:

InvalidManagementTokenException

IOException

validateToken

protected final void validateToken(String requestToken)
                            throws InvalidManagementTokenException

Throws:

InvalidManagementTokenException