io.pivotal.cfenv.spring.boot

Interface CfEnvProcessor

All Known Implementing Classes:

AmqpCfEnvProcessor, CassandraCfEnvProcessor, MongoCfEnvProcessor, RedisCfEnvProcessor

public interface CfEnvProcessor

Implementations will be called by CfEnvironmentPostProcessor to find a specific type of service and set Spring Boot properties. Implementation should be registered using the resources/META-INF/spring.factories property file.

Author:

Scott Frederick, Mark Pollack

Method Summary

Modifier and Type	Method and Description
boolean	accept(io.pivotal.cfenv.core.CfService service) Determine if a service is supported by this processor.
CfEnvProcessorProperties	getProperties() Properties describing a CfEnvProcessor, mainly used for better logging messages in CfEnvProcessor.
void	process(io.pivotal.cfenv.core.CfCredentials cfCredentials, Map<String,Object> properties) Given the credentials of the single matching service, set the property values that will be used to create the MapPropertySource.

Method Detail

accept

boolean accept(io.pivotal.cfenv.core.CfService service)

Determine if a service is supported by this processor.

Parameters:

service - a service to inspect

Returns:

true if the service matches criteria; false otherwise

process

void process(io.pivotal.cfenv.core.CfCredentials cfCredentials,
             Map<String,Object> properties)

Given the credentials of the single matching service, set the property values that will be used to create the MapPropertySource.

Parameters:

cfCredentials - Credentials of the single matching service

properties - map to set Spring Boot properties

getProperties

CfEnvProcessorProperties getProperties()

Properties describing a CfEnvProcessor, mainly used for better logging messages in CfEnvProcessor.

Returns:

processor properties