org.springframework.cloud.skipper.client

Class DefaultSkipperClient

java.lang.Object

org.springframework.cloud.skipper.client.DefaultSkipperClient

All Implemented Interfaces:

SkipperClient

public class DefaultSkipperClient
extends Object
implements SkipperClient

The default implementation to communicate with the Skipper Server.

Author:

Mark Pollack, Ilayaperumal Gopinathan, Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultSkipperClient.DeployersResponseWrapper
protected static class	DefaultSkipperClient.HateoasResponseWrapper<T>
protected static class	DefaultSkipperClient.PackageMetadatasResponseWrapper
protected static class	DefaultSkipperClient.ReleasesResponseWrapper
protected static class	DefaultSkipperClient.RepositoriesResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected RestTemplate	restTemplate

Constructor Summary

Constructors

Constructor and Description
DefaultSkipperClient(String baseUri) Create a new DefaultSkipperClient given the URL of the Server.
DefaultSkipperClient(String baseUri, RestTemplate restTemplate) Create a new DefaultSkipperClient given the base URI of the Server and a preconfigured RestTemplate.

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.skipper.domain.CancelResponse	cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest) Sends a cancel request for current release operation
void	delete(String releaseName, boolean deletePackage) Delete a specific release.
org.springframework.cloud.skipper.domain.LogInfo	getLog(String releaseName) Fetch the logs of the latest release identified by the given name.
org.springframework.cloud.skipper.domain.LogInfo	getLog(String releaseName, String appName) Fetch the logs of the latest release identified by the given release name and a specific application name inside the release.
org.springframework.cloud.skipper.domain.Template	getSpringCloudDeployerApplicationTemplate() Return the template for deploying a Spring Boot Application using skipper.
Collection<org.springframework.cloud.skipper.domain.Release>	history(String releaseName) List all releases for the given release name.
org.springframework.cloud.skipper.domain.AboutResource	info()
org.springframework.cloud.skipper.domain.Release	install(org.springframework.cloud.skipper.domain.InstallRequest installRequest) Install the package
List<org.springframework.cloud.skipper.domain.Release>	list(String releaseNameLike) List the latest version of releases with status of deployed or failed.
Collection<org.springframework.cloud.skipper.domain.Deployer>	listDeployers() List Platform Deployers
Collection<org.springframework.cloud.skipper.domain.Repository>	listRepositories() List Package Repositories.
String	manifest(String releaseName) Return the manifest of the last known release.
String	manifest(String releaseName, int releaseVersion) Return a manifest info of a release version.
void	packageDelete(String packageName) Delete a package
org.springframework.cloud.skipper.domain.Release	rollback(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest) Rollback a specific release.
org.springframework.cloud.skipper.domain.Release	rollback(String releaseName, int releaseVersion) Rollback a specific release.
org.springframework.cloud.skipper.domain.Release	scale(String releaseName, org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest) Scale a release with a given scale request.
Collection<org.springframework.cloud.skipper.domain.PackageMetadata>	search(String name, boolean details) Search for package metadata.
Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>>	states(String... releaseNames) Return the deployment state of a last known releases mapped back to release names.
org.springframework.cloud.skipper.domain.Info	status(String releaseName) Return a status info of a last known release.
org.springframework.cloud.skipper.domain.Info	status(String releaseName, int releaseVersion) Return a status info of a release version.
Map<String,org.springframework.cloud.skipper.domain.Info>	statuses(String... releaseNames) Return a status info of a last known releases mapped back to release names.
org.springframework.cloud.skipper.domain.Release	upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest) Upgrade a release.
org.springframework.cloud.skipper.domain.PackageMetadata	upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest) Upload the package.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.skipper.client.SkipperClient

create

Field Detail

restTemplate

protected final RestTemplate restTemplate

Constructor Detail

DefaultSkipperClient

public DefaultSkipperClient(String baseUri)

Create a new DefaultSkipperClient given the URL of the Server. This constructor will create a new RestTemplate instance for communication.

Parameters:

baseUri - the URL of the Server.

DefaultSkipperClient

public DefaultSkipperClient(String baseUri,
                            RestTemplate restTemplate)

Create a new DefaultSkipperClient given the base URI of the Server and a preconfigured RestTemplate.

Parameters:

baseUri - the URI of the Server.

restTemplate - the template to use to make http calls to the server.

Method Detail

getSpringCloudDeployerApplicationTemplate

public org.springframework.cloud.skipper.domain.Template getSpringCloudDeployerApplicationTemplate()

Description copied from interface: SkipperClient

Return the template for deploying a Spring Boot Application using skipper.

Specified by:

getSpringCloudDeployerApplicationTemplate in interface SkipperClient

Returns:

the SpringCloudDeployerApplication template

info

public org.springframework.cloud.skipper.domain.AboutResource info()

Specified by:

info in interface SkipperClient

Returns:

The AboutInfo for the server

status

public org.springframework.cloud.skipper.domain.Info status(String releaseName)

Description copied from interface: SkipperClient

Return a status info of a last known release.

Specified by:

status in interface SkipperClient

Parameters:

releaseName - the release name

Returns:

the status info of a release

statuses

public Map<String,org.springframework.cloud.skipper.domain.Info> statuses(String... releaseNames)

Description copied from interface: SkipperClient

Return a status info of a last known releases mapped back to release names.

Specified by:

statuses in interface SkipperClient

Parameters:

releaseNames - the release names

Returns:

the status info of a releases

states

public Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>> states(String... releaseNames)

Description copied from interface: SkipperClient

Return the deployment state of a last known releases mapped back to release names.

Specified by:

states in interface SkipperClient

Parameters:

releaseNames - the release names

