public class

S3ConnectorConnectionManager

extends Object
implements MuleContextAware Initialisable Testable Capabilities MetadataAware ConnectionManager<K, C extends Connection> ProcessAdapter<O>
java.lang.Object
   ↳ org.mule.module.s3.connectivity.S3ConnectorConnectionManager

Class Overview

A S3ConnectorConnectionManager is a wrapper around S3Connector that adds connection management capabilities to the pojo.

Summary

Constants
String DEVKIT_BUILD
String DEVKIT_VERSION
String MODULE_NAME
String MODULE_VERSION
[Expand]
Inherited Constants
From interface org.mule.api.lifecycle.Initialisable
Fields
private String accessKey
private GenericKeyedObjectPool connectionPool Connector Pool
protected PoolingProfile connectionPoolingProfile
protected FlowConstruct flowConstruct Flow Construct
protected MuleContext muleContext Mule Context
private String proxyHost
private String proxyPassword
private Integer proxyPort
private String proxyUsername
protected RetryPolicyTemplate retryPolicyTemplate
private String secretKey
Public Constructors
S3ConnectorConnectionManager()
Public Methods
S3ConnectorConnectionIdentifierAdapter acquireConnection(S3ConnectorConnectionKey key)
DefaultResult buildFailureTestResult(Exception exception)
void destroyConnection(S3ConnectorConnectionKey key, S3ConnectorConnectionIdentifierAdapter connection)
String getAccessKey()
Retrieves accessKey
PoolingProfile getConnectionPoolingProfile()
Retrieves connectionPoolingProfile
S3ConnectorConnectionKey getDefaultConnectionKey()
Retrieve the default connection key
String getDevkitBuild()
Returns the build of the DevKit used to create this module
String getDevkitVersion()
Returns the version of the DevKit used to create this module
FlowConstruct getFlowConstruct()
Retrieves flowConstruct
String getModuleName()
Returns the user-friendly name of this module
String getModuleVersion()
Returns the version of this module
MuleContext getMuleContext()
Retrieves muleContext
<P> ProcessTemplate<P, S3ConnectorConnectionIdentifierAdapter> getProcessTemplate()
String getProxyHost()
Retrieves proxyHost
String getProxyPassword()
Retrieves proxyPassword
Integer getProxyPort()
Retrieves proxyPort
String getProxyUsername()
Retrieves proxyUsername
RetryPolicyTemplate getRetryPolicyTemplate()
Retrieves retryPolicyTemplate
String getSecretKey()
Retrieves secretKey
void initialise()
boolean isCapableOf(Capability capability)
Returns true if this module implements such capability
void releaseConnection(S3ConnectorConnectionKey key, S3ConnectorConnectionIdentifierAdapter connection)
void setAccessKey(String value)
Sets accessKey
void setConnectionPoolingProfile(PoolingProfile value)
Sets connectionPoolingProfile
void setFlowConstruct(FlowConstruct value)
Sets flowConstruct
void setMuleContext(MuleContext value)
Sets muleContext
void setProxyHost(String value)
Sets proxyHost
void setProxyPassword(String value)
Sets proxyPassword
void setProxyPort(Integer value)
Sets proxyPort
void setProxyUsername(String value)
Sets proxyUsername
void setRetryPolicyTemplate(RetryPolicyTemplate value)
Sets retryPolicyTemplate
void setSecretKey(String value)
Sets secretKey
TestResult test()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.mule.api.context.MuleContextAware
From interface org.mule.api.lifecycle.Initialisable
From interface org.mule.common.Testable
From interface org.mule.module.s3.basic.Capabilities
From interface org.mule.module.s3.basic.MetadataAware
From interface org.mule.module.s3.connection.ConnectionManager
From interface org.mule.module.s3.process.ProcessAdapter

Constants

private static final String DEVKIT_BUILD

Constant Value: "3.4.0.1555.8df15c1"

private static final String DEVKIT_VERSION

Constant Value: "3.4.0"

private static final String MODULE_NAME

Constant Value: "Amazon S3"

private static final String MODULE_VERSION

Constant Value: "2.5"

Fields

private String accessKey

private GenericKeyedObjectPool connectionPool

Connector Pool

protected PoolingProfile connectionPoolingProfile

protected FlowConstruct flowConstruct

Flow Construct

protected MuleContext muleContext

Mule Context

private String proxyHost

private String proxyPassword

private Integer proxyPort

private String proxyUsername

protected RetryPolicyTemplate retryPolicyTemplate

private String secretKey

Public Constructors

public S3ConnectorConnectionManager ()

Public Methods

public S3ConnectorConnectionIdentifierAdapter acquireConnection (S3ConnectorConnectionKey key)

Parameters
key
Throws
Exception

public DefaultResult buildFailureTestResult (Exception exception)

Parameters
exception

public void destroyConnection (S3ConnectorConnectionKey key, S3ConnectorConnectionIdentifierAdapter connection)

Parameters
key
connection
Throws
Exception

public String getAccessKey ()

Retrieves accessKey

public PoolingProfile getConnectionPoolingProfile ()

Retrieves connectionPoolingProfile

Returns
  • PoolingProfile representing the pooling parameters

public S3ConnectorConnectionKey getDefaultConnectionKey ()

Retrieve the default connection key

Returns
  • The default connection key

public String getDevkitBuild ()

Returns the build of the DevKit used to create this module

public String getDevkitVersion ()

Returns the version of the DevKit used to create this module

public FlowConstruct getFlowConstruct ()

Retrieves flowConstruct

public String getModuleName ()

Returns the user-friendly name of this module

public String getModuleVersion ()

Returns the version of this module

public MuleContext getMuleContext ()

Retrieves muleContext

public ProcessTemplate<P, S3ConnectorConnectionIdentifierAdapter> getProcessTemplate ()

public String getProxyHost ()

Retrieves proxyHost

public String getProxyPassword ()

Retrieves proxyPassword

public Integer getProxyPort ()

Retrieves proxyPort

public String getProxyUsername ()

Retrieves proxyUsername

public RetryPolicyTemplate getRetryPolicyTemplate ()

Retrieves retryPolicyTemplate

Returns
  • The reconnection strategy

public String getSecretKey ()

Retrieves secretKey

public void initialise ()

public boolean isCapableOf (Capability capability)

Returns true if this module implements such capability

Parameters
capability The capability to test for
Returns
  • True if it does, false otherwise

public void releaseConnection (S3ConnectorConnectionKey key, S3ConnectorConnectionIdentifierAdapter connection)

Parameters
key
connection
Throws
Exception

public void setAccessKey (String value)

Sets accessKey

Parameters
value Value to set

public void setConnectionPoolingProfile (PoolingProfile value)

Sets connectionPoolingProfile

Parameters
value Value to set

public void setFlowConstruct (FlowConstruct value)

Sets flowConstruct

Parameters
value Value to set

public void setMuleContext (MuleContext value)

Sets muleContext

Parameters
value Value to set

public void setProxyHost (String value)

Sets proxyHost

Parameters
value Value to set

public void setProxyPassword (String value)

Sets proxyPassword

Parameters
value Value to set

public void setProxyPort (Integer value)

Sets proxyPort

Parameters
value Value to set

public void setProxyUsername (String value)

Sets proxyUsername

Parameters
value Value to set

public void setRetryPolicyTemplate (RetryPolicyTemplate value)

Sets retryPolicyTemplate

Parameters
value Value to set

public void setSecretKey (String value)

Sets secretKey

Parameters
value Value to set

public TestResult test ()