oracle.ifs.protocols.ftp.server

Class FtpSession

java.lang.Object

oracle.ifs.protocols.ftp.server.FtpSession

public class FtpSession
extends Object

There is one FtpSession per user connection. FtpSession holds the FdkSession and other session information.

Version:

1.0

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DELIMITER The delimiter string.
static String	FTP_SYSTEM System type.
protected boolean	m_BinaryContentMode If content transfer mode is binary.
protected String	m_CharacterSet Default character set for session.
protected String	m_CommandCharacterSet Iana character set used to encode Ftp commands for this session.
protected String	m_CurrentPath The String which represents the absolute path to the Ftp current directory
protected FdkSession	m_FdkSession FdkSession.
protected boolean	m_IsGuestSession True if guest session.
protected String	m_Language Default language for session.
protected String	m_ObjectToBeRenamed Rename occurs in two commands; need to hold onto the path that is to be renamed.

Constructor Summary

Constructors

Constructor and Description
FtpSession() Constructs a FtpSession

Method Summary

Modifier and Type	Method and Description
void	determineCommandCharacterSet() Determines the command character set used for this FtpSession.
void	determineDocumentCharacterSetAndLanguage() Determines the command character set used for this FtpSession.
void	dispose() Disposes the FdkSession.
FtpServerChannel	getChannel() Gets the Channel.
String	getCharacterSet() Gets the default document character set for this session.
String	getCommandCharacterSet() Gets the Iana character set that should be used to encode the ftp commands for this session.
String	getContentModeString() Returns the string 'Binary' or 'ASCII' which describes the content transfer mode.
Object	getCookie() Gets the Cookie.
String	getCurrentPath() Gets the CurrentPath.
String	getDelimiter() Gets the delimiter.
FdkSession	getFdkSession() Gets the FdkSession.
String	getLanguage() Gets the default document language for this session.
String	getObjectToBeRenamed() Gets the object to be renamed.
boolean	isGuestSession() Returns true if guest session.
void	setBinaryContentMode(String type) Sets the binary content mode.
void	setChannel(FtpServerChannel channel) Sets the Channel.
void	setCharacterSet(String charset) Sets the default document character set for this session.
void	setCommandCharacterSet(String charset) Sets the command character set.
void	setCookie(Object cookie) Sets the Cookie.
void	setCurrentPath(String currentPath) Sets the currentPath and currentFolder
void	setFdkSession(FdkSession session) Sets the FdkSession
void	setIsGuestSession(boolean isGuestSession) Set to true if FdkSession is a guest session.
void	setLanguage(String language) Sets the default document language for this session.
void	setObjectToBeRenamed(String obj) Sets the object to be renamed.

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

protected static String DELIMITER

The delimiter string.

(Unpublished)

FTP_SYSTEM

public static String FTP_SYSTEM

System type.

(Published)

m_BinaryContentMode

protected boolean m_BinaryContentMode

If content transfer mode is binary. Defaults to ascii.

(Unpublished)

m_ObjectToBeRenamed

protected String m_ObjectToBeRenamed

Rename occurs in two commands; need to hold onto the path that is to be renamed.

(Unpublished)

m_CurrentPath

protected String m_CurrentPath

The String which represents the absolute path to the Ftp current directory

(Unpublished)

m_CommandCharacterSet

protected String m_CommandCharacterSet

Iana character set used to encode Ftp commands for this session.

(Unpublished)

m_FdkSession

protected FdkSession m_FdkSession

FdkSession.

(Unpublished)

m_Language

protected String m_Language

Default language for session.

(Unpublished)

m_CharacterSet

protected String m_CharacterSet

Default character set for session.

(Unpublished)

m_IsGuestSession

protected boolean m_IsGuestSession

True if guest session.

(Unpublished)

Constructor Detail

FtpSession

public FtpSession()

Constructs a FtpSession

(Published)

Method Detail

getDelimiter

public String getDelimiter()

Gets the delimiter. Always '/'.

(Unpublished)

setFdkSession

public void setFdkSession(FdkSession session)

Sets the FdkSession

(Unpublished)

getFdkSession

public FdkSession getFdkSession()

Gets the FdkSession.

(Unpublished)

getCommandCharacterSet

public String getCommandCharacterSet()
                              throws Exception

Gets the Iana character set that should be used to encode the ftp commands for this session.

Throws:

Exception

(Unpublished)

determineCommandCharacterSet

public void determineCommandCharacterSet()
                                  throws Exception

Determines the command character set used for this FtpSession.

Throws:

Exception

(Unpublished)

setCommandCharacterSet

public void setCommandCharacterSet(String charset)
                            throws Exception

Sets the command character set. Iana name.

Throws:

Exception

(Unpublished)

getContentModeString

public String getContentModeString()

Returns the string 'Binary' or 'ASCII' which describes the content transfer mode.

Returns:

String Binary or ASCII

(Published)

setBinaryContentMode

public void setBinaryContentMode(String type)

Sets the binary content mode.

Parameters:

type - Ascii or Binary

(Published)

setObjectToBeRenamed

public void setObjectToBeRenamed(String obj)

Sets the object to be renamed. Used for rnfr, rnto commands.

(Unpublished)

getObjectToBeRenamed

public String getObjectToBeRenamed()

Gets the object to be renamed. Used for rnfr, rnto commands.

(Unpublished)

getCurrentPath

public String getCurrentPath()

Gets the CurrentPath. Current path does not end with delimiter.

Returns:

a String containing the current path

(Unpublished)

setCurrentPath

public void setCurrentPath(String currentPath)

Sets the currentPath and currentFolder

Parameters:

currentPath - a String containing the currentPath

(Unpublished)

dispose

public void dispose()

Disposes the FdkSession.

(Unpublished)

getCookie

public Object getCookie()

Gets the Cookie.

(Unpublished)

setCookie

public void setCookie(Object cookie)

Sets the Cookie.

(Unpublished)

getChannel

public FtpServerChannel getChannel()

Gets the Channel.

(Unpublished)

setChannel

public void setChannel(FtpServerChannel channel)

Sets the Channel.

(Unpublished)

setLanguage

public void setLanguage(String language)
                 throws Exception

Sets the default document language for this session. Oracle names.

Throws:

Exception

(Unpublished)

getLanguage

public String getLanguage()
                   throws FdkException,
                          Exception

Gets the default document language for this session. Oracle names.

Throws:

FdkException

Exception

(Unpublished)

setCharacterSet

public void setCharacterSet(String charset)
                     throws Exception

Sets the default document character set for this session. Iana names.

Throws:

Exception

(Unpublished)

getCharacterSet

public String getCharacterSet()
                       throws FdkException,
                              Exception

Gets the default document character set for this session. Iana names.

Throws:

FdkException

Exception

(Unpublished)

determineDocumentCharacterSetAndLanguage

public void determineDocumentCharacterSetAndLanguage()
                                              throws FdkException,
                                                     Exception

Determines the command character set used for this FtpSession.

Throws:

FdkException

Exception

(Unpublished)

setIsGuestSession

public void setIsGuestSession(boolean isGuestSession)
                       throws Exception

Set to true if FdkSession is a guest session.

Throws:

Exception

(Unpublished)

isGuestSession

public boolean isGuestSession()
                       throws Exception

Returns true if guest session.

Throws:

Exception

(Unpublished)