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.Startable, org.mule.runtime.api.lifecycle.Stoppable

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

Field Summary

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 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) Creates a new connection C
void	disconnect(C connection)
abstract String	getBaseUri()
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(C connection)

Methods inherited from class java.lang.Object

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

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)

Creates a new connection C

Parameters:

httpClient - the client to perform 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>

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(C connection)

Specified by:

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

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.