org.lockss.laaws.poller.impl

Class PollsApiServiceImpl

java.lang.Object

org.lockss.laaws.poller.impl.PollsApiServiceImpl

All Implemented Interfaces:

PollsApiDelegate

@Service
public class PollsApiServiceImpl
extends Object
implements PollsApiDelegate

The Polls api service.

Field Summary

Fields inherited from interface org.lockss.laaws.poller.api.PollsApiDelegate

log

Constructor Summary

Constructors

Constructor and Description
PollsApiServiceImpl()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<String>	callPoll(org.lockss.util.rest.poller.PollDesc body) Call a new poll
org.springframework.http.ResponseEntity<Void>	cancelPoll(String psId) Cancel Poll a previously called poll
org.springframework.http.ResponseEntity<PollerDetail>	getPollerPollDetails(String pollKey) Get the detailed description of a Poller poll.
org.springframework.http.ResponseEntity<UrlPager>	getPollPeerVoteUrls(String pollKey, String peerId, String urls, Integer page, Integer size) Get a Participant peers's urls for a Poller
org.springframework.http.ResponseEntity	getPolls(String pollQuery) Provides the selected properties of selected polls.
org.springframework.http.ResponseEntity<PollerPager>	getPollsAsPoller(Integer size, Integer page) Get the Polls for which we are the poller.
org.springframework.http.ResponseEntity<VoterPager>	getPollsAsVoter(Integer size, Integer page) Get the Polls for which we are only a voter.
org.springframework.http.ResponseEntity<PollerSummary>	getPollStatus(String psId) Return the current status of a poll.
org.springframework.http.ResponseEntity<RepairPager>	getRepairQueueData(String pollKey, String repair, Integer page, Integer size) Return details of form the RepairQueue of a called poll.
org.springframework.http.ResponseEntity<UrlPager>	getTallyUrls(String pollKey, String tally, Integer page, Integer size) Return the Tallied Urls.
org.springframework.http.ResponseEntity<VoterDetail>	getVoterPollDetails(String pollKey) Get the detailed description of a Poller poll.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lockss.laaws.poller.api.PollsApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Constructor Detail

PollsApiServiceImpl

public PollsApiServiceImpl()

Method Detail

callPoll

public org.springframework.http.ResponseEntity<String> callPoll(org.lockss.util.rest.poller.PollDesc body)

Call a new poll

Specified by:

callPoll in interface PollsApiDelegate

Parameters:

body - a description of the poll to call

Returns:

the identifier for this poll.

See Also:

PollsApi.callPoll(org.lockss.util.rest.poller.PollDesc)

cancelPoll

public org.springframework.http.ResponseEntity<Void> cancelPoll(String psId)

Cancel Poll a previously called poll

Specified by:

cancelPoll in interface PollsApiDelegate

Parameters:

psId - the poll service id of the called poll

Returns:

Void.

See Also:

PollsApi.cancelPoll(java.lang.String)

getPollStatus

public org.springframework.http.ResponseEntity<PollerSummary> getPollStatus(String psId)

Return the current status of a poll.

Specified by:

getPollStatus in interface PollsApiDelegate

Parameters:

psId - The poll service id of the called poll

Returns:

A summary of the current Polls status.

See Also:

PollsApi.getPollStatus(java.lang.String)

getPollerPollDetails

public org.springframework.http.ResponseEntity<PollerDetail> getPollerPollDetails(String pollKey)

Get the detailed description of a Poller poll.

Specified by:

getPollerPollDetails in interface PollsApiDelegate

Parameters:

pollKey - the PollKey assigned by the Poll Manager

Returns:

A PollerPoll detail.

See Also:

PollsApi.getPollerPollDetails(java.lang.String)

getVoterPollDetails

public org.springframework.http.ResponseEntity<VoterDetail> getVoterPollDetails(String pollKey)

Get the detailed description of a Poller poll.

Specified by:

getVoterPollDetails in interface PollsApiDelegate

Parameters:

pollKey - the PollKey assigned by the Poll Manager

Returns:

A VoterPoll detail.

See Also:

PollsApi.getVoterPollDetails(java.lang.String)

getPollPeerVoteUrls

public org.springframework.http.ResponseEntity<UrlPager> getPollPeerVoteUrls(String pollKey,
                                                                             String peerId,
                                                                             String urls,
                                                                             Integer page,
                                                                             Integer size)

Get a Participant peers's urls for a Poller

Specified by:

getPollPeerVoteUrls in interface PollsApiDelegate

Parameters:

pollKey - the PollKey assigned by the Poll Manager

peerId - the id of the peer

urls - the type of urls to return

page - the page number of the paged results

size - the size of the page.

Returns:

A UrlPager of paged urls.

See Also:

PollsApi.getPollPeerVoteUrls(java.lang.String, java.lang.String, java.lang.String, java.lang.Integer, java.lang.Integer)

getRepairQueueData

public org.springframework.http.ResponseEntity<RepairPager> getRepairQueueData(String pollKey,
                                                                               String repair,
                                                                               Integer page,
                                                                               Integer size)

Return details of form the RepairQueue of a called poll.

Specified by:

getRepairQueueData in interface PollsApiDelegate

Parameters:

pollKey - the PollKey assigned by the Poll Manager

repair - the kind of repair data to return.

page - the page number of the paged results

size - the size of the page.

Returns:

A RepairPager of the current page of urls.

See Also:

PollsApi.getRepairQueueData(java.lang.String, java.lang.String, java.lang.Integer, java.lang.Integer)

getTallyUrls

public org.springframework.http.ResponseEntity<UrlPager> getTallyUrls(String pollKey,
                                                                      String tally,
                                                                      Integer page,
                                                                      Integer size)

Return the Tallied Urls.

Specified by:

getTallyUrls in interface PollsApiDelegate

Parameters:

pollKey - the PollKey assigned by the Poll Manager

tally - the kind of tally data to return.

page - the page number of the paged results

size - the size of the page.

Returns:

A UrlPager of paged urls.

See Also:

PollsApi.getTallyUrls(java.lang.String, java.lang.String, java.lang.Integer, java.lang.Integer)

getPollsAsPoller

public org.springframework.http.ResponseEntity<PollerPager> getPollsAsPoller(Integer size,
                                                                             Integer page)

Get the Polls for which we are the poller.

Specified by:

getPollsAsPoller in interface PollsApiDelegate

Parameters:

page - the page number of the paged results

size - the size of the page.

Returns:

A PollPager used to page in the PollerSummary objects.

See Also:

PollsApi.getPollsAsPoller(java.lang.Integer, java.lang.Integer)

getPollsAsVoter

public org.springframework.http.ResponseEntity<VoterPager> getPollsAsVoter(Integer size,
                                                                           Integer page)

Get the Polls for which we are only a voter.

Specified by:

getPollsAsVoter in interface PollsApiDelegate

Parameters:

page - the page number of the paged results

size - the size of the page.

Returns:

A VoterPager used to page in the VoterSummary objects.

See Also:

PollsApi.getPollsAsVoter(java.lang.Integer, java.lang.Integer)

getPolls

public org.springframework.http.ResponseEntity getPolls(String pollQuery)

Provides the selected properties of selected polls.

Specified by:

getPolls in interface PollsApiDelegate

Parameters:

pollQuery - A String with the SQL-like query used to specify what properties to retrieve from which polls.

Returns:

a ResponseEntity<List<PollWsResult>> with the results.

See Also:

PollsApi.getPolls(java.lang.String)