Package org.lockss.laaws.config.api

Interface ConfigApi

All Known Implementing Classes:

ConfigApiController

@Validated
public interface ConfigApi

Method Summary

Modifier and Type	Method	Description
ConfigApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<OffsetDateTime>	getLastUpdateTime()
default org.springframework.http.ResponseEntity<List<String>>	getLoadedUrlList()
default org.springframework.http.ResponseEntity<org.lockss.ws.entities.PlatformConfigurationWsResult>	getPlatformConfig()
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getSectionConfig(String sectionName, String ifMatch, String ifModifiedSince, String ifNoneMatch, String ifUnmodifiedSince)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getUrlConfig(@NotNull @Valid String url, String ifMatch, String ifModifiedSince, String ifNoneMatch, String ifUnmodifiedSince)
default org.springframework.http.ResponseEntity<Void>	putConfig(String sectionName, @Valid org.springframework.web.multipart.MultipartFile configFile, String ifMatch, String ifModifiedSince, String ifNoneMatch, String ifUnmodifiedSince)
default org.springframework.http.ResponseEntity<Void>	putConfigReload()

Method Details

getDelegate

ConfigApiDelegate getDelegate()

getLastUpdateTime

@RequestMapping(value="/config/lastupdatetime",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<OffsetDateTime> getLastUpdateTime()

getLoadedUrlList

@RequestMapping(value="/config/loadedurls",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<List<String>> getLoadedUrlList()

getPlatformConfig

@RequestMapping(value="/config/platform",
                produces="application/json",
                method=GET)
default org.springframework.http.ResponseEntity<org.lockss.ws.entities.PlatformConfigurationWsResult> getPlatformConfig()

getSectionConfig

@RequestMapping(value="/config/file/{sectionName}",
                produces="multipart/form-data",
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getSectionConfig(@PathVariable("sectionName")
 String sectionName,
 @RequestHeader(value="If-Match",required=false)
 String ifMatch,
 @RequestHeader(value="If-Modified-Since",required=false)
 String ifModifiedSince,
 @RequestHeader(value="If-None-Match",required=false)
 String ifNoneMatch,
 @RequestHeader(value="If-Unmodified-Since",required=false)
 String ifUnmodifiedSince)

getUrlConfig

@RequestMapping(value="/config/url",
                produces="multipart/form-data",
                method=GET)
default org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getUrlConfig(@NotNull @Valid @RequestParam(value="url",required=true)
 @NotNull @Valid String url,
 @RequestHeader(value="If-Match",required=false)
 String ifMatch,
 @RequestHeader(value="If-Modified-Since",required=false)
 String ifModifiedSince,
 @RequestHeader(value="If-None-Match",required=false)
 String ifNoneMatch,
 @RequestHeader(value="If-Unmodified-Since",required=false)
 String ifUnmodifiedSince)

putConfig

@RequestMapping(value="/config/file/{sectionName}",
                consumes="multipart/form-data",
                method=PUT)
default org.springframework.http.ResponseEntity<Void> putConfig(@PathVariable("sectionName")
 String sectionName,
 @Valid @RequestPart(value="configFile",required=true)
 @Valid org.springframework.web.multipart.MultipartFile configFile,
 @RequestHeader(value="If-Match",required=false)
 String ifMatch,
 @RequestHeader(value="If-Modified-Since",required=false)
 String ifModifiedSince,
 @RequestHeader(value="If-None-Match",required=false)
 String ifNoneMatch,
 @RequestHeader(value="If-Unmodified-Since",required=false)
 String ifUnmodifiedSince)

putConfigReload

@RequestMapping(value="/config/reload",
                method=PUT)
default org.springframework.http.ResponseEntity<Void> putConfigReload()