Package 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, Chris Schaefer, Chris Bono

  • Method Details

    • list

      org.springframework.hateoas.PagedModel<AppRegistrationResource> list()
      Return a list of all application registrations.
      Returns:
      list of all application registrations

    • list

      org.springframework.hateoas.PagedModel<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, boolean exhaustive)
      Retrieve information about an application registration.
      Parameters:
      name - name of application
      type - application type
      exhaustive - return all metadata, including common Spring Boot properties
      Returns:
      detailed information about an application registration

    • info

      DetailedAppRegistrationResource info(String name, ApplicationType type, String version, boolean exhaustive)
      Retrieve information about an application registration.
      Parameters:
      name - name of application
      type - application type
      version - application version
      exhaustive - return all metadata, including common Spring Boot properties
      Returns:
      detailed information about an application registration

    • register

      @Deprecated AppRegistrationResource register(String name, ApplicationType type, String uri, String metadataUri, boolean force)
      Deprecated.
      Register an application name and type with its Maven coordinates.
      Parameters:
      name - application name
      type - application type
      uri - URI for the application artifact
      metadataUri - URI for the application metadata artifact
      force - if true, overwrites a pre-existing registration
      Returns:
      the new app registration

    • register

      @Deprecated AppRegistrationResource register(String name, ApplicationType type, String version, String uri, String metadataUri, boolean force)
      Deprecated.
      Register an application name, type and version with its Maven coordinates.
      Parameters:
      name - application name
      type - application type
      version - application version
      uri - URI for the application artifact
      metadataUri - URI for the application metadata artifact
      force - if true, overwrites a pre-existing registration
      Returns:
      the new app registration

    • unregister

      void unregister(String name, ApplicationType type)
      Unregister an application name and type.
      Parameters:
      name - application name
      type - application type

    • unregister

      void unregister(String name, ApplicationType type, String version)
      Unregister an application by name type and version
      Parameters:
      name - application name
      type - application type
      version - application version

    • unregisterAll

      void unregisterAll()
      Unregister all applications.

    • makeDefault

      void makeDefault(String name, ApplicationType type, String version)
      Set application version to default
      Parameters:
      name - application name
      type - application type
      version - application version

    • importFromResource

      org.springframework.hateoas.PagedModel<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
      Returns:
      the paged list of new app registrations

    • registerAll

      org.springframework.hateoas.PagedModel<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
      Returns:
      the paged list of new app registrations