jcifs

Interface SmbTransportPool

All Known Implementing Classes:

SmbTransportPoolImpl

public interface SmbTransportPool

This is an internal interface that may require changes, even in minor versions.

Author:

mbechler

Method Summary

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

void close()
    throws CIFSException

Closes the pool and all connections in it

Throws:

CIFSException

logon

void logon(CIFSContext tc,
           UniAddress dc)
    throws SmbException

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:

SmbException

logon

void logon(CIFSContext tc,
           UniAddress dc,
           int port)
    throws SmbException

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:

SmbException

getChallenge

byte[] getChallenge(CIFSContext tc,
                    UniAddress dc)
             throws SmbException

Get NTLM challenge from a server

Parameters:

dc -

tc -

Returns:

NTLM challenge

Throws:

SmbException

getChallenge

byte[] getChallenge(CIFSContext tc,
                    UniAddress dc,
                    int port)
             throws SmbException

Get NTLM challenge from a server

Parameters:

dc -

port -

tc -

Returns:

NTLM challenge

Throws:

SmbException