org.lockss.laaws.poller.api

Interface PollsApi

All Known Implementing Classes:

PollsApiController

@Validated
 @RequestMapping(value="")
public interface PollsApi

Method Summary

Modifier and Type	Method and Description
default org.springframework.http.ResponseEntity<String>	callPoll(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, String urls, Integer page, Integer size)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PollWsResult>>	getPolls(String pollQuery)
default org.springframework.http.ResponseEntity<PollerPager>	getPollsAsPoller(Integer size, Integer page)
default org.springframework.http.ResponseEntity<VoterPager>	getPollsAsVoter(Integer size, Integer page)
default org.springframework.http.ResponseEntity<PollerSummary>	getPollStatus(String psId)
default org.springframework.http.ResponseEntity<RepairPager>	getRepairQueueData(String pollKey, String repair, Integer page, Integer size)
default org.springframework.http.ResponseEntity<UrlPager>	getTallyUrls(String pollKey, String tally, Integer page, Integer size)
default org.springframework.http.ResponseEntity<VoterDetail>	getVoterPollDetails(String pollKey)

Method Detail

getDelegate

PollsApiDelegate getDelegate()

callPoll

@RequestMapping(value="/polls",
                produces="application/json",
                consumes="application/json",
                method=POST)
default org.springframework.http.ResponseEntity<String> callPoll(@RequestBody
                                                                                                                                                                                                                        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(value="psId")
                                                                                                                                                                                    String psId)

getPollPeerVoteUrls

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

getPollStatus

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

getPollerPollDetails

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

getPolls

@RequestMapping(value="/polls",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PollWsResult>> getPolls(@NotNull @RequestParam(value="pollQuery",required=true)
                                                                                                                                                                                                             String pollQuery)

getPollsAsPoller

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

getPollsAsVoter

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

getRepairQueueData

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

getTallyUrls

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

getVoterPollDetails

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