Package io.pivotal.spring.cloud.config.client

Interface BinaryResourceConfigClient

All Known Subinterfaces:

ConfigResourceClient

public interface BinaryResourceConfigClient

Provides access to binary resource files served by a Spring Cloud Config Server.

Author:

Craig Walls, Anshul Mehra

Method Summary

Modifier and Type	Method	Description
Resource	getBinaryResource(String path)	Retrieves a binary config file using the defaults profiles and labels.
Resource	getBinaryResource(String profile, String label, String path)	Retrieves a binary config file.

Method Details

getBinaryResource

Resource getBinaryResource(String path)

Retrieves a binary config file using the defaults profiles and labels.

Parameters:

path - config file path relative to spring application folder

Returns:

plain text file retrieved from config server

Throws:

IllegalArgumentException - when application name or Config Server url is undefined.

HttpClientErrorException - when a config file is not found.

getBinaryResource

Resource getBinaryResource(String profile,
 String label,
 String path)

Retrieves a binary config file.

Parameters:

profile - profile name (can be a comma-separated list of profiles)

label - git label

path - config file path relative to spring application folder

Returns:

plain text file retrieved from config server

Throws:

IllegalArgumentException - when application name or Config Server url is undefined.

HttpClientErrorException - when a config file is not found.