oracle.ifs.protocols.commands.utils

Class IfsCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

CupModeCommand, IfsAddFolderRelationshipCommand, IfsAttributeStringDisplayCommand, IfsBlankCommand, IfsCancelCheckOutCommand, IfsCatCommand, IfsChangeDirectoryCommand, IfsCheckedOutByCommand, IfsCheckInCommand, IfsCheckOutCommand, IfsCloseChannelCommand, IfsCookieCommand, IfsCopyCommand, IfsCreateDocumentCommand, IfsCreateFolderCommand, IfsDeleteLibraryObjectCommand, IfsDetermineAclCommand, IfsDetermineFormatCommand, IfsDetermineParserCommand, IfsDoesPublicObjectExistByIdCommand, IfsDoesPublicObjectExistByPathCommand, IfsFindPublicObjectByIdCommand, IfsFindPublicObjectByPathCommand, IfsGetAttributeNamesCommand, IfsGetAttributesCommand, IfsGetBeansVersionCommand, IfsGetCurrentUserCommand, IfsHandlePublicObjectVersioningCommand, IfsHelpCommand, IfsInvokeSelectorAndListOutputCommand, IfsInvokeSelectorCommand, IfsIsCheckedOutCommand, IfsIsVersionedCommand, IfsLoginCommand, IfsLogoutCommand, IfsMvCommand, IfsOpenSocketCommand, IfsParseStreamCommand, IfsPasvCommand, IfsPortCommand, IfsRemoveFolderRelationshipCommand, IfsRenderAsRandomAccessContentCommand, IfsRenderAsReaderCommand, IfsRenderAsStreamCommand, IfsSetAttributesCommand, IfsShowAllPathsCommand, IfsStringListCommand, IfsUploadFileCommand

public abstract class IfsCommand
extends Object
implements Command

An IfsCommand is base class for individual commands.

Version:

0.9

Author:

Kevin Gillett, Patricia Li

See Also:

Command

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCommand() Constructor.

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Create a default implementation of the command context object.
protected void	execute(CommandContext context) This method is run between preExecute and postExecute if preExecute does not throw an exception.
void	populateNestedCommands(CommandInvoker commandInvoker) Populate all the needed nested commands.
protected void	postExecute(CommandContext context, IfsException e) This method is always run after execute.
protected void	preExecute(CommandContext context) This method is always run before the execute method.
void	run(CommandContext context) Run the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCommand

public IfsCommand()

Constructor.

Method Detail

run

public final void run(CommandContext context)
               throws IfsException

Run the command.

Specified by:

run in interface Command

Parameters:

context - the command context.

Throws:

IfsException - if exception is thrown in the execution.

See Also:

CommandContext

populateNestedCommands

public void populateNestedCommands(CommandInvoker commandInvoker)
                            throws IfsException

Populate all the needed nested commands.

CommandInvoker is not guaranteed to exist for the lifetime of the command. Therefore, the command should not keep a reference to the command invoker and it should acquire all the references to the needed commands in this call-back method.

Specified by:

populateNestedCommands in interface Command

Parameters:

commandInvoker - The CommandInvoker object that can be used to acquire references to the needed sub-commands.

Throws:

IfsException - If there is any exception thrown.

See Also:

CommandInvoker

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Create a default implementation of the command context object. Subclass should overwrite this class to return an implementation.

Specified by:

createCommandContext in interface Command

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext

preExecute

protected void preExecute(CommandContext context)
                   throws IfsException

This method is always run before the execute method.

This is the extension point of the command for setup code. Subclass could overwrite this method for any setup code. The default implementation does nothing.

Parameters:

context - the command context.

Throws:

IfsException

execute

protected void execute(CommandContext context)
                throws IfsException

This method is run between preExecute and postExecute if preExecute does not throw an exception. In which case niether execute nore postexecute is called.

This is the method where the subclasses should overwrite to provide functionality for the command. The default implementation throws an IfsException (errorcode 68025).

Parameters:

context - the command context.

Throws:

IfsException - if execution fails

postExecute

protected void postExecute(CommandContext context,
                           IfsException e)
                    throws IfsException

This method is always run after execute.

This is the extension point of the command for cleanup code. Subclass should overwrite this method for any cleanup code. The default implementation rethrows the exception if not null.

Parameters:

context - the command context.

e - the exception if one occured.

Throws:

IfsException