Package org.lockss.laaws.poller.api

Interface PollsApi

All Known Implementing Classes:

PollsApiController

@Validated
public interface PollsApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<String>	callPoll(@Valid org.lockss.util.rest.poller.PollDesc body)
default org.springframework.http.ResponseEntity<Void>	cancelPoll(String psId)
PollsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<PollerDetail>	getPollerPollDetails(String pollKey)
default org.springframework.http.ResponseEntity<UrlPager>	getPollPeerVoteUrls(String pollKey, String peerId, @NotNull @Valid String urls, @Valid Integer page, @Valid Integer size)
default org.springframework.http.ResponseEntity<PollerPager>	getPollsAsPoller(@Valid Integer size, @Valid Integer page)
default org.springframework.http.ResponseEntity<VoterPager>	getPollsAsVoter(@Valid Integer size, @Valid Integer page)
default org.springframework.http.ResponseEntity<PollerSummary>	getPollStatus(String psId)
default org.springframework.http.ResponseEntity<RepairPager>	getRepairQueueData(String pollKey, @NotNull @Valid String repair, @Valid Integer page, @Valid Integer size)
default org.springframework.http.ResponseEntity<UrlPager>	getTallyUrls(String pollKey, @NotNull @Valid String tally, @Valid Integer page, @Valid Integer size)
default org.springframework.http.ResponseEntity<VoterDetail>	getVoterPollDetails(String pollKey)

Method Details

getDelegate

PollsApiDelegate getDelegate()

callPoll

@RequestMapping(value="/polls",
                produces="application/json",
                consumes="application/json",
                method=POST)
default org.springframework.http.ResponseEntity<String> callPoll(@Valid @RequestBody
 @Valid org.lockss.util.rest.poller.PollDesc body)

cancelPoll

@RequestMapping(value="/polls/{psId}",
                produces="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<Void> cancelPoll(@PathVariable("psId")
 String psId)

getPollPeerVoteUrls

@RequestMapping(value="/polls/{pollKey}/peer/{peerId}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getPollPeerVoteUrls(@PathVariable("pollKey")
 String pollKey,
 @PathVariable("peerId")
 String peerId,
 @NotNull @Valid @RequestParam(value="urls",required=true)
 @NotNull @Valid String urls,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size)

getPollStatus

@RequestMapping(value="/polls/{psId}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<PollerSummary> getPollStatus(@PathVariable("psId")
 String psId)

getPollerPollDetails

@RequestMapping(value="/polls/poller/{pollKey}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<PollerDetail> getPollerPollDetails(@PathVariable("pollKey")
 String pollKey)

getPollsAsPoller

@RequestMapping(value="/polls/poller",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<PollerPager> getPollsAsPoller(@Valid @RequestParam(value="size",required=false)
 @Valid Integer size,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page)

getPollsAsVoter

@RequestMapping(value="/polls/voter",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<VoterPager> getPollsAsVoter(@Valid @RequestParam(value="size",required=false)
 @Valid Integer size,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page)

getRepairQueueData

@RequestMapping(value="/polls/{pollKey}/repairs",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<RepairPager> getRepairQueueData(@PathVariable("pollKey")
 String pollKey,
 @NotNull @Valid @RequestParam(value="repair",required=true)
 @NotNull @Valid String repair,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size)

getTallyUrls

@RequestMapping(value="/polls/{pollKey}/tallies",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<UrlPager> getTallyUrls(@PathVariable("pollKey")
 String pollKey,
 @NotNull @Valid @RequestParam(value="tally",required=true)
 @NotNull @Valid String tally,
 @Valid @RequestParam(value="page",required=false)
 @Valid Integer page,
 @Valid @RequestParam(value="size",required=false)
 @Valid Integer size)

getVoterPollDetails

@RequestMapping(value="/polls/voter/{pollKey}",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<VoterDetail> getVoterPollDetails(@PathVariable("pollKey")
 String pollKey)