org.springframework.xd.dirt.rest.metrics

Class AggregateCountersController

java.lang.Object

org.springframework.xd.dirt.rest.metrics.AggregateCountersController

@Controller
@RequestMapping(value="/metrics/aggregate-counters")
@ExposesResourceFor(value=AggregateCountsResource.class)
public class AggregateCountersController
extends java.lang.Object

Exposes representations of AggregateCounts.

Author:

Eric Bottard, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected R	repository
protected org.springframework.hateoas.ResourceAssembler<M,MetricResource>	shallowResourceAssembler

Constructor Summary

Constructors

Constructor and Description
AggregateCountersController(AggregateCounterRepository repository)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	delete(java.lang.String name) Deletes the metric from the repository
AggregateCountsResource	display(java.lang.String name, org.joda.time.DateTime from, org.joda.time.DateTime to, AggregateCountResolution resolution) Retrieve counts for a given time interval, using some precision.
org.springframework.hateoas.PagedResources<? extends MetricResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<Counter> pagedAssembler, boolean detailed, org.joda.time.DateTime from, org.joda.time.DateTime to, AggregateCountResolution resolution) List AggregateCounts that match the given criteria.
protected org.springframework.hateoas.PagedResources<? extends MetricResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<M> pagedAssembler, org.springframework.hateoas.ResourceAssembler<M,? extends MetricResource> resourceAssembler) Lists metric resources.

Methods inherited from class java.lang.Object

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

Field Detail

repository

protected final R extends MetricRepository<M> repository

shallowResourceAssembler

protected final org.springframework.hateoas.ResourceAssembler<M extends Metric,MetricResource> shallowResourceAssembler

Constructor Detail

AggregateCountersController

@Autowired
public AggregateCountersController(AggregateCounterRepository repository)

Method Detail

list

@ResponseBody
@RequestMapping(value="",
                method=GET)
public org.springframework.hateoas.PagedResources<? extends MetricResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                    org.springframework.data.web.PagedResourcesAssembler<Counter> pagedAssembler,
                                                                                                    @RequestParam(value="detailed",defaultValue="false")
                                                                                                    boolean detailed,
                                                                                                    @RequestParam(value="from",required=false)@DateTimeFormat(iso=DATE_TIME)
                                                                                                    org.joda.time.DateTime from,
                                                                                                    @RequestParam(value="to",required=false)@DateTimeFormat(iso=DATE_TIME)
                                                                                                    org.joda.time.DateTime to,
                                                                                                    @RequestParam(value="resolution",defaultValue="hour")
                                                                                                    AggregateCountResolution resolution)

List AggregateCounts that match the given criteria.

display

@ResponseBody
@RequestMapping(value="/{name}",
                method=GET,
                produces="application/json")
public AggregateCountsResource display(@PathVariable(value="name")
                                                          java.lang.String name,
                                                          @RequestParam(value="from",required=false)@DateTimeFormat(iso=DATE_TIME)
                                                          org.joda.time.DateTime from,
                                                          @RequestParam(value="to",required=false)@DateTimeFormat(iso=DATE_TIME)
                                                          org.joda.time.DateTime to,
                                                          @RequestParam(value="resolution",defaultValue="hour")
                                                          AggregateCountResolution resolution)

Retrieve counts for a given time interval, using some precision.

Parameters:

name - the name of the aggregate counter we want to retrieve data from

from - the start-time for the interval, default depends on the resolution (e.g. go back 1 day for hourly buckets)

to - the end-time for the interval, default "now"

resolution - the size of buckets to aggregate, e.g. hourly, daily, etc. (default "hour")

list

protected org.springframework.hateoas.PagedResources<? extends MetricResource> list(org.springframework.data.domain.Pageable pageable,
                                                                        org.springframework.data.web.PagedResourcesAssembler<M> pagedAssembler,
                                                                        org.springframework.hateoas.ResourceAssembler<M,? extends MetricResource> resourceAssembler)

Lists metric resources.

Parameters:

pageable - the Pageable

pagedAssembler - the PagedResourcesAssembler

resourceAssembler - the ResourceAssembler

Returns:

the resources

delete

@RequestMapping(value="/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
protected void delete(@PathVariable(value="name")
                                        java.lang.String name)

Deletes the metric from the repository

Parameters:

name - the name of the metric to delete