ch.swaechter.smbjwrapper

Class SmbConnection

java.lang.Object

ch.swaechter.smbjwrapper.SmbConnection

All Implemented Interfaces:

AutoCloseable

public class SmbConnection
extends Object
implements AutoCloseable

This class is responsible for managing the SMB connection and session.

Author:

Simon Wächter

Constructor Summary

Constructors

Constructor and Description
SmbConnection(String serverName, String shareName, com.hierynomus.smbj.auth.AuthenticationContext authenticationContext) Create a new SMB connection to the server with the server name, share name and the authentication context.
SmbConnection(String serverName, String shareName, com.hierynomus.smbj.auth.AuthenticationContext authenticationContext, com.hierynomus.smbj.SmbConfig smbConfig) Create a new SMB connection like normal, but with the ability to pass a custom smbj SMB configuration.
SmbConnection(String serverName, String shareName, com.hierynomus.smbj.auth.AuthenticationContext authenticationContext, com.hierynomus.smbj.SmbConfig smbConfig, boolean delayedInitialization) Create a new SMB connection like normal, but with the ability to pass a custom smbj SMB configuration and to delay the internal creation of the connection.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
void	ensureConnectionIsAlive() Ensure that the connection is alive.
com.hierynomus.smbj.share.DiskShare	getDiskShare() Get the disk share to access the server.
String	getServerName() Get the server name of the server.
String	getShareName() Get the share name of the server.
boolean	isConnectionAlive() Check if the connection to the SMB server is alive.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmbConnection

public SmbConnection(String serverName,
                     String shareName,
                     com.hierynomus.smbj.auth.AuthenticationContext authenticationContext)
              throws IOException

Create a new SMB connection to the server with the server name, share name and the authentication context.

Note: The connection itself is not thread safe. Create a connection for each thread communicating with the SMB server.

Parameters:

serverName - Server name of the server

shareName - Share name of the server

authenticationContext - Authentication used to authenticate against

Throws:

IOException - Exception in case of a problem

SmbConnection

public SmbConnection(String serverName,
                     String shareName,
                     com.hierynomus.smbj.auth.AuthenticationContext authenticationContext,
                     com.hierynomus.smbj.SmbConfig smbConfig)
              throws IOException

Create a new SMB connection like normal, but with the ability to pass a custom smbj SMB configuration.

Note: The connection itself is not thread safe. Create a connection for each thread communicating with the SMB server.

Parameters:

serverName - Server name of the server

shareName - Share name of the server

authenticationContext - Authentication used to authenticate against

smbConfig - Custom SMB/smbj configuration

Throws:

IOException - Exception in case of a problem

SmbConnection

public SmbConnection(String serverName,
                     String shareName,
                     com.hierynomus.smbj.auth.AuthenticationContext authenticationContext,
                     com.hierynomus.smbj.SmbConfig smbConfig,
                     boolean delayedInitialization)
              throws IOException

Create a new SMB connection like normal, but with the ability to pass a custom smbj SMB configuration and to delay the internal creation of the connection. Delaying the connection creation until the first real connection call can be useful if you create many connections at once or in parallel (The internal creation is a resource and time consuming operation). Please not that an invalid connection can only be detected on the first call if the delayed creation is used.

Note: The connection itself is not thread safe. Create a connection for each thread communicating with the SMB server.

Parameters:

serverName - Server name of the server

shareName - Share name of the server

authenticationContext - Authentication used to authenticate against

smbConfig - Custom SMB/smbj configuration

delayedInitialization - Delay the initialization of the connection until the first access. This can be

Throws:

IOException - Exception in case of a problem

Method Detail

getDiskShare

public com.hierynomus.smbj.share.DiskShare getDiskShare()

Get the disk share to access the server. If the connection initialization is delayed, this call will initialize the internal connection.

Returns:

Disk share to access the server

Throws:

RuntimeException - Exception in case of a delayed initialization problem

getServerName

public String getServerName()

Get the server name of the server.

Returns:

Name of the server

getShareName

public String getShareName()

Get the share name of the server.

Returns:

Name of the share

isConnectionAlive

public boolean isConnectionAlive()

Check if the connection to the SMB server is alive.

Returns:

Status of the check

ensureConnectionIsAlive

public void ensureConnectionIsAlive()
                             throws IOException

Ensure that the connection is alive. If the connection is not alive, the internal connection to the SMB server will be recreated. This method is useful for long living SmbConnections with the same object (Like create the connection, do some work, wait multiple hours etc., do another work etc.).

Throws:

IOException - Exception in case of a problem

close

public void close()
           throws IOException

Close the connection.

Specified by:

close in interface AutoCloseable

Throws:

IOException - Exception in case of a problem