Class Connection

java.lang.Object

com.hierynomus.smbj.common.Pooled<Connection>

com.hierynomus.smbj.connection.Connection

All Implemented Interfaces:

PacketReceiver<SMBPacketData<?>>, Closeable, AutoCloseable

public class Connection
extends Pooled<Connection>
implements Closeable, PacketReceiver<SMBPacketData<?>>

A connection to a server.

Constructor Summary

Constructors

Constructor	Description
Connection(Connection connection)
Connection(SmbConfig config, SMBClient client, SMBEventBus bus, ServerList serverList)

Method Summary

Modifier and Type	Method	Description
Session	authenticate(AuthenticationContext authContext)	Authenticate the user on this connection in order to start a (new) session.
void	close()
void	close(boolean force)	Close the Connection.
void	connect(String hostname, int port)
SMBClient	getClient()
ConnectionContext	getConnectionContext()
NegotiatedProtocol	getNegotiatedProtocol()	Returns the negotiated protocol details for this connection.
String	getRemoteHostname()
void	handle(SMBPacketData<?> uncheckedPacket)
void	handleError(Throwable t)
boolean	isConnected()
<T extends SMB2Packet> Future<T>	send(SMB2Packet packet)	send a packet.
void	setMessageConverter(SMB2MessageConverter smb2Converter)

Methods inherited from class Pooled

lease, release

Methods inherited from class Object

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

Constructor Details

Connection

public Connection(SmbConfig config,
 SMBClient client,
 SMBEventBus bus,
 ServerList serverList)

Connection

public Connection(Connection connection)

Method Details

getClient

public SMBClient getClient()

connect

public void connect(String hostname,
 int port)
             throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

close

public void close(boolean force)
           throws IOException

Close the Connection. If force is set to true, it forgoes the Session.close() operation on the open sessions, and it just calls the TransportLayer.disconnect().

If force is set to false, the usage counter of the connection reduces with one. If the usage count drops to zero the connection will be closed.

Parameters:

force - if set, does not nicely terminate the open sessions.

Throws:

IOException - If any error occurred during close-ing.

authenticate

public Session authenticate(AuthenticationContext authContext)

Authenticate the user on this connection in order to start a (new) session.

Returns:

a (new) Session that is authenticated for the user.

send

public <T extends SMB2Packet> Future<T> send(SMB2Packet packet)
                                      throws TransportException

send a packet.

Parameters:

packet - SMBPacket to send

Returns:

a Future to be used to retrieve the response packet

Throws:

TransportException - When a transport level error occurred

getNegotiatedProtocol

public NegotiatedProtocol getNegotiatedProtocol()

Returns the negotiated protocol details for this connection.

Returns:

The negotiated protocol details

handle

public void handle(SMBPacketData<?> uncheckedPacket)
            throws TransportException

Specified by:

handle in interface PacketReceiver<SMBPacketData<?>>

Throws:

TransportException

handleError

public void handleError(Throwable t)

Specified by:

handleError in interface PacketReceiver<SMBPacketData<?>>

getRemoteHostname

public String getRemoteHostname()

isConnected

public boolean isConnected()

getConnectionContext

public ConnectionContext getConnectionContext()

setMessageConverter

public void setMessageConverter(SMB2MessageConverter smb2Converter)