com.mulesoft.connectivity.rest.commons.api.connection

Class BaseConnectionProvider

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.connection.BaseConnectionProvider

All Implemented Interfaces:

org.mule.runtime.api.connection.CachedConnectionProvider<RestConnection>, org.mule.runtime.api.connection.ConnectionProvider<RestConnection>, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Direct Known Subclasses:

BaseAuthorizationCodeConnectionProvider, BaseClientCredentialsConnectionProvider, BasicAuthenticationConnectionProvider

public abstract class BaseConnectionProvider
extends Object
implements org.mule.runtime.api.connection.CachedConnectionProvider<RestConnection>, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Base class for Connection providers

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
BaseConnectionProvider()

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.http.api.client.auth.HttpAuthentication	buildAuthentication() Implementations can override this method to specify the authentication mechanism to use.
protected void	configureClient(org.mule.runtime.http.api.client.HttpClientConfiguration.Builder httpConfiguration) Template method that will be invoked just before the httpConfiguration is turned into an actual HttpClient.
RestConnection	connect()
protected RestConnection	createConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.auth.HttpAuthentication authentication, org.mule.runtime.api.util.MultiMap<String,String> defaultQueryParams, org.mule.runtime.api.util.MultiMap<String,String> defaultHeaders) Creates a new RestConnection
void	disconnect(RestConnection restConnection)
abstract String	getBaseUri()
protected String	getConfigName()
protected Integer	getConnectionIdleTimeout()
protected TimeUnit	getConnectionIdleTimeoutUnit()
protected Integer	getConnectionTimeout()
protected TimeUnit	getConnectionTimeoutUnit()
List<RequestHeader>	getDefaultHeaders()
List<QueryParam>	getDefaultQueryParams()
protected Integer	getMaxConnections()
protected HttpProxyConfig	getProxyConfig()
protected int	getResponseBufferSize()
protected Optional<TlsParameterGroup>	getTlsConfig() TLS secured implementations MUST override this method to provide the TlsParameterGroup that configures TLS.
void	initialise()
protected boolean	isStreamResponse()
protected boolean	isUsePersistentConnections()
void	start() Starts the resources related to this connection provider.
void	stop() Stops the started resources related to this connection provider.
org.mule.runtime.api.connection.ConnectionValidationResult	validate(RestConnection restConnection)
protected org.mule.runtime.api.connection.ConnectionValidationResult	validate(RestConnection restConnection, ConnectionValidationSettings settings)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseConnectionProvider

public BaseConnectionProvider()

Method Detail

getBaseUri

public abstract String getBaseUri()

Returns:

The base uri that will be used for all HTTP requests.

initialise

public final void initialise()
                      throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()

Starts the resources related to this connection provider.

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

stop

public void stop()

Stops the started resources related to this connection provider.

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

connect

public final RestConnection connect()
                             throws org.mule.runtime.api.connection.ConnectionException

Specified by:

connect in interface org.mule.runtime.api.connection.ConnectionProvider<RestConnection>

Throws:

org.mule.runtime.api.connection.ConnectionException

createConnection

protected RestConnection createConnection(org.mule.runtime.http.api.client.HttpClient httpClient,
                                          org.mule.runtime.http.api.client.auth.HttpAuthentication authentication,
                                          org.mule.runtime.api.util.MultiMap<String,String> defaultQueryParams,
                                          org.mule.runtime.api.util.MultiMap<String,String> defaultHeaders)

Creates a new RestConnection

Parameters:

httpClient - the client to perform the requests

authentication - a nullable authentication mechanism

Returns:

a new RestConnection

buildAuthentication

protected org.mule.runtime.http.api.client.auth.HttpAuthentication buildAuthentication()

Implementations can override this method to specify the authentication mechanism to use. If not implemented, no authorization will be used.

Returns:

an HttpAuthentication or null

disconnect

public final void disconnect(RestConnection restConnection)

Specified by:

disconnect in interface org.mule.runtime.api.connection.ConnectionProvider<RestConnection>

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(RestConnection restConnection)

Specified by:

validate in interface org.mule.runtime.api.connection.ConnectionProvider<RestConnection>

validate

protected org.mule.runtime.api.connection.ConnectionValidationResult validate(RestConnection restConnection,
                                                                              ConnectionValidationSettings settings)

configureClient

protected void configureClient(org.mule.runtime.http.api.client.HttpClientConfiguration.Builder httpConfiguration)

Template method that will be invoked just before the httpConfiguration is turned into an actual HttpClient. It gives implementations a chance to do extra configurations.

Parameters:

httpConfiguration - the configuration builder for the HttpClient about to be created.

getTlsConfig

protected Optional<TlsParameterGroup> getTlsConfig()

TLS secured implementations MUST override this method to provide the TlsParameterGroup that configures TLS.

Returns:

an optional TlsParameterGroup

getConfigName

protected String getConfigName()

getDefaultHeaders

public List<RequestHeader> getDefaultHeaders()

getDefaultQueryParams

public List<QueryParam> getDefaultQueryParams()

getConnectionTimeout

protected Integer getConnectionTimeout()

getConnectionTimeoutUnit

protected TimeUnit getConnectionTimeoutUnit()

isUsePersistentConnections

protected boolean isUsePersistentConnections()

getMaxConnections

protected Integer getMaxConnections()

getConnectionIdleTimeout

protected Integer getConnectionIdleTimeout()

getConnectionIdleTimeoutUnit

protected TimeUnit getConnectionIdleTimeoutUnit()

getProxyConfig

protected HttpProxyConfig getProxyConfig()

isStreamResponse

protected boolean isStreamResponse()

getResponseBufferSize

protected int getResponseBufferSize()