Module com.rabbitmq.http.client

Package com.rabbitmq.http.client

Class ClientParameters

java.lang.Object

com.rabbitmq.http.client.ClientParameters

public class ClientParameters
extends Object

Parameters to create an instance of Client.

Since:

3.6.0

Constructor Summary

Constructors

Constructor	Description
ClientParameters()

Method Summary

Modifier and Type	Method	Description
HttpLayer.HttpLayerFactory	getHttpLayerFactory()
String	getPassword()
RestTemplateConfigurator	getRestTemplateConfigurator()	Deprecated, for removal: This API element is subject to removal in a future version. use httpLayerFactory instead
URL	getUrl()
String	getUsername()
ClientParameters	httpLayerFactory(HttpLayer.HttpLayerFactory httpLayerFactory)	Set the HttpLayer.HttpLayerFactory to use.
ClientParameters	password(String password)	Set the password to use when authenticating.
ClientParameters	restTemplateConfigurator(RestTemplateConfigurator restTemplateConfigurator)	Deprecated, for removal: This API element is subject to removal in a future version. use httpLayerFactory instead
ClientParameters	url(String url)	Set the URL to use.
ClientParameters	url(URL url)	Set the URL to use.
ClientParameters	username(String username)	Set the username to use when authenticating.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientParameters

public ClientParameters()

Method Detail

url

public ClientParameters url(URL url)

Set the URL to use.

It is not expected that the URL contains any user info. Use url(String) user info must be extracted from the URL and assigned to username and password.

Parameters:

url - the URL

Returns:

this client parameters instance

url

public ClientParameters url(String url)
                     throws MalformedURLException

Set the URL to use.

The URL can contain user info. If so, they are automatically assigned to the username and password properties of this instance.

Parameters:

url - the URL

Returns:

this client parameters instance

Throws:

MalformedURLException - for a badly formed URL.

username

public ClientParameters username(String username)

Set the username to use when authenticating.

Parameters:

username - the username

Returns:

this client parameters instance

password

public ClientParameters password(String password)

Set the password to use when authenticating.

Parameters:

password - the password

Returns:

this client parameters instance

restTemplateConfigurator

@Deprecated(since="4.0.0",
            forRemoval=true)
public ClientParameters restTemplateConfigurator(RestTemplateConfigurator restTemplateConfigurator)

Deprecated, for removal: This API element is subject to removal in a future version.

use httpLayerFactory instead

Set a RestTemplateConfigurator to post-process the Client's RestTemplate.

The default is to use HttpComponentsRestTemplateConfigurator and so using HttpComponentsClientHttpRequestFactory in the RestTemplate to create requests.

Parameters:

restTemplateConfigurator - the configurator to use

Returns:

this client parameters instance

See Also:

RestTemplateConfigurator

getUrl

public URL getUrl()

getUsername

public String getUsername()

getPassword

public String getPassword()

getRestTemplateConfigurator

@Deprecated(since="4.0.0",
            forRemoval=true)
public RestTemplateConfigurator getRestTemplateConfigurator()

Deprecated, for removal: This API element is subject to removal in a future version.

use httpLayerFactory instead

Returns:

getHttpLayerFactory

public HttpLayer.HttpLayerFactory getHttpLayerFactory()

httpLayerFactory

public ClientParameters httpLayerFactory(HttpLayer.HttpLayerFactory httpLayerFactory)

Set the HttpLayer.HttpLayerFactory to use.

Parameters:

httpLayerFactory -

Returns:

this client parameters instance

See Also:

JdkHttpClientHttpLayer.configure()