org.springframework.cloud.dataflow.rest.client

Interface AppRegistryOperations

All Known Implementing Classes:

AppRegistryTemplate

public interface AppRegistryOperations

Interface defining operations available for application registrations.

Author:

Glenn Renfro, Gunnar Hillert, Eric Bottard, Patrick Peralta, Mark Fisher

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.hateoas.PagedResources<AppRegistrationResource>	importFromResource(String uri, boolean force) Register all applications listed in a properties file.
DetailedAppRegistrationResource	info(String name, ApplicationType type) Retrieve information about an application registration.
org.springframework.hateoas.PagedResources<AppRegistrationResource>	list() Return a list of all application registrations.
org.springframework.hateoas.PagedResources<AppRegistrationResource>	list(ApplicationType type) Return a list of all application registrations for the given ApplicationType.
AppRegistrationResource	register(String name, ApplicationType type, String uri, boolean force) Register an application name and type with its Maven coordinates.
org.springframework.hateoas.PagedResources<AppRegistrationResource>	registerAll(Properties apps, boolean force) Register all applications provided as key/value pairs.
void	unregister(String name, ApplicationType type) Unregister an application name and type.

Method Detail

list

org.springframework.hateoas.PagedResources<AppRegistrationResource> list()

Return a list of all application registrations.

Returns:

list of all application registrations

list

org.springframework.hateoas.PagedResources<AppRegistrationResource> list(ApplicationType type)

Return a list of all application registrations for the given ApplicationType.

Parameters:

type - application type for which to return a list of registrations

Returns:

list of all application registrations for the given application type

info

DetailedAppRegistrationResource info(String name,
                                   ApplicationType type)

Retrieve information about an application registration.

Parameters:

name - name of application

type - application type

Returns:

detailed information about an application registration

register

AppRegistrationResource register(String name,
                               ApplicationType type,
                               String uri,
                               boolean force)

Register an application name and type with its Maven coordinates.

Parameters:

name - application name

type - application type

uri - URI for the application artifact

force - if true, overwrites a pre-existing registration

unregister

void unregister(String name,
              ApplicationType type)

Unregister an application name and type.

Parameters:

name - application name

type - application type

importFromResource

org.springframework.hateoas.PagedResources<AppRegistrationResource> importFromResource(String uri,
                                                                                     boolean force)

Register all applications listed in a properties file.

Parameters:

uri - URI for the properties file

force - if true, overwrites any pre-existing registrations

registerAll

org.springframework.hateoas.PagedResources<AppRegistrationResource> registerAll(Properties apps,
                                                                              boolean force)

Register all applications provided as key/value pairs.

Parameters:

apps - the apps as key/value pairs where key is "type.name" and value is a URI

force - if true, overwrites any pre-existing registrations