public class

SshConnectorConnectionManager

extends Object
implements MuleContextAware Initialisable Capabilities MetadataAware ConnectionManager<K, C extends Connection> ProcessAdapter<O>
java.lang.Object
   ↳ org.mule.modules.ssh.multiplexer.connectivity.SshConnectorConnectionManager

Class Overview

A SshConnectorConnectionManager is a wrapper around SshConnector 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 callbackFlowName
private GenericKeyedObjectPool connectionPool Connector Pool
protected PoolingProfile connectionPoolingProfile
protected FlowConstruct flowConstruct Flow Construct
private String host
protected MuleContext muleContext Mule Context
private String password
private Integer port
private Integer receiverBufferSize
protected RetryPolicyTemplate retryPolicyTemplate
private boolean shellMode
private Integer timeout
private String username
Public Constructors
SshConnectorConnectionManager()
Public Methods
SshConnectorConnectionIdentifierAdapter acquireConnection(SshConnectorConnectionKey key)
void destroyConnection(SshConnectorConnectionKey key, SshConnectorConnectionIdentifierAdapter connection)
String getCallbackFlowName()
Retrieves callbackFlowName
PoolingProfile getConnectionPoolingProfile()
Retrieves connectionPoolingProfile
SshConnectorConnectionKey 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 getHost()
Retrieves host
String getModuleName()
Returns the user-friendly name of this module
String getModuleVersion()
Returns the version of this module
MuleContext getMuleContext()
Retrieves muleContext
String getPassword()
Retrieves password
Integer getPort()
Retrieves port
<P> ProcessTemplate<P, SshConnectorConnectionIdentifierAdapter> getProcessTemplate()
Integer getReceiverBufferSize()
Retrieves receiverBufferSize
RetryPolicyTemplate getRetryPolicyTemplate()
Retrieves retryPolicyTemplate
boolean getShellMode()
Retrieves shellMode
Integer getTimeout()
Retrieves timeout
String getUsername()
Retrieves username
void initialise()
boolean isCapableOf(Capability capability)
Returns true if this module implements such capability
void releaseConnection(SshConnectorConnectionKey key, SshConnectorConnectionIdentifierAdapter connection)
void setCallbackFlowName(String value)
Sets callbackFlowName
void setConnectionPoolingProfile(PoolingProfile value)
Sets connectionPoolingProfile
void setFlowConstruct(FlowConstruct value)
Sets flowConstruct
void setHost(String value)
Sets host
void setMuleContext(MuleContext value)
Sets muleContext
void setPassword(String value)
Sets password
void setPort(Integer value)
Sets port
void setReceiverBufferSize(Integer value)
Sets receiverBufferSize
void setRetryPolicyTemplate(RetryPolicyTemplate value)
Sets retryPolicyTemplate
void setShellMode(boolean value)
Sets shellMode
void setTimeout(Integer value)
Sets timeout
void setUsername(String value)
Sets username
[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.modules.ssh.multiplexer.basic.Capabilities
From interface org.mule.modules.ssh.multiplexer.basic.MetadataAware
From interface org.mule.modules.ssh.multiplexer.connection.ConnectionManager
From interface org.mule.modules.ssh.multiplexer.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: "SSH"

private static final String MODULE_VERSION

Constant Value: "1.2.1"

Fields

private String callbackFlowName

private GenericKeyedObjectPool connectionPool

Connector Pool

protected PoolingProfile connectionPoolingProfile

protected FlowConstruct flowConstruct

Flow Construct

private String host

protected MuleContext muleContext

Mule Context

private String password

private Integer port

private Integer receiverBufferSize

protected RetryPolicyTemplate retryPolicyTemplate

private boolean shellMode

private Integer timeout

private String username

Public Constructors

public SshConnectorConnectionManager ()

Public Methods

public SshConnectorConnectionIdentifierAdapter acquireConnection (SshConnectorConnectionKey key)

Parameters
key
Throws
Exception

public void destroyConnection (SshConnectorConnectionKey key, SshConnectorConnectionIdentifierAdapter connection)

Parameters
key
connection
Throws
Exception

public String getCallbackFlowName ()

Retrieves callbackFlowName

public PoolingProfile getConnectionPoolingProfile ()

Retrieves connectionPoolingProfile

Returns
  • PoolingProfile representing the pooling parameters

public SshConnectorConnectionKey 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 getHost ()

Retrieves host

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 String getPassword ()

Retrieves password

public Integer getPort ()

Retrieves port

public ProcessTemplate<P, SshConnectorConnectionIdentifierAdapter> getProcessTemplate ()

public Integer getReceiverBufferSize ()

Retrieves receiverBufferSize

public RetryPolicyTemplate getRetryPolicyTemplate ()

Retrieves retryPolicyTemplate

Returns
  • The reconnection strategy

public boolean getShellMode ()

Retrieves shellMode

public Integer getTimeout ()

Retrieves timeout

public String getUsername ()

Retrieves username

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 (SshConnectorConnectionKey key, SshConnectorConnectionIdentifierAdapter connection)

Parameters
key
connection
Throws
Exception

public void setCallbackFlowName (String value)

Sets callbackFlowName

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 setHost (String value)

Sets host

Parameters
value Value to set

public void setMuleContext (MuleContext value)

Sets muleContext

Parameters
value Value to set

public void setPassword (String value)

Sets password

Parameters
value Value to set

public void setPort (Integer value)

Sets port

Parameters
value Value to set

public void setReceiverBufferSize (Integer value)

Sets receiverBufferSize

Parameters
value Value to set

public void setRetryPolicyTemplate (RetryPolicyTemplate value)

Sets retryPolicyTemplate

Parameters
value Value to set

public void setShellMode (boolean value)

Sets shellMode

Parameters
value Value to set

public void setTimeout (Integer value)

Sets timeout

Parameters
value Value to set

public void setUsername (String value)

Sets username

Parameters
value Value to set