com.netflix.client

Class ClientFactory

java.lang.Object

com.netflix.client.ClientFactory

public class ClientFactory
extends java.lang.Object

A factory that creates client, load balancer and client configuration instances from properties. It also keeps mappings of client names to the created instances.

Constructor Summary

Constructors

Constructor and Description
ClientFactory()

Method Summary

Modifier and Type	Method and Description
static com.netflix.client.IClient	createNamedClient(java.lang.String name, java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass) Creates a named client using a IClientConfig instance created off the configClass class object passed in as the parameter.
static com.netflix.client.IClient	getNamedClient(java.lang.String name) Return the named client from map if already created.
static com.netflix.client.IClient	getNamedClient(java.lang.String name, java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass) Return the named client from map if already created.
static com.netflix.client.config.IClientConfig	getNamedConfig(java.lang.String name) Get the client configuration given the name or create one with the resolved ClientConfigFactory if it does not exist.
static com.netflix.client.config.IClientConfig	getNamedConfig(java.lang.String name, java.lang.Class<? extends com.netflix.client.config.IClientConfig> clientConfigClass) Get the client configuration given the name or create one with clientConfigClass if it does not exist.
static com.netflix.client.config.IClientConfig	getNamedConfig(java.lang.String name, java.util.function.Supplier<com.netflix.client.config.IClientConfig> factory)
static ILoadBalancer	getNamedLoadBalancer(java.lang.String name) Get the load balancer associated with the name, or create one with the default ClientConfigFactory if does not exist
static ILoadBalancer	getNamedLoadBalancer(java.lang.String name, java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass) Get the load balancer associated with the name, or create one with an instance of configClass if does not exist
static java.lang.Object	instantiateInstanceWithClientConfig(java.lang.String className, com.netflix.client.config.IClientConfig clientConfig) Creates instance related to client framework using reflection.
static com.netflix.client.IClient<?,?>	registerClientFromProperties(java.lang.String restClientName, com.netflix.client.config.IClientConfig clientConfig) Utility method to create client and load balancer (if enabled in client config) given the name and client config.
static ILoadBalancer	registerNamedLoadBalancerFromclientConfig(java.lang.String name, com.netflix.client.config.IClientConfig clientConfig) Create and register a load balancer with the name and given the class of configClass.
static ILoadBalancer	registerNamedLoadBalancerFromProperties(java.lang.String name, java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass) Create and register a load balancer with the name and given the class of configClass.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientFactory

public ClientFactory()

Method Detail

registerClientFromProperties

public static com.netflix.client.IClient<?,?> registerClientFromProperties(java.lang.String restClientName,
                                                                           com.netflix.client.config.IClientConfig clientConfig)
                                                                    throws com.netflix.client.ClientException

Utility method to create client and load balancer (if enabled in client config) given the name and client config. Instances are created using reflection (see instantiateInstanceWithClientConfig(String, IClientConfig)

Parameters:

restClientName -

clientConfig -

Throws:

ClientException - if any errors occurs in the process, or if the client with the same name already exists

getNamedClient

public static com.netflix.client.IClient getNamedClient(java.lang.String name)

Return the named client from map if already created. Otherwise creates the client using the configuration returned by getNamedConfig(String).

Throws:

java.lang.RuntimeException - if an error occurs in creating the client.

getNamedClient

public static com.netflix.client.IClient getNamedClient(java.lang.String name,
                                                        java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass)

Return the named client from map if already created. Otherwise creates the client using the configuration returned by createNamedClient(String, Class).

Throws:

java.lang.RuntimeException - if an error occurs in creating the client.

createNamedClient

public static com.netflix.client.IClient createNamedClient(java.lang.String name,
                                                           java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass)
                                                    throws com.netflix.client.ClientException

Creates a named client using a IClientConfig instance created off the configClass class object passed in as the parameter.

Throws:

ClientException - if any error occurs, or if the client with the same name already exists

getNamedLoadBalancer

public static ILoadBalancer getNamedLoadBalancer(java.lang.String name)

Get the load balancer associated with the name, or create one with the default ClientConfigFactory if does not exist

Throws:

java.lang.RuntimeException - if any error occurs

getNamedLoadBalancer

public static ILoadBalancer getNamedLoadBalancer(java.lang.String name,
                                                 java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass)

Get the load balancer associated with the name, or create one with an instance of configClass if does not exist

Throws:

java.lang.RuntimeException - if any error occurs

See Also:

registerNamedLoadBalancerFromProperties(String, Class)

registerNamedLoadBalancerFromclientConfig

public static ILoadBalancer registerNamedLoadBalancerFromclientConfig(java.lang.String name,
                                                                      com.netflix.client.config.IClientConfig clientConfig)
                                                               throws com.netflix.client.ClientException

Create and register a load balancer with the name and given the class of configClass.

Throws:

ClientException - if load balancer with the same name already exists or any error occurs

See Also:

instantiateInstanceWithClientConfig(String, IClientConfig)

registerNamedLoadBalancerFromProperties

public static ILoadBalancer registerNamedLoadBalancerFromProperties(java.lang.String name,
                                                                    java.lang.Class<? extends com.netflix.client.config.IClientConfig> configClass)
                                                             throws com.netflix.client.ClientException

Create and register a load balancer with the name and given the class of configClass.

Throws:

ClientException - if load balancer with the same name already exists or any error occurs

See Also:

instantiateInstanceWithClientConfig(String, IClientConfig)

instantiateInstanceWithClientConfig

public static java.lang.Object instantiateInstanceWithClientConfig(java.lang.String className,
                                                                   com.netflix.client.config.IClientConfig clientConfig)
                                                            throws java.lang.InstantiationException,
                                                                   java.lang.IllegalAccessException,
                                                                   java.lang.ClassNotFoundException

Creates instance related to client framework using reflection. It first checks if the object is an instance of IClientConfigAware and if so invoke IClientConfigAware.initWithNiwsConfig(IClientConfig). If that does not apply, it tries to find if there is a constructor with IClientConfig as a parameter and if so invoke that constructor. If neither applies, it simply invokes the no-arg constructor and ignores the clientConfig parameter.

Parameters:

className - Class name of the object

clientConfig - IClientConfig object used for initialization.

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

getNamedConfig

public static com.netflix.client.config.IClientConfig getNamedConfig(java.lang.String name)

Get the client configuration given the name or create one with the resolved ClientConfigFactory if it does not exist.

See Also:

getNamedConfig(String, Class)

getNamedConfig

public static com.netflix.client.config.IClientConfig getNamedConfig(java.lang.String name,
                                                                     java.lang.Class<? extends com.netflix.client.config.IClientConfig> clientConfigClass)

Get the client configuration given the name or create one with clientConfigClass if it does not exist. An instance of IClientConfig is created and IClientConfig.loadProperties(String) will be called.

getNamedConfig

public static com.netflix.client.config.IClientConfig getNamedConfig(java.lang.String name,
                                                                     java.util.function.Supplier<com.netflix.client.config.IClientConfig> factory)