com.atlassian.bamboo.plugins.rest.resource

Class StatusResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.StatusResource

public class StatusResource
extends Object

REST resource for retriving the status of the server

Constructor Summary

Constructors

Constructor and Description
StatusResource(ServerStatusProvider serverStatusProvider)

Method Summary

Modifier and Type	Method and Description
RestAnonymousServerStatusInfo	getStatus() Returns the current status of the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusResource

public StatusResource(ServerStatusProvider serverStatusProvider)

Method Detail

getStatus

public RestAnonymousServerStatusInfo getStatus()

Returns the current status of the server. This endpoint enables a basic status check on the status of a Bamboo instance.

The status endpoint will be responsive as long as the Bamboo REST plugin will be running. In other words, this endpoint does depend on the instance health and might not answer as a result of a failure or when Bamboo is still starting.