Package fr.gouv.vitam.common.server.application.resources

Class AdminStatusResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.AdminStatusResource

Direct Known Subclasses:

AdminBatchReportResource

@Path("/admin/v1")
@Consumes("application/json")
@Produces("application/json")
public class AdminStatusResource
extends java.lang.Object

AdminStatusResource : Manage Admin Functionality through Admin URI

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AUTOTEST_URL	Autotest for Administration resource path
static java.lang.String	METRIC_URL
static java.lang.String	STATUS_URL	Status for Administration resource path
static java.lang.String	VERSION_URL

Constructor Summary

Constructors

Constructor	Description
AdminStatusResource()	Constructor AdminStatusResource using implicit BasicVitamStatusServiceImpl
AdminStatusResource(VitamServiceRegistry autotestService)	Constructor AdminStatusResource
AdminStatusResource(VitamStatusService statusService)	Constructor AdminStatusResource
AdminStatusResource(VitamStatusService statusService, VitamServiceRegistry autotestService)	Constructor AdminStatusResource

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	adminAutotest()
javax.ws.rs.core.Response	adminStatus()	Return a response status
javax.ws.rs.core.Response	adminVersion()	Return a response version infos (for all nodes)
javax.ws.rs.core.Response	prometheusMetrics()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_URL

public static final java.lang.String STATUS_URL

Status for Administration resource path

See Also:

Constant Field Values

AUTOTEST_URL

public static final java.lang.String AUTOTEST_URL

Autotest for Administration resource path

See Also:

Constant Field Values

VERSION_URL

public static final java.lang.String VERSION_URL

See Also:

Constant Field Values

METRIC_URL

public static final java.lang.String METRIC_URL

See Also:

Constant Field Values

Constructor Detail

AdminStatusResource

public AdminStatusResource()

Constructor AdminStatusResource using implicit BasicVitamStatusServiceImpl

AdminStatusResource

public AdminStatusResource(VitamStatusService statusService)

Constructor AdminStatusResource

Parameters:

statusService -

AdminStatusResource

public AdminStatusResource(VitamStatusService statusService,
                           VitamServiceRegistry autotestService)

Constructor AdminStatusResource

Parameters:

statusService -

autotestService -

AdminStatusResource

public AdminStatusResource(VitamServiceRegistry autotestService)

Constructor AdminStatusResource

Parameters:

autotestService -

Method Detail

adminStatus

@Path("/status")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response adminStatus()

Return a response status

Returns:

Response containing the status of the service in AdminStatusMessage form

adminVersion

@Path("/version")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response adminVersion()

Return a response version infos (for all nodes)

Returns:

Response containing the status of the service in AdminStatusMessage form

adminAutotest

@Path("/autotest")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response adminAutotest()

Returns:

the full status including dependencies in VitamError form

prometheusMetrics

@Path("/metrics")
@GET
@Produces("text/plain; version=0.0.4; charset=utf-8")
public javax.ws.rs.core.Response prometheusMetrics()