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

Class RestConnectionProvider<C extends RestConnection>

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.connection.RestConnectionProvider<C>

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseAuthorizationCodeConnectionProvider, BaseBasicAuthenticationConnectionProvider, BaseBearerAuthenticationConnectionProvider, BaseClientCredentialsConnectionProvider

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.http.api.HttpService	httpService

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
RestConnectionProvider()

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.http.api.client.auth.HttpAuthentication	buildAuthentication()
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.
C	connect()
protected abstract C	createConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions) Creates a new connection C
void	disconnect(C connection)
abstract String	getBaseUri()
protected Optional<Integer>	getResponseTimeout()
void	initialise()
protected Optional<Boolean>	isFollowsRedirect()
void	start() Starts the resources related to this connection provider.
void	stop() Stops the started resources related to this connection provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.connection.ConnectionProvider

validate

Field Detail

httpService

@Inject
protected org.mule.runtime.http.api.HttpService httpService

Constructor Detail

RestConnectionProvider

public RestConnectionProvider()

Method Detail

getBaseUri

public abstract String getBaseUri()

Returns:

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

connect

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

Specified by:

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

Throws:

org.mule.runtime.api.connection.ConnectionException

createConnection

protected abstract C createConnection(org.mule.runtime.http.api.client.HttpClient httpClient,
                                      org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions)

Creates a new connection C

Parameters:

httpClient - the client to perform the requests.

httpRequestOptions - the options for the http request client to perfom the requests.

Returns:

a new C

disconnect

public final void disconnect(C connection)

Specified by:

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

initialise

public 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

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.

buildAuthentication

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

Returns:

the HttpAuthentication defined by the connection provider or null. This allows implementations to support custom authentications by defining at the implementation class the parameters for filling the authentication.

getResponseTimeout

protected Optional<Integer> getResponseTimeout()

Returns:

the response timeout at the connection provider to be applied in every request. This allows implementations to decide whether to expose this as a parameter or not in the connection provider. If empty is returned the default from Mule HttpClient will be used.

isFollowsRedirect

protected Optional<Boolean> isFollowsRedirect()

Returns:

the definition for follows redirect at the connection provider to be applied in every request. This allows implementations to decide whether to expose this as a parameter or not in the connection provider. If empty is returned the default from Mule HttpClient will be used.