org.adroitlogic.x.management.rest.controller

Class TroubleshootController

java.lang.Object

org.adroitlogic.x.management.rest.controller.AbstractManagementController

org.adroitlogic.x.management.rest.controller.TroubleshootController

@Path(value="troubleshoot")
 @Produces(value="application/json")
public class TroubleshootController
extends AbstractManagementController

Generates and exposes a snapshot of logs, projects and conf directory of a project-x instance as a downloadable archive

Since:

17.01

Author:

Janaka Bandara

Constructor Summary

Constructors

Constructor and Description
TroubleshootController()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	downloadReport()
javax.ws.rs.core.Response	execute(ExecutionConfigView parameters)
javax.ws.rs.core.Response	getAvailableTasks()
javax.ws.rs.core.Response	getCurrentTaskStatus()
javax.ws.rs.core.Response	getExecutionSummary()
javax.ws.rs.core.Response	getOverallStatus()
javax.ws.rs.core.Response	launch(ExecutionConfigView parameters)

Methods inherited from class org.adroitlogic.x.management.rest.controller.AbstractManagementController

sendCustomResponse, sendCustomResponse, sendCustomSuccessResponse, sendSuccessResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

TroubleshootController

public TroubleshootController()

Method Detail

getAvailableTasks

@GET
 @Path(value="/tasks")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAvailableTasks()

launch

@POST
 @Path(value="/start")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response launch(ExecutionConfigView parameters)

execute

@POST
 @Path(value="/run")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response execute(ExecutionConfigView parameters)

getOverallStatus

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

getCurrentTaskStatus

@GET
 @Path(value="/current")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCurrentTaskStatus()

getExecutionSummary

@GET
 @Path(value="/summary")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getExecutionSummary()

downloadReport

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response downloadReport()
                                                                                   throws ManagementServiceException

Throws:

ManagementServiceException