org.springframework.cloud.skipper.server.controller

Class SkipperController

java.lang.Object

org.springframework.cloud.skipper.server.controller.SkipperController

@RestController
 @RequestMapping(value="/api")
public class SkipperController
extends Object

REST controller for Skipper server related operations such as install, upgrade, delete, and rollback.

Author:

Mark Pollack, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
SkipperController(ReleaseService releaseService, PackageService packageService)

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.skipper.domain.Release	delete(String releaseName)
org.springframework.cloud.skipper.domain.AboutInfo	getAboutInfo()
void	handleReleaseNotFoundException()
List<org.springframework.cloud.skipper.domain.Release>	history(String releaseName, int maxRevisions)
org.springframework.cloud.skipper.domain.Release	install(org.springframework.cloud.skipper.domain.InstallRequest installRequest)
org.springframework.cloud.skipper.domain.Release	install(Long id, org.springframework.cloud.skipper.domain.InstallProperties installProperties)
List<org.springframework.cloud.skipper.domain.Release>	list()
List<org.springframework.cloud.skipper.domain.Release>	list(String releaseName)
org.springframework.http.ResponseEntity<String>	manifest(String name)
org.springframework.http.ResponseEntity<String>	manifest(String name, int version)
org.springframework.cloud.skipper.domain.Release	rollback(String releaseName, int rollbackVersion)
org.springframework.cloud.skipper.domain.Info	status(String name)
org.springframework.cloud.skipper.domain.Info	status(String name, int version)
org.springframework.cloud.skipper.domain.Release	upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)
org.springframework.cloud.skipper.domain.PackageMetadata	upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipperController

@Autowired
public SkipperController(ReleaseService releaseService,
                                    PackageService packageService)

Method Detail

getAboutInfo

@RequestMapping(path="/about",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.cloud.skipper.domain.AboutInfo getAboutInfo()

upload

@RequestMapping(path="/upload",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.PackageMetadata upload(@RequestBody
                                                                                                                                                                    org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)

install

@RequestMapping(path="/install",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.Release install(@RequestBody
                                                                                                                                                              org.springframework.cloud.skipper.domain.InstallRequest installRequest)

install

@RequestMapping(path="/install/{id}",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.Release install(@PathVariable(value="id")
                                                                                                                                                                   Long id,
                                                                                                                                                                   @RequestBody
                                                                                                                                                                   org.springframework.cloud.skipper.domain.InstallProperties installProperties)

status

@RequestMapping(path="/status/{name}",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.cloud.skipper.domain.Info status(@PathVariable(value="name")
                                                                                                                                                          String name)

status

@RequestMapping(path="/status/{name}/{version}",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.cloud.skipper.domain.Info status(@PathVariable(value="name")
                                                                                                                                                                    String name,
                                                                                                                                                                    @PathVariable(value="version")
                                                                                                                                                                    int version)

manifest

@RequestMapping(path="/manifest/{name}",
                method=GET)
public org.springframework.http.ResponseEntity<String> manifest(@PathVariable(value="name")
                                                                                                                                     String name)

manifest

@RequestMapping(path="/manifest/{name}/{version}",
                method=GET)
public org.springframework.http.ResponseEntity<String> manifest(@PathVariable(value="name")
                                                                                                                                               String name,
                                                                                                                                               @PathVariable(value="version")
                                                                                                                                               int version)

upgrade

@RequestMapping(path="/upgrade",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.Release upgrade(@RequestBody
                                                                                                                                                              org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)

rollback

@RequestMapping(path="/rollback/{name}/{version}",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.Release rollback(@PathVariable(value="name")
                                                                                                                                                                                 String releaseName,
                                                                                                                                                                                 @PathVariable(value="version")
                                                                                                                                                                                 int rollbackVersion)

delete

@RequestMapping(path="/delete/{name}",
                method=POST)
 @ResponseStatus(value=CREATED)
public org.springframework.cloud.skipper.domain.Release delete(@PathVariable(value="name")
                                                                                                                                                                   String releaseName)

history

@RequestMapping(path="/history/{name}/{max}",
                method=GET)
 @ResponseStatus(value=OK)
public List<org.springframework.cloud.skipper.domain.Release> history(@PathVariable(value="name")
                                                                                                                                                                           String releaseName,
                                                                                                                                                                           @PathVariable(value="max")
                                                                                                                                                                           int maxRevisions)

list

@RequestMapping(path="/list",
                method=GET)
 @ResponseStatus(value=OK)
public List<org.springframework.cloud.skipper.domain.Release> list()

list

@RequestMapping(path="/list/{name}",
                method=GET)
 @ResponseStatus(value=OK)
public List<org.springframework.cloud.skipper.domain.Release> list(@PathVariable(value="name")
                                                                                                                                                               String releaseName)

handleReleaseNotFoundException

@ResponseStatus(value=NOT_FOUND,
                reason="Release not found")
 @ExceptionHandler(value=org.springframework.cloud.skipper.ReleaseNotFoundException.class)
public void handleReleaseNotFoundException()