org.springframework.cloud.dataflow.registry.service

Interface AppRegistryService

All Superinterfaces:

AppRegistryCommon

All Known Implementing Classes:

DefaultAppRegistryService

public interface AppRegistryService
extends AppRegistryCommon

Author:

Christian Tzolov

Method Summary

Modifier and Type	Method and Description
boolean	appExist(String name, ApplicationType type, String version) Checks if an AppRegistration with this name, type and version exists.
void	delete(String name, ApplicationType type, String version) Deletes an AppRegistration.
org.springframework.data.domain.Page<AppRegistration>	findAll(org.springframework.data.domain.Pageable pageable)
org.springframework.data.domain.Page<AppRegistration>	findAllByTypeAndNameIsLike(ApplicationType type, String name, org.springframework.data.domain.Pageable pageable)
AppRegistration	getDefaultApp(String name, ApplicationType type)
AppRegistration	save(String name, ApplicationType type, String version, URI uri, URI metadataUri) Saves a new AppRegistration identified by its name, type, version and URIs.
void	setDefaultApp(String name, ApplicationType type, String version) Set an application with name, type and version as the default for all name:type applications.

Methods inherited from interface org.springframework.cloud.dataflow.registry.AppRegistryCommon

appExist, find, find, findAll, getAppMetadataResource, getAppResource, importAll, save

Method Detail

getDefaultApp

AppRegistration getDefaultApp(String name,
                              ApplicationType type)

Parameters:

name - application name

type - application version

Returns:

the default application for this name:type pair. Returns null if no name:type application exists or if none of the name:type applications is set as default.

setDefaultApp

void setDefaultApp(String name,
                   ApplicationType type,
                   String version)

Set an application with name, type and version as the default for all name:type applications. The previous default name:type application is set to non-default.

Parameters:

name - application name

type - application type

version - application version.

save

AppRegistration save(String name,
                     ApplicationType type,
                     String version,
                     URI uri,
                     URI metadataUri)

Saves a new AppRegistration identified by its name, type, version and URIs.

Parameters:

name - Name of the AppRegistration to save

type - Type of the AppRegistration to save

version - Version of the AppRegistration to save

uri - Resource uri of the AppRegistration to save

metadataUri - metadata of the AppRegistration to save

delete

void delete(String name,
            ApplicationType type,
            String version)

Deletes an AppRegistration. If the AppRegistration does not exist, a NoSuchAppRegistrationException will be thrown.

Parameters:

name - Name of the AppRegistration to delete

type - Type of the AppRegistration to delete

version - Version of the AppRegistration to delete

appExist

boolean appExist(String name,
                 ApplicationType type,
                 String version)

Checks if an AppRegistration with this name, type and version exists.

Parameters:

name - application name

type - application type

version - application version.

findAll

org.springframework.data.domain.Page<AppRegistration> findAll(org.springframework.data.domain.Pageable pageable)

Returns:

returns all AppRegistration's including multiple version for the same application. Uses the pagination.

findAllByTypeAndNameIsLike

org.springframework.data.domain.Page<AppRegistration> findAllByTypeAndNameIsLike(ApplicationType type,
                                                                                 String name,
                                                                                 org.springframework.data.domain.Pageable pageable)

Returns:

returns all AppRegistration versions for given name and type. Uses the pagination.