All Known Implementing Classes:

WindupEndpointImpl
```
@Path("windup")
@Consumes("application/json")
@Produces("application/json")
public interface WindupEndpoint
```
Contains methods for executing Windup and querying the current status of an execution run.

Author:

Jesse Sightler

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class WindupEndpoint.VersionAndRevision

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancelExecution(Long executionID)`
`void`	`deleteExecution(Long executionID)`	Deletes a report from the specified execution.
`WindupExecution`	`executeProjectWithContext(AnalysisContext context, Long projectId)`	Initiates a Windup execution for a particular AnalysisContext.
`Collection<WindupExecution>`	`getAllExecutions()`
`WindupEndpoint.VersionAndRevision`	`getCoreVersion()`	The Windup Core version.
`WindupExecution`	`getExecution(Long executionID)`	Gets the execution based upon the execution ID.
`List<String>`	`getExecutionLogs(Long executionID)`	Gets an array of the most recent log lines from the requested execution.
`InputStream`	`getExecutionRequestTar(long executionId)`
`Collection<WindupExecution>`	`getProjectExecutions(Long projectId)`
`void`	`uploadResults(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput data, long executionId)`

Method Detail

getExecution

@GET
@Path("executions/{executionID}")
WindupExecution getExecution(@PathParam("executionID")
                             Long executionID)

Gets the execution based upon the execution ID.

executeProjectWithContext

@POST
@Path("execute-project-with-context/{projectId}")
WindupExecution executeProjectWithContext(AnalysisContext context,
                                          @PathParam("projectId")
                                          Long projectId)

Initiates a Windup execution for a particular AnalysisContext.

getAllExecutions

@GET
@Path("executions")
Collection<WindupExecution> getAllExecutions()

getProjectExecutions

@GET
@Path("by-project/{projectId}")
Collection<WindupExecution> getProjectExecutions(@PathParam("projectId")
                                                 Long projectId)

cancelExecution

@POST
@Path("executions/{executionId}/cancel")
void cancelExecution(@PathParam("executionId")
                     Long executionID)

getExecutionRequestTar

@GET
@Path("executions/get-execution-request-tar/{executionId}")
@Produces("application/octet-stream")
InputStream getExecutionRequestTar(@PathParam("executionId")
                                   long executionId)

uploadResults

@POST
@Path("executions/post-results/{executionId}")
@Consumes("multipart/form-data")
void uploadResults(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput data,
                   @PathParam("executionId")
                   long executionId)

getExecutionLogs

@GET
@Path("executions/{executionId}/logs")
List<String> getExecutionLogs(@PathParam("executionId")
                              Long executionID)

Gets an array of the most recent log lines from the requested execution.

deleteExecution

@DELETE
@Path("executions/{executionId}")
void deleteExecution(@PathParam("executionId")
                     Long executionID)

Deletes a report from the specified execution.

getCoreVersion

@GET
@Path("coreVersion")
WindupEndpoint.VersionAndRevision getCoreVersion()

The Windup Core version.

Interface WindupEndpoint

Nested Class Summary