org.mule.connectors.restconnect.commons.api.connection

Class BasicAuthenticationConnectionProvider

java.lang.Object

org.mule.connectors.restconnect.commons.api.connection.BaseConnectionProvider

org.mule.connectors.restconnect.commons.api.connection.BasicAuthenticationConnectionProvider

All Implemented Interfaces:

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

Direct Known Subclasses:

DigestConnectionProvider

public abstract class BasicAuthenticationConnectionProvider
extends BaseConnectionProvider

Base class for connection providers which use basic authentication

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	password The password to authenticate the requests
protected String	username The username to authenticate the requests

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationConnectionProvider()

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.

Methods inherited from class org.mule.connectors.restconnect.commons.api.connection.BaseConnectionProvider

configureClient, connect, createConnection, disconnect, getBaseUri, getConfigName, getConnectionIdleTimeout, getConnectionIdleTimeoutUnit, getConnectionTimeout, getConnectionTimeoutUnit, getDefaultHeaders, getDefaultQueryParams, getMaxConnections, getProxyConfig, getResponseBufferSize, getTlsConfig, initialise, isStreamResponse, isUsePersistentConnections, validate

Methods inherited from class java.lang.Object

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

Field Detail

username

@Parameter
 @Optional
 @Summary(value="The username to authenticate the requests")
protected String username

The username to authenticate the requests

password

@Parameter
 @Optional
 @Summary(value="The password to authenticate the requests")
 @Password
protected String password

The password to authenticate the requests

Constructor Detail

BasicAuthenticationConnectionProvider

public BasicAuthenticationConnectionProvider()

Method Detail

buildAuthentication

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

Description copied from class: BaseConnectionProvider

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

Overrides:

buildAuthentication in class BaseConnectionProvider

Returns:

an HttpAuthentication or null