org.duracloud.duraboss.rest.report

Class StorageReportRest

java.lang.Object

org.duracloud.duraboss.rest.BaseRest

org.duracloud.duraboss.rest.report.StorageReportRest

@Path(value="/report/storage")
 @Component
public class StorageReportRest
extends BaseRest

REST interface for storage reporting

Field Summary

Fields inherited from class org.duracloud.duraboss.rest.BaseRest

APP_NAME, APPLICATION_XML, headers, request, TEXT_PLAIN, uriInfo, XML

Constructor Summary

Constructors

Constructor and Description
StorageReportRest(StorageReportResource resource)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	cancelStorageReport() Cancels a running storage report.
javax.ws.rs.core.Response	cancelStorageReportSchedule() Cancels the storage report schedule.
javax.ws.rs.core.Response	getLatestStorageReport() Retrieves the latest completed storage report.
javax.ws.rs.core.Response	getStorageReport(String reportId) Retrieves a storage report.
javax.ws.rs.core.Response	getStorageReportInfo() Retrieves information about storage reporting activities.
javax.ws.rs.core.Response	getStorageReportList() Retrieves the list of storage report IDs.
javax.ws.rs.core.Response	scheduleStorageReport(long startTime, long frequency) Sets up a schedule of storage reports to be run, based on a starting time and the frequency at which the report should be run afterward.
javax.ws.rs.core.Response	startStorageReport() Indicates that a new storage report should be started.

Methods inherited from class org.duracloud.duraboss.rest.BaseRest

responseBad, responseBad, responseBad, responseBadRequest, responseNotFound, responseNotFound, responseOk, responseOk, responseOkStream, responseOkXml, responseOkXmlStream

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageReportRest

@Autowired
public StorageReportRest(StorageReportResource resource)

Method Detail

getLatestStorageReport

@GET
 @Produces(value="application/xml")
public javax.ws.rs.core.Response getLatestStorageReport()

Retrieves the latest completed storage report.

Returns:

200 response with storage report XML as body

getStorageReportList

@Path(value="/list")
 @GET
 @Produces(value="application/xml")
public javax.ws.rs.core.Response getStorageReportList()

Retrieves the list of storage report IDs.

Returns:

200 response with storage report list XML as body

getStorageReport

@Path(value="/{reportID: [^?]+}")
 @GET
 @Produces(value="application/xml")
public javax.ws.rs.core.Response getStorageReport(@PathParam(value="reportID")
                                                                                                                              String reportId)

Retrieves a storage report.

Returns:

200 response with storage report XML as body

getStorageReportInfo

@Path(value="/info")
 @GET
 @Produces(value="application/xml")
public javax.ws.rs.core.Response getStorageReportInfo()

Retrieves information about storage reporting activities.

Returns:

200 response with storage report info XML as body

startStorageReport

@POST
public javax.ws.rs.core.Response startStorageReport()

Indicates that a new storage report should be started. If a storage report is currently running, this request is ignored.

Returns:

200 response with body text indicating success

cancelStorageReport

@DELETE
public javax.ws.rs.core.Response cancelStorageReport()

Cancels a running storage report.

Returns:

200 response with body text indicating success

scheduleStorageReport

@Path(value="/schedule")
 @POST
public javax.ws.rs.core.Response scheduleStorageReport(@QueryParam(value="startTime")
                                                                                       long startTime,
                                                                                       @QueryParam(value="frequency")
                                                                                       long frequency)

Sets up a schedule of storage reports to be run, based on a starting time and the frequency at which the report should be run afterward.

Returns:

200 response with body text indicating success

cancelStorageReportSchedule

@Path(value="/schedule")
 @DELETE
public javax.ws.rs.core.Response cancelStorageReportSchedule()

Cancels the storage report schedule. This does not stop running storage reports, only cancels those that would run in the future.

Returns:

200 response with body text indicating success