org.springframework.cloud.netflix.ribbon

Class RibbonUtils

java.lang.Object

org.springframework.cloud.netflix.ribbon.RibbonUtils

public final class RibbonUtils
extends Object

Author:

Spencer Gibb, Jacques-Etienne Beaudet, Tim Ysewyn

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAMESPACE Default Ribbon namespace.
static String	VALUE_NOT_SET Used to verify if property value is set.

Method Summary

Modifier and Type	Method and Description
static com.netflix.config.DynamicStringProperty	getProperty(String key)
static String	getRibbonKey(String serviceId, String suffix)
static void	initializeRibbonDefaults(String serviceId)
static boolean	isSecure(com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, com.netflix.loadbalancer.Server server) Determine if client is secure.
static void	setRibbonProperty(String serviceId, String suffix, String value)
static URI	updateToHttpsIfNeeded(URI uri, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, com.netflix.loadbalancer.Server server) Deprecated. use updateToSecureConnectionIfNeeded(java.net.URI, org.springframework.cloud.client.ServiceInstance)
static URI	updateToSecureConnectionIfNeeded(URI uri, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, com.netflix.loadbalancer.Server server) Replace the scheme to the secure variant if needed.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_NOT_SET

public static final String VALUE_NOT_SET

Used to verify if property value is set.

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

Default Ribbon namespace.

See Also:

Constant Field Values

Method Detail

initializeRibbonDefaults

public static void initializeRibbonDefaults(String serviceId)

setRibbonProperty

public static void setRibbonProperty(String serviceId,
                                     String suffix,
                                     String value)

getRibbonKey

public static String getRibbonKey(String serviceId,
                                  String suffix)

getProperty

public static com.netflix.config.DynamicStringProperty getProperty(String key)

isSecure

public static boolean isSecure(com.netflix.client.config.IClientConfig config,
                               ServerIntrospector serverIntrospector,
                               com.netflix.loadbalancer.Server server)

Determine if client is secure. If the supplied IClientConfig has the CommonClientConfigKey.IsSecure set, return that value. Otherwise, query the supplied ServerIntrospector.

Parameters:

config - the supplied client configuration.

serverIntrospector - used to verify if the server provides secure connections

server - to verify

Returns:

true if the client is secure

updateToHttpsIfNeeded

public static URI updateToHttpsIfNeeded(URI uri,
                                        com.netflix.client.config.IClientConfig config,
                                        ServerIntrospector serverIntrospector,
                                        com.netflix.loadbalancer.Server server)

Deprecated. use updateToSecureConnectionIfNeeded(java.net.URI, org.springframework.cloud.client.ServiceInstance)

Replace the scheme to https if needed. If the uri doesn't start with https and isSecure(IClientConfig, ServerIntrospector, Server) is true, update the scheme. This assumes the uri is already encoded to avoid double encoding.

Parameters:

uri - to modify if required

config - Ribbon IClientConfig configuration

serverIntrospector - used to verify if the server provides secure connections

server - to verify

Returns:

URI updated to https if necessary

updateToSecureConnectionIfNeeded

public static URI updateToSecureConnectionIfNeeded(URI uri,
                                                   com.netflix.client.config.IClientConfig config,
                                                   ServerIntrospector serverIntrospector,
                                                   com.netflix.loadbalancer.Server server)

Replace the scheme to the secure variant if needed. If the unsecureSchemeMapping map contains the uri scheme and isSecure(IClientConfig, ServerIntrospector, Server) is true, update the scheme. This assumes the uri is already encoded to avoid double encoding.

Parameters:

uri - to modify if required

config - the supplied client configuration

serverIntrospector - used to verify if the server provides secure connections

server - to verify

Returns:

URI updated if required