oracle.ifs.protocols.commands

Class IfsUploadFileCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsUploadFileCommand

All Implemented Interfaces:

Command

public class IfsUploadFileCommand
extends IfsCommand

A IfsUploadFileCommand is the command to upload a file with proper parsing if applicable.

Command specification for IfsUploadFileCommand

Inputs:

• session : LibrarySession (required)
• parseFlag : boolean (required)
• name : String (required)
• stream : InputStream (required)
• folderPath : String (required)
• acl : AccessControlList (optional)
• callback : ParserCallback (optional)
• language : String (optional)
• charSet : String (optional)

Outputs :

• libraryobject : LibraryObject

Description:

• Upload a file. If parseFlag is true, the content stream will be parsed where applicable.
• The presence of a parser in the system is determined by the given name (IfsDetermineParserComand is called).
• If a parser is found, the content stream will be parsed and appropriate object will be created (IfsParseStreamCommand is called).
• If no parser is found, the content stream will be stored as is with the given name (IfsCreateDocumentCommand is called).
• If acl is not specified, the default acl of the session user will be applied (IfsDetermineAclCommand is called).

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsUploadFileCommand() Default Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(UploadFileContext context) Execute a UploadFileContext.
protected IfsCreateDocumentCommand	getCreateDocumentCommand() Return an instance of the IfsCreateDocumentCommand.
protected IfsDetermineParserCommand	getDetermineParserCommand() Return an instance of the IfsDetermineParserCommand.
protected IfsParseStreamCommand	getParseStreamCommand() Return an instance of the IfsParseStreamCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected Document	runCreateDocumentCommand(LibrarySession session, String name, InputStream stream, Folder folder, AccessControlList acl) Execute an IfsCreateDocumentCommand.
protected Parser	runDetermineParserCommand(LibrarySession session, String name) Execute an IfsDetermineParserCommand.
protected LibraryObject	runParseStreamCommand(LibrarySession session, Parser parser, InputStream stream, String name, String folderPath, ParserCallback callback, AccessControlList acl, String language, String characterSet) Execute an IfsParseStreamCommand.

Methods inherited from class oracle.ifs.protocols.commands.utils.IfsCommand

postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsUploadFileCommand

public IfsUploadFileCommand()

Default Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsDetermineParserCommand, IfsCreateDocumentCommand, and IfsParseStreamCommand.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

invoker - Command invoker object.

Throws:

IfsException - If there is any exception thrown.

See Also:

CommandInvoker

(Published)

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext.

Overrides:

execute in class IfsCommand

Parameters:

context - The command context.

Throws:

IfsException - if execution fails

(Published)

execute

protected void execute(UploadFileContext context)
                throws IfsException

Execute a UploadFileContext.

Parameters:

context - The command context.

Throws:

IfsException

(Published)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

CommandContext

Throws:

IfsException

See Also:

CommandContext

(Published)

runDetermineParserCommand

protected Parser runDetermineParserCommand(LibrarySession session,
                                           String name)
                                    throws IfsException

Execute an IfsDetermineParserCommand. It takes in all inputs that are required to run IfsDetermineParserCommand.

Returns:

Parser.

Throws:

IfsException

See Also:

IfsDetermineParserCommand

(Unpublished)

getDetermineParserCommand

protected IfsDetermineParserCommand getDetermineParserCommand()
                                                       throws IfsException

Return an instance of the IfsDetermineParserCommand.

Returns:

IfsDetermineParserCommand.

Throws:

IfsException

(Unpublished)

runParseStreamCommand

protected LibraryObject runParseStreamCommand(LibrarySession session,
                                              Parser parser,
                                              InputStream stream,
                                              String name,
                                              String folderPath,
                                              ParserCallback callback,
                                              AccessControlList acl,
                                              String language,
                                              String characterSet)
                                       throws IfsException

Execute an IfsParseStreamCommand. It takes in all inputs that are required to run IfsParseStreamCommand.

Returns:

LibraryObject.

Throws:

IfsException

See Also:

IfsParseStreamCommand

(Unpublished)

getParseStreamCommand

protected IfsParseStreamCommand getParseStreamCommand()
                                               throws IfsException

Return an instance of the IfsParseStreamCommand.

Returns:

IfsParseStreamCommand.

Throws:

IfsException

(Unpublished)

runCreateDocumentCommand

protected Document runCreateDocumentCommand(LibrarySession session,
                                            String name,
                                            InputStream stream,
                                            Folder folder,
                                            AccessControlList acl)
                                     throws IfsException

Execute an IfsCreateDocumentCommand. It takes in all inputs that are required to run IfsCreateDocumentCommand.

Returns:

Document.

Throws:

IfsException

See Also:

IfsCreateDocumentCommand

(Unpublished)

getCreateDocumentCommand

protected IfsCreateDocumentCommand getCreateDocumentCommand()
                                                     throws IfsException

Return an instance of the IfsCreateDocumentCommand.

Returns:

IfsCreateDocumentCommand.

Throws:

IfsException

(Unpublished)