Package org.lockss.laaws.poller.api

Interface WsApi

All Known Implementing Classes:

WsApiController

@Validated
public interface WsApi

Method Summary

Modifier and Type	Method	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(@NotNull @Valid String peerQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.PollWsResult>>	getPolls(@NotNull @Valid String pollQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositoryWsResult>>	getRepositories(@NotNull @Valid String repositoryQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.RepositorySpaceWsResult>>	getRepositorySpaces(@NotNull @Valid String repositorySpaceQuery)
default org.springframework.http.ResponseEntity<List<org.lockss.ws.entities.VoteWsResult>>	getVotes(@NotNull @Valid String voteQuery)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	putHash(@Valid org.lockss.ws.entities.HasherWsParams body, @Valid Boolean isAsynchronous)
default org.springframework.http.ResponseEntity<Void>	putImportFile(String targetBaseUrlPath, String targetUrl, @Valid org.springframework.web.multipart.MultipartFile file, List<String> userProperties)

Method Details

getDelegate

WsApiDelegate getDelegate()

deleteHash

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

getAllHashes

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

getHash

@RequestMapping(value="/ws/hashes/requests/{requestId}",
                produces={"multipart/form-data","application/json"},
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getHash(@PathVariable("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 @Valid @RequestParam(value="peerQuery",required=true)
 @NotNull @Valid 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 @Valid @RequestParam(value="pollQuery",required=true)
 @NotNull @Valid 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 @Valid @RequestParam(value="repositoryQuery",required=true)
 @NotNull @Valid 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 @Valid @RequestParam(value="repositorySpaceQuery",required=true)
 @NotNull @Valid 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 @Valid @RequestParam(value="voteQuery",required=true)
 @NotNull @Valid String voteQuery)

putHash

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

putImportFile

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