oracle.ifs.protocols.utils

Class IfsProtocolSession

java.lang.Object

oracle.ifs.protocols.utils.IfsProtocolSession

Direct Known Subclasses:

CupSession

public class IfsProtocolSession
extends Object

IfsProtocolSession is the default implementation of ProtocolSession.

Version:

1.0

Author:

Dave Long, Kevin Gillett

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_DefaultDateFormatString
protected String	m_DefaultDelimiter

Constructor Summary

Constructors

Constructor and Description
IfsProtocolSession(String dateFormat, String delimiter) Contructor

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the IfsProtocolSession.
IfsServerChannel	getChannel() Gets the Channel.
Object	getCookie() Gets the Cookie.
LibrarySession	getLibrarySession() Gets the LibrarySession.
String	getUsername() Gets the LibrarySession.
boolean	hasTimedOut(long timeoutLength) Has timed out?
void	setChannel(IfsServerChannel channel) Sets the Channel.
void	setCookie(Object cookie) Sets the Cookie.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.
protected void	setUsername() Called from setLibrarySession. sets up the username for ease of use.
protected void	updateLastAccess() Updates the last access of this session.

Methods inherited from class java.lang.Object

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

Field Detail

m_DefaultDateFormatString

protected String m_DefaultDateFormatString

m_DefaultDelimiter

protected String m_DefaultDelimiter

Constructor Detail

IfsProtocolSession

public IfsProtocolSession(String dateFormat,
                          String delimiter)
                   throws IfsException

Contructor

Throws:

IfsException

(Published)

Method Detail

dispose

public void dispose()

Disposes the IfsProtocolSession. Eats all Exceptions. Calls: LibrarySession.disconnect() Sets: Channel and Cookie to null.

(Published)

hasTimedOut

public boolean hasTimedOut(long timeoutLength)

Has timed out?

(Published)

getUsername

public String getUsername()
                   throws IfsException

Gets the LibrarySession.

Throws:

IfsException

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the LibrarySession.

Throws:

IfsException

(Published)

getCookie

public Object getCookie()
                 throws IfsException

Gets the Cookie.

Throws:

IfsException

(Published)

setCookie

public void setCookie(Object cookie)
               throws IfsException

Sets the Cookie.

Throws:

IfsException

(Published)

getChannel

public IfsServerChannel getChannel()
                            throws IfsException

Gets the Channel.

Throws:

IfsException

(Published)

setChannel

public void setChannel(IfsServerChannel channel)
                throws IfsException

Sets the Channel.

Throws:

IfsException

(Published)

updateLastAccess

protected final void updateLastAccess()

Updates the last access of this session.

(Published)

setUsername

protected void setUsername()

Called from setLibrarySession. sets up the username for ease of use.