com.lucidworks.apollo.component

Class ClientComponent

java.lang.Object

com.lucidworks.apollo.component.ClientComponent

All Implemented Interfaces:

ClientFactory

public class ClientComponent
extends java.lang.Object
implements ClientFactory

Nested Class Summary

Nested classes/interfaces inherited from interface com.lucidworks.apollo.component.ClientFactory

ClientFactory.ContextAwareRESTErrorListener, ClientFactory.RemoteFunction<T,R>, ClientFactory.RemoteRunnable<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RETRIES

Constructor Summary

Constructors

Constructor and Description
ClientComponent(ConfigurationComponent configurationComponent, MetricRegistry metricRegistry, ObjectMapper objectMapper, com.lucidworks.apollo.config.CuratorConfiguration curatorConfiguration, CuratorComponent curator)

Method Summary

Modifier and Type	Method and Description
<T> void	executeWithRetries(java.lang.Class<T> clientResourceClass, ClientFactory.RemoteRunnable<T> toExecute) Deprecated.
<T> <any>	getAllResourceClients(java.lang.Class<T> clazz)
<T> <any>	getAllResourceClients(java.lang.Class<T> clazz, <any> headers)
<T> java.util.List<T>	getAllResourceClients(java.lang.String className)
com.lucidworks.apollo.config.CuratorConfiguration	getCuratorConfiguration()
MetricRegistry	getMetricRegistry()
Client	getOrCreateJerseyClient(java.lang.String clientId)
Client	getOrCreateSystemClient()
<T> <any>	getResourceClient(java.lang.Class<T> clazz)
<T> <any>	getResourceClient(java.lang.Class<T> clazz, <any> headers)
<T> <any>	getResourceClient(java.lang.Class<T> clazz, com.lucidworks.apollo.security.AuthorizationContext authorizationContext)
<T> <any>	getResourceClient(java.lang.String className)
<T> <any>	getResourceClient(java.lang.String className, <any> headers)
<T> <any>	getResourceClientWithQueryParams(java.lang.Class<T> clazz, <any> queryParams)
com.lucidworks.apollo.client.ClientResourceFactory	getResourceFactory() ClientComponent is meant to wrap ClientResourceFactory, so it's ugly to pierce the veil this way, but there are times when we want access to the underlying factory.
<T,R> R	getWithRetries(java.lang.Class<T> clientResourceClass, ClientFactory.RemoteFunction<T,R> toExecute) Deprecated.
void	invalidateClient(java.lang.String key)
<T> void	onResourceAvailable(java.lang.Class<T> clazz, com.lucidworks.apollo.client.ClientResourceFactory.ResourceAvailableCallback<T> callback) If the resource is already available, it will be called immediately.
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RETRIES

public static final int MAX_RETRIES

See Also:

Constant Field Values

Constructor Detail

ClientComponent

public ClientComponent(ConfigurationComponent configurationComponent,
                       MetricRegistry metricRegistry,
                       ObjectMapper objectMapper,
                       com.lucidworks.apollo.config.CuratorConfiguration curatorConfiguration,
                       CuratorComponent curator)
                throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getResourceClient

public <T> <any> getResourceClient(java.lang.Class<T> clazz)

Specified by:

getResourceClient in interface ClientFactory

getResourceClientWithQueryParams

public <T> <any> getResourceClientWithQueryParams(java.lang.Class<T> clazz,
                                                  <any> queryParams)

Specified by:

getResourceClientWithQueryParams in interface ClientFactory

getResourceClient

public <T> <any> getResourceClient(java.lang.Class<T> clazz,
                                   com.lucidworks.apollo.security.AuthorizationContext authorizationContext)

Specified by:

getResourceClient in interface ClientFactory

getResourceClient

public <T> <any> getResourceClient(java.lang.Class<T> clazz,
                                   <any> headers)

Specified by:

getResourceClient in interface ClientFactory

getResourceClient

public <T> <any> getResourceClient(java.lang.String className)
                            throws com.lucidworks.apollo.common.error.RESTError

Specified by:

getResourceClient in interface ClientFactory

Throws:

com.lucidworks.apollo.common.error.RESTError

getAllResourceClients

public <T> <any> getAllResourceClients(java.lang.Class<T> clazz)

Specified by:

getAllResourceClients in interface ClientFactory

getAllResourceClients

public <T> <any> getAllResourceClients(java.lang.Class<T> clazz,
                                       <any> headers)

Specified by:

getAllResourceClients in interface ClientFactory

getAllResourceClients

public <T> java.util.List<T> getAllResourceClients(java.lang.String className)
                                            throws com.lucidworks.apollo.common.error.RESTError

Specified by:

getAllResourceClients in interface ClientFactory

Throws:

com.lucidworks.apollo.common.error.RESTError

getResourceClient

public <T> <any> getResourceClient(java.lang.String className,
                                   <any> headers)
                            throws com.lucidworks.apollo.common.error.RESTError

Specified by:

getResourceClient in interface ClientFactory

Throws:

com.lucidworks.apollo.common.error.RESTError

onResourceAvailable

public <T> void onResourceAvailable(java.lang.Class<T> clazz,
                                    com.lucidworks.apollo.client.ClientResourceFactory.ResourceAvailableCallback<T> callback)

If the resource is already available, it will be called immediately. TODO: same thread, separate thread?

Type Parameters:

T -

Parameters:

clazz -

callback -

getOrCreateSystemClient

public Client getOrCreateSystemClient()

getOrCreateJerseyClient

public Client getOrCreateJerseyClient(java.lang.String clientId)

getMetricRegistry

public MetricRegistry getMetricRegistry()

getResourceFactory

public com.lucidworks.apollo.client.ClientResourceFactory getResourceFactory()

ClientComponent is meant to wrap ClientResourceFactory, so it's ugly to pierce the veil this way, but there are times when we want access to the underlying factory.

Returns:

getCuratorConfiguration

public com.lucidworks.apollo.config.CuratorConfiguration getCuratorConfiguration()

shutdown

@PreDestroy
public void shutdown()
                          throws java.lang.Exception

Throws:

java.lang.Exception

executeWithRetries

@Deprecated
public <T> void executeWithRetries(java.lang.Class<T> clientResourceClass,
                                               ClientFactory.RemoteRunnable<T> toExecute)
                                        throws com.lucidworks.apollo.common.error.RESTError

Deprecated.

Specified by:

executeWithRetries in interface ClientFactory

Throws:

com.lucidworks.apollo.common.error.RESTError

getWithRetries

@Deprecated
public <T,R> R getWithRetries(java.lang.Class<T> clientResourceClass,
                                          ClientFactory.RemoteFunction<T,R> toExecute)
                                   throws com.lucidworks.apollo.common.error.RESTError

Deprecated.

Specified by:

getWithRetries in interface ClientFactory

Throws:

com.lucidworks.apollo.common.error.RESTError

invalidateClient

public void invalidateClient(java.lang.String key)