org.alfresco.jlan.server

Class SrvSession

java.lang.Object

org.alfresco.jlan.server.SrvSession

Direct Known Subclasses:

FTPSrvSession, NFSSrvSession, SMBSrvSession

public abstract class SrvSession
extends Object

Server Session Base Class

Base class for server session implementations for different protocols.

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
SrvSession(int sessId, NetworkServer srv, String proto, String remoteName) Class constructor

Method Summary

Modifier and Type	Method and Description
void	addDynamicShare(SharedDevice shrDev) Add a dynamic share to the list of shares created for this session
void	clearTransaction() Clear the stored transaction
void	closeSession() Close the network session
void	debugPrint(String str) Output a string to the debug device
void	debugPrintln(Exception ex) Output an exception stack trace to the debug device
void	debugPrintln(String str) Output a string and a newline to the debug device
void	endTransaction() End a transaction
AuthContext	getAuthenticationContext() Return the authentication context for this sesion
ClientInfo	getClientInformation() Return the client information
Object	getDriverState() Get the Driver State.
SharedDeviceList	getDynamicShareList() Return the list of dynamic shares created for this session
long	getLastIOTime() Return the time of the last I/o on this session
RequestPostProcessor	getNextPostProcessor() Return the post processor at the head of the queue, or null if there are no more post processors queued.
int	getProcessId() Return the process id
String	getProtocolName() Return the protocol name
abstract InetAddress	getRemoteAddress() Return the remote client network address
String	getRemoteName() Return the remote client name
NetworkServer	getServer() Return the server this session is associated with
int	getSessionId() Return the session id for this session.
ThreadLocal<Object>	getTransactionObject() Return the transaction context
String	getUniqueId() Return the unique session id
boolean	hasAuthenticationContext() Check if the session has an authentication context
boolean	hasClientInformation() Check if the session has valid client information
boolean	hasDebug(int dbgFlag) Determine if the specified debug flag is enabled.
boolean	hasDynamicShares() Determine if the session has any dynamic shares
boolean	hasPostProcessorRequests() Check if there are post processor requests queued
boolean	hasProtocolName() Determine if the protocol type has been set
boolean	hasRemoteName() Determine if the remote client name has been set
boolean	hasTransaction() Check if there is an active transaction
void	initializeTransactionObject() Initialize the thread local transaction objects
boolean	isLoggedOn() Determine if the session is logged on/validated
boolean	isPseudoFilesEnabled() Are pseudo files enabled for this session?
boolean	isShutdown() Determine if the session has been shut down
void	setAuthenticationContext(AuthContext ctx) Set the authentication context, used during the initial session setup phase
void	setClientInformation(ClientInfo client) Set the client information
void	setDebug(int flgs) Set the debug output interface.
void	setDebugPrefix(String prefix) Set the debug output prefix for this session
void	setDriverState(Object driverState) Set the Driver State.
void	setLastIOTime(long ioTime) Set the time of hte last I/O on this session
void	setLoggedOn(boolean loggedOn) Set the logged on/validated status for the session
void	setProcessId(int id) Set the process id
void	setProtocolName(String name) Set the protocol name
void	setRemoteName(String name) Set the remote client name
void	setSessionId(int id) Set the session id for this session.
protected void	setShutdown(boolean flg) Set the shutdown flag
void	setTransaction(Object tx, TransactionalFilesystemInterface txIface) Set the active transaction and transaction interface
void	setTransaction(TransactionalFilesystemInterface txIface) Set the active transaction interface
void	setUniqueId(String unid) Set the unique session id
String	toString() Set the Driver State.
abstract boolean	useCaseSensitiveSearch() Determine if the protocol uses case sensitive filesystem searches

Methods inherited from class java.lang.Object

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

Constructor Detail

SrvSession

public SrvSession(int sessId,
                  NetworkServer srv,
                  String proto,
                  String remoteName)

Class constructor

Parameters:

sessId - int

srv - NetworkServer

proto - String

remoteName - String

Method Detail

debugPrint

public final void debugPrint(String str)

Output a string to the debug device

Parameters:

str - String

debugPrintln

public final void debugPrintln(String str)

Output a string and a newline to the debug device

Parameters:

str - String

debugPrintln

public final void debugPrintln(Exception ex)

Output an exception stack trace to the debug device

Parameters:

ex - Exception

hasAuthenticationContext

