org.alfresco.jlan.server

Class SessionHandlerBase

java.lang.Object

org.alfresco.jlan.server.SessionHandlerBase

All Implemented Interfaces:

SessionHandlerInterface

Direct Known Subclasses:

AsyncWinsockNetBIOSSessionHandler, ChannelSessionHandler, SocketSessionHandler, Win32NetBIOSSessionSocketHandler

public abstract class SessionHandlerBase
extends Object
implements SessionHandlerInterface

Session Handler Base Class

Implementation of a session handler that uses a Java socket to listen for incoming session requests.

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static int	ListenBacklog

Constructor Summary

Constructors

Constructor and Description
SessionHandlerBase(String name, String protocol, NetworkServer server, InetAddress addr, int port) Class constructor

Method Summary

Modifier and Type	Method and Description
protected void	clearShutdown() Clear the shutdown flag
abstract void	closeSessionHandler(NetworkServer server) Close the session handler
InetAddress	getBindAddress() Return the network address that the server should bind to
String	getHandlerName() Return the session handler name
int	getListenBacklog() Return the socket listen backlog limit
protected int	getNextSessionId() Get the next available session id
int	getPort() Return the port that the server should bind to
String	getProtocolName() Return the short protocol name
NetworkServer	getServer() Return the server
boolean	hasBindAddress() Check if the server should bind to a specific network address
boolean	hasDebug() Determine if debug output is enabled
protected boolean	hasShutdown() Determine if the shutdown flag has been set
abstract void	initializeSessionHandler(NetworkServer server) Initialize the session handler
void	setDebug(boolean dbg) Enable/disable debug output
protected void	setPort(int port) Set the local port that the session handler is using
protected void	setShutdown(boolean shut) Set/clear the shutdown flag
String	toString() Return the session handler details as a string

Methods inherited from class java.lang.Object

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

Field Detail

ListenBacklog

public static final int ListenBacklog

See Also:

Constant Field Values

Constructor Detail

SessionHandlerBase

public SessionHandlerBase(String name,
                          String protocol,
                          NetworkServer server,
                          InetAddress addr,
                          int port)

Class constructor

Parameters:

name - String

protocol - String

server - NetworkServer

addr - InetAddress

port - int

Method Detail

getServer

public final NetworkServer getServer()

Return the server

Returns:

NetworkServer

getHandlerName

public final String getHandlerName()

Return the session handler name

Specified by:

getHandlerName in interface SessionHandlerInterface

Returns:

String

getProtocolName

public final String getProtocolName()

Return the short protocol name

Returns:

String

hasBindAddress

public final boolean hasBindAddress()

Check if the server should bind to a specific network address

Returns:

boolean

getBindAddress

public final InetAddress getBindAddress()

Return the network address that the server should bind to

Returns:

InetAddress

getPort

public final int getPort()

Return the port that the server should bind to

Returns:

int

getListenBacklog

public final int getListenBacklog()

Return the socket listen backlog limit

Returns:

int

hasDebug

public final boolean hasDebug()

Determine if debug output is enabled

Returns:

boolean

clearShutdown

protected final void clearShutdown()

Clear the shutdown flag

hasShutdown

protected final boolean hasShutdown()

Determine if the shutdown flag has been set

Returns:

boolean

getNextSessionId

protected int getNextSessionId()

Get the next available session id

Returns:

int

setDebug

public final void setDebug(boolean dbg)

Enable/disable debug output

Parameters:

dbg - boolean

setPort

protected final void setPort(int port)

Set the local port that the session handler is using

Parameters:

port - int

setShutdown

protected final void setShutdown(boolean shut)

Set/clear the shutdown flag

Parameters:

shut - boolean

initializeSessionHandler

public abstract void initializeSessionHandler(NetworkServer server)
                                       throws IOException

Initialize the session handler

Specified by:

initializeSessionHandler in interface SessionHandlerInterface

Parameters:

server - NetworkServer

Throws:

IOException

closeSessionHandler

public abstract void closeSessionHandler(NetworkServer server)

Close the session handler

Specified by:

closeSessionHandler in interface SessionHandlerInterface

Parameters:

server - NetworkServer

toString

public String toString()

Return the session handler details as a string

Overrides:

toString in class Object

Returns:

String