com.sdl.delivery.iq.client.common.config

Class ClientConfiguration

java.lang.Object

com.sdl.delivery.iq.client.common.config.ClientConfiguration

public class ClientConfiguration
extends Object

Configuration of the client. Holds information about client provider type, client class and client connection properties.

Method Summary

Modifier and Type	Method and Description
String	getClientClass() Get the class of client.
String	getCommonIndexPrefix()
int	getConnectTimeout() Get the connection timeout to the remote service.
int	getMaxIdleConnections() Get the number of maximum idle connections to the remote service.
Properties	getProviderProperties() Get properties of the search/index provider.
Provider	getProviderType() Get the type of search/index provider.
int	getReadTimeout() Get the read timeout for a call to the remote service.
int	getWriteTimeout() Get the write timeout for a call to the remote service.
boolean	isClientEmbedded() Returns true if client configuration was marked as embedded.
void	setClientClass(String clientClass) Set the client class.

Methods inherited from class java.lang.Object

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

Method Detail

getCommonIndexPrefix

public String getCommonIndexPrefix()
                            throws com.sdl.delivery.configuration.ConfigurationException

Throws:

com.sdl.delivery.configuration.ConfigurationException

getConnectTimeout

public int getConnectTimeout()

Get the connection timeout to the remote service.

Returns:

the connection timout.

getReadTimeout

public int getReadTimeout()

Get the read timeout for a call to the remote service.

Returns:

the read timeout.

getWriteTimeout

public int getWriteTimeout()

Get the write timeout for a call to the remote service.

Returns:

the write timeout.

getMaxIdleConnections

public int getMaxIdleConnections()

Get the number of maximum idle connections to the remote service.

Returns:

the number of max idle connections.

getClientClass

public String getClientClass()

Get the class of client.

Returns:

the client class

setClientClass

public void setClientClass(String clientClass)

Set the client class.

Parameters:

clientClass - the client class to set.

getProviderType

public Provider getProviderType()

Get the type of search/index provider.

Returns:

the type of provider.

getProviderProperties

public Properties getProviderProperties()

Get properties of the search/index provider.

Returns:

properties of the provider.

isClientEmbedded

public boolean isClientEmbedded()

Returns true if client configuration was marked as embedded.

Returns:

true if embedded configuration.