Returns:

the deployment state of a releases

status

public org.springframework.cloud.skipper.domain.Info status(String releaseName,
                                                            int releaseVersion)

Description copied from interface: SkipperClient

Return a status info of a release version.

Specified by:

status in interface SkipperClient

Parameters:

releaseName - the release name

releaseVersion - the release version

Returns:

the status info of a release

getLog

public org.springframework.cloud.skipper.domain.LogInfo getLog(String releaseName)

Description copied from interface: SkipperClient

Fetch the logs of the latest release identified by the given name.

Specified by:

getLog in interface SkipperClient

Parameters:

releaseName - the release name

Returns:

the log content

getLog

public org.springframework.cloud.skipper.domain.LogInfo getLog(String releaseName,
                                                               String appName)

Description copied from interface: SkipperClient

Fetch the logs of the latest release identified by the given release name and a specific application name inside the release.

Specified by:

getLog in interface SkipperClient

Parameters:

releaseName - the release name

appName - the application name

Returns:

the log content

scale

public org.springframework.cloud.skipper.domain.Release scale(String releaseName,
                                                              org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest)

Description copied from interface: SkipperClient

Scale a release with a given scale request.

Specified by:

scale in interface SkipperClient

Parameters:

releaseName - the release name

scaleRequest - the scale request

Returns:

the status info of a release

manifest

public String manifest(String releaseName)

Description copied from interface: SkipperClient

Return the manifest of the last known release. For packages with dependencies, the manifest includes the contents of those dependencies.

Specified by:

manifest in interface SkipperClient

Parameters:

releaseName - the release name

Returns:

the manifest

manifest

public String manifest(String releaseName,
                       int releaseVersion)

Description copied from interface: SkipperClient

Return a manifest info of a release version. For packages with dependencies, the manifest includes the contents of those dependencies.

Specified by:

manifest in interface SkipperClient

Parameters:

releaseName - the release name

releaseVersion - the release version

Returns:

the manifest info of a release

search

public Collection<org.springframework.cloud.skipper.domain.PackageMetadata> search(String name,
                                                                                   boolean details)

Description copied from interface: SkipperClient

Search for package metadata.

Specified by:

search in interface SkipperClient

Parameters:

name - optional name with wildcard support for searching

details - boolean flag to fetch all the metadata

Returns:

the package metadata with the projection set to summary

install

public org.springframework.cloud.skipper.domain.Release install(org.springframework.cloud.skipper.domain.InstallRequest installRequest)

Description copied from interface: SkipperClient

Install the package

Specified by:

install in interface SkipperClient

Parameters:

installRequest - the package install request

Returns:

the installed Release

upgrade

public org.springframework.cloud.skipper.domain.Release upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)

Description copied from interface: SkipperClient

Upgrade a release.

Specified by:

upgrade in interface SkipperClient

Parameters:

upgradeRequest - the request to upgrade the release

Returns:

the upgraded Release

delete

public void delete(String releaseName,
                   boolean deletePackage)

Description copied from interface: SkipperClient

Delete a specific release.

Specified by:

delete in interface SkipperClient

Parameters:

releaseName - the release name

deletePackage - delete package when deleting the release

cancel

public org.springframework.cloud.skipper.domain.CancelResponse cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest)

Description copied from interface: SkipperClient

Sends a cancel request for current release operation

Specified by:

cancel in interface SkipperClient

Parameters:

cancelRequest - the cancel request

Returns:

the cancel response

rollback

public org.springframework.cloud.skipper.domain.Release rollback(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest)

Description copied from interface: SkipperClient

Rollback a specific release.

Specified by:

rollback in interface SkipperClient

Parameters:

rollbackRequest - the rollback request

Returns:

the rolled back Release

rollback

public org.springframework.cloud.skipper.domain.Release rollback(String releaseName,
                                                                 int releaseVersion)

Description copied from interface: SkipperClient

Rollback a specific release.

Specified by:

rollback in interface SkipperClient

Parameters:

releaseName - the release name

releaseVersion - the release version

Returns:

the rolled back Release

See Also:

SkipperClient.rollback(RollbackRequest)

list

public List<org.springframework.cloud.skipper.domain.Release> list(String releaseNameLike)

Description copied from interface: SkipperClient

List the latest version of releases with status of deployed or failed.

Specified by:

list in interface SkipperClient

Parameters:

releaseNameLike - the wildcard name of releases to search for

Returns:

the list of all matching releases

history

public Collection<org.springframework.cloud.skipper.domain.Release> history(String releaseName)

Description copied from interface: SkipperClient

List all releases for the given release name.

Specified by:

history in interface SkipperClient

Parameters:

releaseName - the release name of the release to search for

Returns:

the list of all releases by the given name

listRepositories

public Collection<org.springframework.cloud.skipper.domain.Repository> listRepositories()

Description copied from interface: SkipperClient

List Package Repositories.

Specified by:

listRepositories in interface SkipperClient

Returns:

the list of package repositories

listDeployers

public Collection<org.springframework.cloud.skipper.domain.Deployer> listDeployers()

Description copied from interface: SkipperClient

List Platform Deployers

Specified by:

listDeployers in interface SkipperClient

Returns:

the list of platforms deployers

upload

public org.springframework.cloud.skipper.domain.PackageMetadata upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)

Description copied from interface: SkipperClient

Upload the package.

Specified by:

upload in interface SkipperClient

Parameters:

uploadRequest - the properties for the package upload

Returns:

package metadata for the uploaded package

packageDelete

public void packageDelete(String packageName)

Description copied from interface: SkipperClient

Delete a package

Specified by:

packageDelete in interface SkipperClient

Parameters:

packageName - the name of the package