public final boolean hasAuthenticationContext()

Check if the session has an authentication context

Returns:

boolean

getAuthenticationContext

public final AuthContext getAuthenticationContext()

Return the authentication context for this sesion

Returns:

AuthContext

addDynamicShare

public final void addDynamicShare(SharedDevice shrDev)

Add a dynamic share to the list of shares created for this session

Parameters:

shrDev - SharedDevice

hasDynamicShares

public final boolean hasDynamicShares()

Determine if the session has any dynamic shares

Returns:

boolean

getDynamicShareList

public final SharedDeviceList getDynamicShareList()

Return the list of dynamic shares created for this session

Returns:

SharedDeviceList

getProcessId

public final int getProcessId()

Return the process id

Returns:

int

getRemoteAddress

public abstract InetAddress getRemoteAddress()

Return the remote client network address

Returns:

InetAddress

getSessionId

public final int getSessionId()

Return the session id for this session.

Returns:

int

getServer

public final NetworkServer getServer()

Return the server this session is associated with

Returns:

NetworkServer

hasClientInformation

public final boolean hasClientInformation()

Check if the session has valid client information

Returns:

boolean

getClientInformation

public final ClientInfo getClientInformation()

Return the client information

Returns:

ClientInfo

hasProtocolName

public final boolean hasProtocolName()

Determine if the protocol type has been set

Returns:

boolean

getProtocolName

public final String getProtocolName()

Return the protocol name

Returns:

String

hasRemoteName

public final boolean hasRemoteName()

Determine if the remote client name has been set

Returns:

boolean

getRemoteName

public final String getRemoteName()

Return the remote client name

Returns:

String

isLoggedOn

public final boolean isLoggedOn()

Determine if the session is logged on/validated

Returns:

boolean

isShutdown

public final boolean isShutdown()

Determine if the session has been shut down

Returns:

boolean

getUniqueId

public final String getUniqueId()

Return the unique session id

Returns:

String

hasDebug

public final boolean hasDebug(int dbgFlag)

Determine if the specified debug flag is enabled.

Parameters:

dbgFlag - int

Returns:

boolean

getLastIOTime

public final long getLastIOTime()

Return the time of the last I/o on this session

Returns:

long

hasPostProcessorRequests

public final boolean hasPostProcessorRequests()

Check if there are post processor requests queued

Returns:

boolean

getNextPostProcessor

public final RequestPostProcessor getNextPostProcessor()

Return the post processor at the head of the queue, or null if there are no more post processors queued.

Returns:

RequestPostProcessor

useCaseSensitiveSearch

public abstract boolean useCaseSensitiveSearch()

Determine if the protocol uses case sensitive filesystem searches

Returns:

boolean

setAuthenticationContext

public final void setAuthenticationContext(AuthContext ctx)

Set the authentication context, used during the initial session setup phase

Parameters:

ctx - AuthContext

setClientInformation

public final void setClientInformation(ClientInfo client)

Set the client information

Parameters:

client - ClientInfo

setDebug

public final void setDebug(int flgs)

Set the debug output interface.

Parameters:

flgs - int

setDebugPrefix

public final void setDebugPrefix(String prefix)

Set the debug output prefix for this session

Parameters:

prefix - String

setLoggedOn

public final void setLoggedOn(boolean loggedOn)

Set the logged on/validated status for the session

Parameters:

loggedOn - boolean

setProcessId

public final void setProcessId(int id)

Set the process id

Parameters:

id - int

setProtocolName

public final void setProtocolName(String name)

Set the protocol name

Parameters:

name - String

setRemoteName

public final void setRemoteName(String name)

Set the remote client name

Parameters:

name - String

setSessionId

public final void setSessionId(int id)

Set the session id for this session.

Parameters:

id - int

setUniqueId

public final void setUniqueId(String unid)

Set the unique session id

Parameters:

unid - String

setLastIOTime

public final void setLastIOTime(long ioTime)

Set the time of hte last I/O on this session

Parameters:

ioTime - long

setShutdown

protected final void setShutdown(boolean flg)

Set the shutdown flag

Parameters:

flg - boolean

closeSession

public void closeSession()

Close the network session

initializeTransactionObject

public final void initializeTransactionObject()

Initialize the thread local transaction objects

getTransactionObject

public final ThreadLocal<Object> getTransactionObject()

Return the transaction context

Returns:

ThreadLocal