org.springframework.cloud.config.server.resource

Class ResourceController

java.lang.Object

org.springframework.cloud.config.server.resource.ResourceController

@RestController
 @RequestMapping(method=GET,
                path="${spring.cloud.config.server.prefix:}")
public class ResourceController
extends Object

An HTTP endpoint for serving up templated plain text resources from an underlying repository. Can be used to supply config files for consumption by a wide variety of applications and services. A ResourceRepository is used to locate a Resource, specific to an application, and the contents are transformed to text. Then an EnvironmentRepository is used to supply key-value pairs which are used to replace placeholders in the resource text.

Author:

Dave Syer, Daniel Lavoie

Constructor Summary

Constructors

Constructor and Description
ResourceController(ResourceRepository resourceRepository, EnvironmentRepository environmentRepository)
ResourceController(ResourceRepository resourceRepository, EnvironmentRepository environmentRepository, Map<String,ResourceEncryptor> resourceEncryptorMap)

Method Summary

Modifier and Type	Method and Description
byte[]	binary(String name, String profile, org.springframework.web.context.request.ServletWebRequest request)
byte[]	binary(String name, String profile, String label, org.springframework.web.context.request.ServletWebRequest request)
void	notFound(NoSuchResourceException e)
String	retrieve(String name, String profile, org.springframework.web.context.request.ServletWebRequest request, boolean resolvePlaceholders)
String	retrieve(String name, String profile, String label, org.springframework.web.context.request.ServletWebRequest request, boolean resolvePlaceholders)
void	setEncryptEnabled(boolean encryptEnabled)
void	setPlainTextEncryptEnabled(boolean plainTextEncryptEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceController

public ResourceController(ResourceRepository resourceRepository,
                          EnvironmentRepository environmentRepository,
                          Map<String,ResourceEncryptor> resourceEncryptorMap)

ResourceController

public ResourceController(ResourceRepository resourceRepository,
                          EnvironmentRepository environmentRepository)

Method Detail

setEncryptEnabled

public void setEncryptEnabled(boolean encryptEnabled)

setPlainTextEncryptEnabled

public void setPlainTextEncryptEnabled(boolean plainTextEncryptEnabled)

retrieve

@RequestMapping(value="/{name}/{profile}/{label}/**")
public String retrieve(@PathVariable
                                                                             String name,
                                                                             @PathVariable
                                                                             String profile,
                                                                             @PathVariable
                                                                             String label,
                                                                             org.springframework.web.context.request.ServletWebRequest request,
                                                                             @RequestParam(defaultValue="true")
                                                                             boolean resolvePlaceholders)
                                                                      throws IOException

Throws:

IOException

retrieve

@RequestMapping(value="/{name}/{profile}/**",
                params="useDefaultLabel")
public String retrieve(@PathVariable
                                                                                                               String name,
                                                                                                               @PathVariable
                                                                                                               String profile,
                                                                                                               org.springframework.web.context.request.ServletWebRequest request,
                                                                                                               @RequestParam(defaultValue="true")
                                                                                                               boolean resolvePlaceholders)
                                                                                                        throws IOException

Throws:

IOException

binary

@RequestMapping(value="/{name}/{profile}/{label}/**",
                produces="application/octet-stream")
public byte[] binary(@PathVariable
                                                                                                                                String name,
                                                                                                                                @PathVariable
                                                                                                                                String profile,
                                                                                                                                @PathVariable
                                                                                                                                String label,
                                                                                                                                org.springframework.web.context.request.ServletWebRequest request)
                                                                                                                         throws IOException

Throws:

IOException

binary

@RequestMapping(value="/{name}/{profile}/**",
                params="useDefaultLabel",
                produces="application/octet-stream")
public byte[] binary(@PathVariable
                                                                                                                                                                  String name,
                                                                                                                                                                  @PathVariable
                                                                                                                                                                  String profile,
                                                                                                                                                                  org.springframework.web.context.request.ServletWebRequest request)
                                                                                                                                                           throws IOException

Throws:

IOException

notFound

@ExceptionHandler(value=NoSuchResourceException.class)
 @ResponseStatus(value=NOT_FOUND)
public void notFound(NoSuchResourceException e)