org.wso2.testgrid.web.api

Class ProductService

java.lang.Object

org.wso2.testgrid.web.api.ProductService

@Path(value="/products")
 @Produces(value="application/json")
public class ProductService
extends Object

REST service implementation of Products.

Constructor Summary

Constructors

Constructor and Description
ProductService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllProducts() This has the implementation of the REST API for fetching all the Products.
javax.ws.rs.core.Response	getAllProductStatuses() This method returns the list of products that are currently in TestGrid.
javax.ws.rs.core.Response	getProduct(String id) This has the implementation of the REST API for fetching a Product by id.
javax.ws.rs.core.Response	getProductReport(String productName, Boolean showSuccess, String groupBy) This method is able to get the latest report of a given product from the remote storage and return.
javax.ws.rs.core.Response	getProductStatus(String productName) This method returns the product if the requested product name exists in the TestGrid.
javax.ws.rs.core.Response	isProductReportExist(String productName, Boolean showSuccess, String groupBy) This method verifies the existence of the requesting report in the remote location.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductService

public ProductService()

Method Detail

getAllProducts

@GET
public javax.ws.rs.core.Response getAllProducts()

This has the implementation of the REST API for fetching all the Products.

Returns:

A list of available Products.

getProduct

@GET
 @Path(value="/{id}")
public javax.ws.rs.core.Response getProduct(@PathParam(value="id")
                                                                       String id)

This has the implementation of the REST API for fetching a Product by id.

Returns:

the matching Product.

getAllProductStatuses

@GET
 @Path(value="/product-status")
public javax.ws.rs.core.Response getAllProductStatuses()

This method returns the list of products that are currently in TestGrid.

The products are returned as a json response with the last build information and the last failed build information

Returns:

list of products

getProductStatus

@GET
 @Path(value="/product-status/{productName}")
public javax.ws.rs.core.Response getProductStatus(@PathParam(value="productName")
                                                                                                     String productName)

This method returns the product if the requested product name exists in the TestGrid.

The product is returned as a json response with the last build information and the last failed build information

Returns:

product

isProductReportExist

@HEAD
 @Path(value="/reports")
public javax.ws.rs.core.Response isProductReportExist(@QueryParam(value="product-name")
                                                                                     String productName,
                                                                                     @DefaultValue(value="false") @QueryParam(value="show-success")
                                                                                     Boolean showSuccess,
                                                                                     @DefaultValue(value="SCENARIO") @QueryParam(value="group-by")
                                                                                     String groupBy)

This method verifies the existence of the requesting report in the remote location.

Returns:

existence of the querying product report

getProductReport

@GET
 @Path(value="/reports")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getProductReport(@QueryParam(value="product-name")
                                                                                                                             String productName,
                                                                                                                             @DefaultValue(value="false") @QueryParam(value="show-success")
                                                                                                                             Boolean showSuccess,
                                                                                                                             @DefaultValue(value="SCENARIO") @QueryParam(value="group-by")
                                                                                                                             String groupBy)

This method is able to get the latest report of a given product from the remote storage and return.

The report is returned as a html file

Returns:

latest report of querying product