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

Class BaseClientCredentialsConnectionProvider<C extends OAuthRestConnection>

java.lang.Object

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

com.mulesoft.connectivity.rest.commons.api.connection.oauth.BaseClientCredentialsConnectionProvider<C>

Type Parameters:

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

public abstract class BaseClientCredentialsConnectionProvider<C extends OAuthRestConnection>
extends RestConnectionProvider<C>

Base class for OAuthRestConnections that authenticate using OAuth with the Authorization Client Credentials.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.extension.api.connectivity.oauth.ClientCredentialsState	oauthState

Fields inherited from class com.mulesoft.connectivity.rest.commons.api.connection.RestConnectionProvider

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

Method Summary

Modifier and Type	Method and Description
protected C	createConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions) Override this method if a custom condition needs to be implemented to check if refresh token is needed with a custom implementation of OAuthRestConnection.
protected org.mule.runtime.extension.api.connectivity.oauth.ClientCredentialsState	getOAuthState()

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.connection.RestConnectionProvider

buildAuthentication, configureClient, connect, disconnect, getBaseUri, getResponseTimeout, initialise, isFollowsRedirect, start, stop

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

oauthState

protected org.mule.runtime.extension.api.connectivity.oauth.ClientCredentialsState oauthState

Constructor Detail

BaseClientCredentialsConnectionProvider

public BaseClientCredentialsConnectionProvider()

Method Detail

getOAuthState

protected org.mule.runtime.extension.api.connectivity.oauth.ClientCredentialsState getOAuthState()

createConnection

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

Override this method if a custom condition needs to be implemented to check if refresh token is needed with a custom implementation of OAuthRestConnection.

Specified by:

createConnection in class RestConnectionProvider<C extends OAuthRestConnection>

Parameters:

httpClient - the client to perform the requests.

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

Returns:

a new C connection.