org.lockss.laaws.poller.api

Interface WsApi

All Known Implementing Classes:

WsApiController

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

Method Summary

Modifier and Type	Method and Description
default org.springframework.http.ResponseEntity<String>	deleteHash(String requestId)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getAllHashes()
WsApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getHash(String requestId)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PeerWsResult>>	getPeers(String peerQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PollWsResult>>	getPolls(String pollQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositoryWsResult>>	getRepositories(String repositoryQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositorySpaceWsResult>>	getRepositorySpaces(String repositorySpaceQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.VoteWsResult>>	getVotes(String voteQuery)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	putHash(org.lockss.ws.entities.HasherWsParams hasherWsParams, Boolean isAsynchronous)
default org.springframework.http.ResponseEntity<Void>	putImportFile(String targetBaseUrlPath, String targetUrl, org.springframework.web.multipart.MultipartFile file, List<String> userProperties)

Method Detail

getDelegate

WsApiDelegate getDelegate()

deleteHash

@RequestMapping(value="/ws/hashes/requests/{requestId}",
                produces="application/json",
                method=DELETE)
default org.springframework.http.ResponseEntity<String> deleteHash(@PathVariable(value="requestId")
                                                                                                                                                                                                        String requestId)

getAllHashes

@RequestMapping(value="/ws/hashes",
                produces="multipart/form-data",
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getAllHashes()

getHash

@RequestMapping(value="/ws/hashes/requests/{requestId}",
                produces="multipart/form-data",
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getHash(@PathVariable(value="requestId")
                                                                                                                                                                                                                                   String requestId)

getPeers

@RequestMapping(value="/ws/peers",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PeerWsResult>> getPeers(@NotNull @RequestParam(value="peerQuery",required=true)
                                                                                                                                                                                                                String peerQuery)

getPolls

@RequestMapping(value="/ws/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)

getRepositories

@RequestMapping(value="/ws/aurepositories",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositoryWsResult>> getRepositories(@NotNull @RequestParam(value="repositoryQuery",required=true)
                                                                                                                                                                                                                                      String repositoryQuery)

getRepositorySpaces

@RequestMapping(value="/ws/repositoryspaces",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositorySpaceWsResult>> getRepositorySpaces(@NotNull @RequestParam(value="repositorySpaceQuery",required=true)
                                                                                                                                                                                                                                                 String repositorySpaceQuery)

getVotes

@RequestMapping(value="/ws/votes",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.VoteWsResult>> getVotes(@NotNull @RequestParam(value="voteQuery",required=true)
                                                                                                                                                                                                                String voteQuery)

putHash

@RequestMapping(value="/ws/hashes",
                produces="multipart/form-data",
                method=PUT)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> putHash(@RequestBody
                                                                                                                                                                                                              org.lockss.ws.entities.HasherWsParams hasherWsParams,
                                                                                                                                                                                                              @RequestParam(value="isAsynchronous",required=false,defaultValue="true")
                                                                                                                                                                                                              Boolean isAsynchronous)

putImportFile

@RequestMapping(value="/ws/aus/import",
                produces="application/json",
                consumes="multipart/form-data",
                method=PUT)
default org.springframework.http.ResponseEntity<Void> putImportFile(@RequestParam(value="targetBaseUrlPath",required=true)
                                                                                                                                                                                                                                     String targetBaseUrlPath,
                                                                                                                                                                                                                                     @RequestParam(value="targetUrl",required=true)
                                                                                                                                                                                                                                     String targetUrl,
                                                                                                                                                                                                                                     @RequestPart(value="file",required=true)
                                                                                                                                                                                                                                     org.springframework.web.multipart.MultipartFile file,
                                                                                                                                                                                                                                     @RequestParam(value="userProperties",required=false)
                                                                                                                                                                                                                                     List<String> userProperties)