oracle.ifs.protocols.ftp.commands

Class FtpCommand

java.lang.Object

oracle.ifs.protocols.ftp.commands.FtpCommand

Direct Known Subclasses:

FtpAuthCommand, FtpCccCommand, FtpCdCommand, FtpCdupCommand, FtpGetCommand, FtpLnCommand, FtpLoginCommand, FtpLogoutCommand, FtpLsCommand, FtpMkdirCommand, FtpModeCommand, FtpNoOpCommand, FtpPasvCommand, FtpPbszCommand, FtpPortCommand, FtpProtCommand, FtpPutCommand, FtpPwdCommand, FtpRenameFromCommand, FtpRenameToCommand, FtpRmCommand, FtpStatsCommand, FtpSystCommand, FtpTypeCommand, FtpUserCommand

public abstract class FtpCommand
extends Object

FtpCommand is a base class for Ftp commands.

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
FtpCommand() Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	checkLoggedIn(FtpServerChannel channel) Check with current session is valid.
protected void	denyGuestAccessForWriteableCommands(String cmdKey) Guest user has read-only privileges.
String	encodeArgument(String arg, String charset) Encodes the string that came in through the InputStreamReader with the given character set.
protected abstract void	execute(FtpServerChannel channel, String cmdKey, Argument[] flags, Argument[] positionals) Execute the command.
protected String	formatCmdline(String cmdKey, String cmdline) For some commands, add quotes around cmdline input.
String	getHomeFolderPath(FdkSession fdksession) Get the home folder path.
protected int[]	getPotentialArgs() Gets the argument type a particular flag is expecting.
protected String[]	getPotentialFlags() Gets the potentials flags that the CommandlineArguments object might be expecting.
protected void	handleException(FtpServerChannel channel, Exception exception, String cmdKey) Send a generic error message.
String	normalizePath(FtpSession psession, String path) Convert to absolute path if not already.
void	run(FtpServerChannel channel, String cmdKey, String cmdline) Run the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpCommand

public FtpCommand()

Default Constructor.

(Published)

Method Detail

run

public final void run(FtpServerChannel channel,
                      String cmdKey,
                      String cmdline)

Run the command. This is invoked in FtpCommandInvoker. Any exception should be handled in handleException().

(Published)

formatCmdline

protected String formatCmdline(String cmdKey,
                               String cmdline)
                        throws Exception

For some commands, add quotes around cmdline input.

Throws:

Exception

(Unpublished)

denyGuestAccessForWriteableCommands

protected void denyGuestAccessForWriteableCommands(String cmdKey)
                                            throws Exception

Guest user has read-only privileges. Fail-fast approach.

Throws:

Exception

(Unpublished)

getPotentialFlags

protected String[] getPotentialFlags()

Gets the potentials flags that the CommandlineArguments object might be expecting. Subclass has option to overwrite.

(Published)

getPotentialArgs

protected int[] getPotentialArgs()

Gets the argument type a particular flag is expecting. Subclass has option to overwrite.

(Published)

execute

protected abstract void execute(FtpServerChannel channel,
                                String cmdKey,
                                Argument[] flags,
                                Argument[] positionals)
                         throws Exception

Execute the command. Should be overridden.

Throws:

Exception

(Published)

handleException

protected void handleException(FtpServerChannel channel,
                               Exception exception,
                               String cmdKey)
                        throws Exception

Send a generic error message. Override as needed.

Parameters:

channel - the server channel

exception - exception object

cmdKey - the command attempted

Throws:

Exception

(Published)

checkLoggedIn

protected void checkLoggedIn(FtpServerChannel channel)
                      throws FtpException

Check with current session is valid.

Throws:

FtpException

(Unpublished)

getHomeFolderPath

public String getHomeFolderPath(FdkSession fdksession)
                         throws FdkException,
                                Exception

Get the home folder path.

Throws:

FdkException

Exception

(Published)

encodeArgument

public String encodeArgument(String arg,
                             String charset)
                      throws Exception

Encodes the string that came in through the InputStreamReader with the given character set.

Parameters:

arg - the string to be encoded

charset - the character set to encode the string

Returns:

the encoded string

Throws:

Exception

(Published)

normalizePath

public String normalizePath(FtpSession psession,
                            String path)
                     throws FtpException

Convert to absolute path if not already. Remove duplicate '.'.

Throws:

FtpException

(Unpublished)