oracle.ifs.protocols.utils

Class IfsServerChannel

java.lang.Object

java.lang.Thread

oracle.ifs.protocols.utils.IfsServerChannel

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

CupServerChannel

public abstract class IfsServerChannel
extends Thread

IfsServerChannel creates an InputStream from the socket it was instaniated with. The stream is drained of commands using the ProtocolStreamParser. These Commands are then invoked forming the basis of a Channel.

Version:

1.0

Author:

Dave Long, Kevin Gillett

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROL_SOCKET The Key for the ControlSocket.
protected InputStream	m_ControlIn The cntrl input.
protected OutputStream	m_ControlOut The cntrl output.
protected int	m_ControlSocketTimeout The default timeout for the channel socket.
protected SocketFactory	m_SocketFactory My socket factory.
protected Hashtable	m_Sockets My sockets.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
IfsServerChannel(IfsProtocolServer server, Socket controlSocket, int key, String threadName) The Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection() Close outputstream, inputStream, and all sockets setting the memeber variables to null.
protected abstract ProtocolStreamParser	createProtocolStreamParser() Create the ProtocolStreamParser associated with this Channel.
protected SocketFactory	createSocketFactory(InetAddress localhost, int localControlPort, InetAddress clientHost, int clientContorlPort) Creates a socket factory with the InetAddresses as given and the ports minus 1.
void	disconnect() Disconnects this Channel.
int	getChannelKey() Gets the channel Key given at instaniation.
int	getControlSocketTimeout()
IfsProtocolServer	getProtocolServer() Gets the ProtocolServer that started this Channel.
IfsProtocolSession	getProtocolSession() Gets the ProtocolSession associated with this Channel.
Socket	getSocket(Object key) Gets an active socket by key.
SocketFactory	getSocketFactory() Gets the SocketFactory associated with this Channel.
protected void	handleCommandInvocationIfsException(IfsException e, Object cmdkey) Handles a Throwable while invoking command.
protected void	handleCommandInvocationThrowable(Throwable e, Object cmdkey) Handles a Throwable while invoking command.
protected void	handleInterruptedIOException(InterruptedIOException e) Hanndles an InterruptedIOException in the command loop.
protected void	handleIOException(IOException e) Hanndles an IOException in the command loop.
protected void	handleThrowable(Throwable e) Hanndles a Throwable in the command loop.
void	log(int level, String s) Prints a message to the log.
void	log(int level, Throwable e) Prints an exception stack trace to the log.
protected void	postCommandLoop() Called after entering command loop.
protected void	preCommandLoop() Called before entering command loop.
Socket	removeSocket(Object key) Removes an active socket by key.
void	run() The control loop.
void	setControlSocketTimeout(int timeout)
void	setProtocolSession(IfsProtocolSession protocolSession) Sets the ProtocolSession associated with this Channel.
Socket	setSocket(Object key, Socket socket) Sets an active socket to be accessable by a key.
protected void	setupIO() Obtains the input and output streams and then creates and initializes the ProtocolStreamParser associated with this Channel.
Enumeration	socketKeys() Returns all keys associated with active sockets.
Enumeration	sockets() Returns all active sockets.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_SOCKET

public static final String CONTROL_SOCKET

The Key for the ControlSocket. The socket which IfsServerChannel is instaniated with.

See Also:

Constant Field Values

(Published)

m_SocketFactory

protected SocketFactory m_SocketFactory

My socket factory.

(Published)

m_Sockets

protected Hashtable m_Sockets

My sockets.

(Published)

m_ControlSocketTimeout

protected int m_ControlSocketTimeout

The default timeout for the channel socket.

(Published)

m_ControlIn

protected InputStream m_ControlIn

The cntrl input.

(Published)

m_ControlOut

protected OutputStream m_ControlOut

The cntrl output.

(Published)

Constructor Detail

IfsServerChannel

public IfsServerChannel(IfsProtocolServer server,
                        Socket controlSocket,
                        int key,
                        String threadName)
                 throws Exception

The Constructor.

Throws:

Exception

(Published)

Method Detail

run

public void run()

