Package com.adaptris.filesystem.smbj

Class SMBConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.NoOpConnection

com.adaptris.filesystem.smbj.SMBConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

@ComponentProfile(summary="Connection to a SMB Share",
                  since="3.10.1")
public class SMBConnection
extends NoOpConnection

Wraps common functionality for both producers and consumers.

• Stores the authentication
• Stores SMB configuration (such as timeout)
• Keeps an (unconfigurable) cache of connections; 50 entries with an expiry of 15 minutes; to alleviate some of the overhead in create a connection to a remote SMB share.

In the adapter configuration file this class is aliased as smb-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SMBConnection.CloseOnExpiry

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
SMBConnection()

Method Summary

Modifier and Type	Method	Description
protected AuthenticationProvider	authenticationProvider()
protected void	closeConnection()
protected ConfigProvider	config()
protected com.hierynomus.smbj.SMBClient	createClient()
Connector	createOrGetWorker(com.hierynomus.smbj.common.SmbPath path)
AuthenticationProvider	getAuthentication()	The authentication to use for the SMB share.
ConfigProvider	getConfig()	The configuration to apply for SMB
protected void	initConnection()
void	setAuthentication(AuthenticationProvider authentication)	The authentication to use for the SMB share.
void	setConfig(ConfigProvider config)	The configuration to apply for SMB
SMBConnection	withAuthenticationProvider(AuthenticationProvider a)
SMBConnection	withConfig(ConfigProvider c)

Methods inherited from class com.adaptris.core.NoOpConnection

prepareConnection, startConnection, stopConnection

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Details

SMBConnection

public SMBConnection()

Method Details

initConnection

protected void initConnection()
                       throws CoreException

Overrides:

initConnection in class NoOpConnection

Throws:

CoreException

closeConnection

protected void closeConnection()

Overrides:

closeConnection in class NoOpConnection

withAuthenticationProvider

public SMBConnection withAuthenticationProvider(AuthenticationProvider a)

withConfig

public SMBConnection withConfig(ConfigProvider c)

authenticationProvider

protected AuthenticationProvider authenticationProvider()

config

protected ConfigProvider config()

createClient

protected com.hierynomus.smbj.SMBClient createClient()
                                              throws Exception

Throws:

Exception

createOrGetWorker

public Connector createOrGetWorker(com.hierynomus.smbj.common.SmbPath path)
                            throws Exception

Throws:

Exception

getAuthentication

public AuthenticationProvider getAuthentication()

The authentication to use for the SMB share.

If not specified, then the deault is AnonymousAccess.

setAuthentication

public void setAuthentication(AuthenticationProvider authentication)

The authentication to use for the SMB share.

If not specified, then the deault is AnonymousAccess.

getConfig

public ConfigProvider getConfig()

The configuration to apply for SMB

If not specified, then the deault is DefaultConfig.

setConfig

public void setConfig(ConfigProvider config)

The configuration to apply for SMB

If not specified, then the deault is DefaultConfig.