org.springframework.cloud.netflix.turbine

Class CommonsInstanceDiscovery

java.lang.Object

org.springframework.cloud.netflix.turbine.CommonsInstanceDiscovery

All Implemented Interfaces:

com.netflix.turbine.discovery.InstanceDiscovery

Direct Known Subclasses:

EurekaInstanceDiscovery

public class CommonsInstanceDiscovery
extends Object
implements com.netflix.turbine.discovery.InstanceDiscovery

Class that encapsulates an InstanceDiscovery implementation that uses Spring Cloud Commons (see https://github.com/spring-cloud/spring-cloud-commons) The plugin requires a list of applications configured. It then queries the set of instances for * each application. Instance information retrieved from the DiscoveryClient must be translated to * something that Turbine can understand i.e the Instance class.

All the logic to perform this translation can be overriden here, so that you can provide your own implementation if needed.

Author:

Spencer Gibb

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FUSED_HOST_PORT_KEY
protected static String	PORT_KEY
protected static String	SECURE_PORT_KEY

Fields inherited from interface com.netflix.turbine.discovery.InstanceDiscovery

TURBINE_AGGREGATOR_CLUSTER_CONFIG

Constructor Summary

Constructors

Modifier	Constructor and Description
	CommonsInstanceDiscovery(TurbineProperties turbineProperties, org.springframework.cloud.client.discovery.DiscoveryClient discoveryClient)
protected	CommonsInstanceDiscovery(TurbineProperties turbineProperties, String defaultExpression)

Method Summary

Modifier and Type	Method and Description
protected void	addMetadata(com.netflix.turbine.discovery.Instance instance, String hostname, String port, boolean securePortEnabled, String securePort, Map<String,String> metadata)
protected String	getClusterName(Object object) Helper that fetches the cluster name.
protected org.springframework.expression.Expression	getClusterNameExpression()
protected com.netflix.turbine.discovery.Instance	getInstance(String hostname, String port, String cluster, Boolean status)
Collection<com.netflix.turbine.discovery.Instance>	getInstanceList() Method that queries DiscoveryClient for a list of configured application names
protected List<com.netflix.turbine.discovery.Instance>	getInstancesForApp(String serviceId) helper that fetches the Instances for each application from DiscoveryClient.
TurbineProperties	getTurbineProperties()
protected boolean	isCombineHostPort()

Methods inherited from class java.lang.Object

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

Field Detail

PORT_KEY

protected static final String PORT_KEY

See Also:

Constant Field Values

SECURE_PORT_KEY

protected static final String SECURE_PORT_KEY

See Also:

Constant Field Values

FUSED_HOST_PORT_KEY

protected static final String FUSED_HOST_PORT_KEY

See Also:

Constant Field Values

Constructor Detail

CommonsInstanceDiscovery

public CommonsInstanceDiscovery(TurbineProperties turbineProperties,
                                org.springframework.cloud.client.discovery.DiscoveryClient discoveryClient)

CommonsInstanceDiscovery

protected CommonsInstanceDiscovery(TurbineProperties turbineProperties,
                                   String defaultExpression)

Method Detail

getClusterNameExpression

protected org.springframework.expression.Expression getClusterNameExpression()

getTurbineProperties

public TurbineProperties getTurbineProperties()

isCombineHostPort

protected boolean isCombineHostPort()

getInstanceList

public Collection<com.netflix.turbine.discovery.Instance> getInstanceList()
                                                                   throws Exception

Method that queries DiscoveryClient for a list of configured application names

Specified by:

getInstanceList in interface com.netflix.turbine.discovery.InstanceDiscovery

Returns:

Collection

Throws:

Exception

getInstancesForApp

protected List<com.netflix.turbine.discovery.Instance> getInstancesForApp(String serviceId)
                                                                   throws Exception

helper that fetches the Instances for each application from DiscoveryClient.

Parameters:

serviceId -

Returns:

List

Throws:

Exception

addMetadata

protected void addMetadata(com.netflix.turbine.discovery.Instance instance,
                           String hostname,
                           String port,
                           boolean securePortEnabled,
                           String securePort,
                           Map<String,String> metadata)

getInstance

protected com.netflix.turbine.discovery.Instance getInstance(String hostname,
                                                             String port,
                                                             String cluster,
                                                             Boolean status)

getClusterName

protected String getClusterName(Object object)

Helper that fetches the cluster name. Cluster is a Turbine concept and not a commons concept. By default we choose the amazon serviceId as the cluster. A custom implementation can be plugged in by overriding this method.