The control loop.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

(Unpublished)

setControlSocketTimeout

public void setControlSocketTimeout(int timeout)
                             throws SocketException

Throws:

SocketException

getControlSocketTimeout

public int getControlSocketTimeout()

setSocket

public Socket setSocket(Object key,
                        Socket socket)

Sets an active socket to be accessable by a key.

(Published)

getSocket

public Socket getSocket(Object key)

Gets an active socket by key.

(Published)

removeSocket

public Socket removeSocket(Object key)

Removes an active socket by key. The socket still must be closed.

(Published)

socketKeys

public Enumeration socketKeys()

Returns all keys associated with active sockets.

(Published)

sockets

public Enumeration sockets()

Returns all active sockets.

(Published)

getSocketFactory

public SocketFactory getSocketFactory()

Gets the SocketFactory associated with this Channel.

(Published)

createSocketFactory

protected SocketFactory createSocketFactory(InetAddress localhost,
                                            int localControlPort,
                                            InetAddress clientHost,
                                            int clientContorlPort)
                                     throws IfsException

Creates a socket factory with the InetAddresses as given and the ports minus 1.

Throws:

IfsException

(Published)

closeConnection

protected void closeConnection()

Close outputstream, inputStream, and all sockets setting the memeber variables to null.

(Published)

preCommandLoop

protected void preCommandLoop()
                       throws IfsException

Called before entering command loop.

Throws:

IfsException

(Published)

postCommandLoop

protected void postCommandLoop()
                        throws IfsException

Called after entering command loop. Only called if command loop entered. ie if an exception is trown before first command then this method is not called.

Throws:

IfsException

(Published)

handleInterruptedIOException

protected void handleInterruptedIOException(InterruptedIOException e)
                                     throws IfsException

Hanndles an InterruptedIOException in the command loop. This happens on a socket timeout.

Throws:

IfsException

(Published)

handleIOException

protected void handleIOException(IOException e)
                          throws IfsException

Hanndles an IOException in the command loop. This happens when a client closes the connection

Throws:

IfsException

(Published)

handleThrowable

protected void handleThrowable(Throwable e)
                        throws IfsException

Hanndles a Throwable in the command loop. This shouldn't happen.

Throws:

IfsException

(Published)

handleCommandInvocationThrowable

protected void handleCommandInvocationThrowable(Throwable e,
                                                Object cmdkey)
                                         throws IfsException

Handles a Throwable while invoking command.

Throws:

IfsException

(Published)

handleCommandInvocationIfsException

protected void handleCommandInvocationIfsException(IfsException e,
                                                   Object cmdkey)
                                            throws IfsException

Handles a Throwable while invoking command.

Throws:

IfsException

(Published)

setupIO

protected void setupIO()
                throws Exception

Obtains the input and output streams and then creates and initializes the ProtocolStreamParser associated with this Channel.

Throws:

Exception

(Published)

createProtocolStreamParser

protected abstract ProtocolStreamParser createProtocolStreamParser()
                                                            throws IfsException

Create the ProtocolStreamParser associated with this Channel.

Throws:

IfsException

(Published)

getProtocolServer

public IfsProtocolServer getProtocolServer()

Gets the ProtocolServer that started this Channel.

(Published)

getProtocolSession

public IfsProtocolSession getProtocolSession()

Gets the ProtocolSession associated with this Channel.

(Published)

setProtocolSession

public void setProtocolSession(IfsProtocolSession protocolSession)

Sets the ProtocolSession associated with this Channel.

(Published)

disconnect

public void disconnect()

Disconnects this Channel. Called by a ProtocolServer shutting down or a Command that want to disconnect the Channel. Disposing of the ProtocolSession is a seperate task. This is a non-blocking call.

(Published)

getChannelKey

public int getChannelKey()

Gets the channel Key given at instaniation.

(Published)

log

public void log(int level,
                String s)

Prints a message to the log.

Parameters:

s - the message

(Published)

log

public void log(int level,
                Throwable e)

Prints an exception stack trace to the log.

Parameters:

e - The Throwable to trace to the log.

(Published)