oracle.ifs.protocols.commands

Class IfsCreateDocumentCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCreateDocumentCommand

All Implemented Interfaces:

Command

public class IfsCreateDocumentCommand
extends IfsCommand

A IfsCreateDocumentCommand creates a document. Command specification for IfsCreateDocumentCommand

Inputs:

• session : LibrarySession (required)
• name : String (required)
• stream : InputStream (required)
• folder : Folder (required)
• acl : AccessControlList (optional)

Outputs :

• document : Document

Description:

• Create a document from the stream with the specified name in the given folder.
• If acl is not specified, the default acl of the session user will be applied to the newly created document (IfsDetermineAclCommand is called).
• IfsDetermineFormatCommand is called to determine the Format object associated with the filename.
• The newly created document will be go through the versioning semantics when placed in the given folder (IfsHandlePublicObjectVersioningCommand is called).
• If a document with the same name already exists in folder, an IfsException will be thrown.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCreateDocumentCommand() Defualt 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(CreateDocumentContext context) Execute a CreateDocumentContext.
protected IfsDetermineAclCommand	getDetermineAclCommand() Return an instance of the IfsDetermineAclCommand.
protected IfsDetermineFormatCommand	getDetermineFormatCommand() Return an instance of the IfsDetermineFormatCommand.
protected IfsHandlePublicObjectVersioningCommand	getHandlePOVersioningCommand() Return an instance of the IfsHandlePublicObjectVersioningCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected AccessControlList	runDetermineAclCommand(LibrarySession session, AccessControlList acl, Folder folder, String name, LibraryObjectDefinition lodef) Execute an IfsDetermineAclCommand.
protected Format	runDetermineFormatCommand(LibrarySession session, String filename) Execute an IfsDetermineFormatCommand.
protected void	runHandlePOVersioningCommand(LibrarySession session, PublicObject po, Folder folder) Execute an IfsHandlePublicObjectVersioningCommand.

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

IfsCreateDocumentCommand

public IfsCreateDocumentCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsDetermineAclCommand, IfsDetermineFormatCommand, and HandlePOVersioningCommand.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

invoker - Command invoker.

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(CreateDocumentContext context)
                throws IfsException

Execute a CreateDocumentContext.

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)

runDetermineAclCommand

protected AccessControlList runDetermineAclCommand(LibrarySession session,
                                                   AccessControlList acl,
                                                   Folder folder,
                                                   String name,
                                                   LibraryObjectDefinition lodef)
                                            throws IfsException

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

Returns:

AccessControlList.

Throws:

IfsException

See Also:

IfsDetermineAclCommand

(Unpublished)

getDetermineAclCommand

protected IfsDetermineAclCommand getDetermineAclCommand()
                                                 throws IfsException

Return an instance of the IfsDetermineAclCommand.

Returns:

IfsDetermineAclCommand.

Throws:

IfsException

(Unpublished)

runDetermineFormatCommand

protected Format runDetermineFormatCommand(LibrarySession session,
                                           String filename)
                                    throws IfsException

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

Returns:

Format

Throws:

IfsException

See Also:

IfsDetermineFormatCommand

(Unpublished)

getDetermineFormatCommand

protected IfsDetermineFormatCommand getDetermineFormatCommand()
                                                       throws IfsException

Return an instance of the IfsDetermineFormatCommand.

Returns:

IfsDetermineFormatCommand.

Throws:

IfsException

(Unpublished)

runHandlePOVersioningCommand

protected void runHandlePOVersioningCommand(LibrarySession session,
                                            PublicObject po,
                                            Folder folder)
                                     throws IfsException

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

Throws:

IfsException

See Also:

IfsHandlePublicObjectVersioningCommand

(Unpublished)

getHandlePOVersioningCommand

protected IfsHandlePublicObjectVersioningCommand getHandlePOVersioningCommand()
                                                                       throws IfsException

Return an instance of the IfsHandlePublicObjectVersioningCommand.

Returns:

IfsHandlePublicObjectVersioningCommand.

Throws:

IfsException

(Unpublished)