org.alfresco.jlan.smb.server

Class VirtualCircuit

java.lang.Object

org.alfresco.jlan.smb.server.VirtualCircuit

public class VirtualCircuit
extends Object

Virtual Circuit Class

Represents an authenticated circuit on an SMB/CIFS session. There may be multiple virtual circuits opened on a single session/socket connection.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultConnections
static int	InvalidUID
static int	MaxConnections
static SearchContextAdapter	SearchSlotMarker

Constructor Summary

Constructors

Constructor and Description
VirtualCircuit(int vcNum, ClientInfo cInfo) Class constructor

Method Summary

Modifier and Type	Method and Description
int	addConnection(SharedDevice shrDev) Add a new connection to this virtual circuit.
int	allocateSearchSlot() Allocate a slot in the active searches list for a new search.
void	closeCircuit(SrvSession sess) Close the virtual circuit, close active tree connections
void	deallocateSearchSlot(int ctxId) Deallocate the specified search context/slot.
TreeConnection	findConnection(int treeId) Return the tree connection details for the specified tree id.
ClientInfo	getClientInformation() Return the client information
int	getConnectionCount() Return the active tree connection count
SearchContext	getSearchContext(int srchId) Return the search context for the specified search id.
org.alfresco.jlan.smb.server.SrvTransactBuffer	getTransaction() Return the active transaction buffer
int	getUID() Return the virtual circuit UID
int	getVCNumber() Return the virtual circuit number
boolean	hasTransaction() Check if there is an active transaction
boolean	isLoggedOn() Check if the virtual circuit has a valid user logged on
protected void	removeConnection(int treeId, SrvSession sess) Remove the specified tree connection from the active connection list.
void	setLoggedOn(boolean loggedOn) Set the logged on status for the virtual circuit
void	setSearchContext(int slot, SearchContext srch) Store the seach context in the specified slot.
void	setTransaction(org.alfresco.jlan.smb.server.SrvTransactBuffer buf) Set the active transaction buffer
void	setUID(int uid) Set the UID for the circuit
String	toString() Return the virtual circuit details as a string

Methods inherited from class java.lang.Object

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

Field Detail

DefaultConnections

public static final int DefaultConnections

See Also:

Constant Field Values

MaxConnections

public static final int MaxConnections

See Also:

Constant Field Values

InvalidUID

public static final int InvalidUID

See Also:

Constant Field Values

SearchSlotMarker

public static final SearchContextAdapter SearchSlotMarker

Constructor Detail

VirtualCircuit

public VirtualCircuit(int vcNum,
                      ClientInfo cInfo)

Class constructor

Parameters:

vcNum - int

cInfo - ClientInfo

Method Detail

getUID

public final int getUID()

Return the virtual circuit UID

Returns:

int

getVCNumber

public final int getVCNumber()

Return the virtual circuit number

Returns:

int

getClientInformation

public final ClientInfo getClientInformation()

Return the client information

Returns:

ClientInfo

addConnection

public int addConnection(SharedDevice shrDev)
                  throws TooManyConnectionsException

Add a new connection to this virtual circuit. Return the allocated tree id for the new connection.

Parameters:

shrDev - SharedDevice

Returns:

int Allocated tree id (connection id).

Throws:

TooManyConnectionsException

findConnection

public final TreeConnection findConnection(int treeId)

Return the tree connection details for the specified tree id.

Parameters:

treeId - int

Returns:

TreeConnection

removeConnection

protected void removeConnection(int treeId,
                                SrvSession sess)

Remove the specified tree connection from the active connection list.

Parameters:

treeId - int

sess - SrvSession

getConnectionCount

public final int getConnectionCount()

Return the active tree connection count

Returns:

int

allocateSearchSlot

public final int allocateSearchSlot()

Allocate a slot in the active searches list for a new search.

Returns:

int Search slot index, or -1 if there are no more search slots available.

deallocateSearchSlot

public final void deallocateSearchSlot(int ctxId)

Deallocate the specified search context/slot.

Parameters:

ctxId - int

getSearchContext

public final SearchContext getSearchContext(int srchId)

Return the search context for the specified search id.

Parameters:

srchId - int

Returns:

SearchContext

setSearchContext

public final void setSearchContext(int slot,
                                   SearchContext srch)

Store the seach context in the specified slot.

Parameters:

slot - Slot to store the search context.

srch - SearchContext

hasTransaction

public final boolean hasTransaction()

Check if there is an active transaction

Returns:

boolean

getTransaction

public final org.alfresco.jlan.smb.server.SrvTransactBuffer getTransaction()

Return the active transaction buffer

Returns:

TransactBuffer

setTransaction

public final void setTransaction(org.alfresco.jlan.smb.server.SrvTransactBuffer buf)

Set the active transaction buffer

Parameters:

buf - TransactBuffer

setUID

public final void setUID(int uid)

Set the UID for the circuit

Parameters:

uid - int

closeCircuit

public final void closeCircuit(SrvSession sess)

Close the virtual circuit, close active tree connections

Parameters:

sess - SrvSession

isLoggedOn

public final boolean isLoggedOn()

Check if the virtual circuit has a valid user logged on

Returns:

boolean

setLoggedOn

public final void setLoggedOn(boolean loggedOn)

Set the logged on status for the virtual circuit

Parameters:

loggedOn - boolean

toString

public String toString()

Return the virtual circuit details as a string

Overrides:

toString in class Object

Returns:

String