jcifs

Interface SmbTransportPool

All Known Implementing Classes:

SmbTransportPoolImpl

public interface SmbTransportPool

This is an internal API for managing pools of SMB connections

Author:

mbechler

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes the pool and all connections in it
byte[]	getChallenge(CIFSContext tc, Address dc) Get NTLM challenge from a server
byte[]	getChallenge(CIFSContext tc, Address dc, int port) Get NTLM challenge from a server
SmbTransport	getSmbTransport(CIFSContext tc, Address address, int port, boolean exclusive) Get transport connection
SmbTransport	getSmbTransport(CIFSContext tc, Address address, int port, boolean exclusive, boolean forceSigning) Get transport connection
SmbTransport	getSmbTransport(CIFSContext tc, Address address, int port, InetAddress localAddr, int localPort, String hostName, boolean exclusive) Get transport connection, with local binding
SmbTransport	getSmbTransport(CIFSContext tc, Address address, int port, InetAddress localAddr, int localPort, String hostName, boolean exclusive, boolean forceSigning)
SmbTransport	getSmbTransport(CIFSContext tf, String name, int port, boolean exclusive, boolean forceSigning)
void	logon(CIFSContext tc, Address dc) Authenticate arbitrary credentials represented by the NtlmPasswordAuthentication object against the domain controller specified by the UniAddress parameter.
void	logon(CIFSContext tc, Address dc, int port) Authenticate arbitrary credentials represented by the NtlmPasswordAuthentication object against the domain controller specified by the UniAddress parameter.
void	removeTransport(SmbTransport trans)

Method Detail

getSmbTransport

SmbTransport getSmbTransport(CIFSContext tf,
                             String name,
                             int port,
                             boolean exclusive,
                             boolean forceSigning)
                      throws UnknownHostException,
                             IOException

Parameters:

tf -

name -

port -

exclusive -

forceSigning -

Returns:

a connected transport

Throws:

UnknownHostException

IOException

getSmbTransport

SmbTransport getSmbTransport(CIFSContext tc,
                             Address address,
                             int port,
                             boolean exclusive)

Get transport connection

Parameters:

tc - context to use

address -

port -

exclusive - whether to acquire an unshared connection

Returns:

a transport connection to the target

getSmbTransport

SmbTransport getSmbTransport(CIFSContext tc,
                             Address address,
                             int port,
                             boolean exclusive,
                             boolean forceSigning)

Get transport connection

Parameters:

tc - context to use

address -

port -

exclusive - whether to acquire an unshared connection

forceSigning - whether to enforce SMB signing on this connection

Returns:

a transport connection to the target

getSmbTransport

SmbTransport getSmbTransport(CIFSContext tc,
                             Address address,
                             int port,
                             InetAddress localAddr,
                             int localPort,
                             String hostName,
                             boolean exclusive)

Get transport connection, with local binding

Parameters:

tc - context to use

address -

port -

localAddr -

localPort -

hostName -

exclusive - whether to acquire an unshared connection

Returns:

a transport connection to the target

getSmbTransport

SmbTransport getSmbTransport(CIFSContext tc,
                             Address address,
                             int port,
                             InetAddress localAddr,
                             int localPort,
                             String hostName,
                             boolean exclusive,
                             boolean forceSigning)

Parameters:

tc - context to use

address -

port -

localAddr -

localPort -

hostName -

exclusive - whether to acquire an unshared connection

forceSigning - whether to enforce SMB signing on this connection

Returns:

a transport connection to the target

removeTransport

void removeTransport(SmbTransport trans)

Parameters:

trans -

close

boolean close()
       throws CIFSException

Closes the pool and all connections in it

Returns:

whether any transport was still in use

Throws:

CIFSException

logon

void logon(CIFSContext tc,
           Address dc)
    throws CIFSException

Authenticate arbitrary credentials represented by the NtlmPasswordAuthentication object against the domain controller specified by the UniAddress parameter. If the credentials are not accepted, an SmbAuthException will be thrown. If an error occurs an SmbException will be thrown. If the credentials are valid, the method will return without throwing an exception. See the last FAQ question.

See also the jcifs.smb.client.logonShare property.

Parameters:

dc -

tc -

Throws:

CIFSException

logon

void logon(CIFSContext tc,
           Address dc,
           int port)
    throws CIFSException

Authenticate arbitrary credentials represented by the NtlmPasswordAuthentication object against the domain controller specified by the UniAddress parameter. If the credentials are not accepted, an SmbAuthException will be thrown. If an error occurs an SmbException will be thrown. If the credentials are valid, the method will return without throwing an exception. See the last FAQ question.

See also the jcifs.smb.client.logonShare property.

Parameters:

dc -

port -

tc -

Throws:

CIFSException

getChallenge

byte[] getChallenge(CIFSContext tc,
                    Address dc)
             throws CIFSException

Get NTLM challenge from a server

Parameters:

dc -

tc -

Returns:

NTLM challenge

Throws:

CIFSException

getChallenge

byte[] getChallenge(CIFSContext tc,
                    Address dc,
                    int port)
             throws CIFSException

Get NTLM challenge from a server

Parameters:

dc -

port -

tc -

Returns:

NTLM challenge

Throws:

CIFSException