oracle.ifs.protocols.commands

Class IfsCreateFolderCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCreateFolderCommand

All Implemented Interfaces:

Command

public class IfsCreateFolderCommand
extends IfsCommand

An IfsCreateFolderCommand is a command that given an absolute folder path name, a folder is created. Inputs:

• session : LibrarySession (required)
• name : String (required)
• acl : AccessControlList (optional)
• createParents : boolean (optional)

Outputs :

• NONE

Description:

• Takes an absolute folder path name which is to be the folder to create. If the folder path does not exist, create the folder path. The folder or folder path is added to the specified parent folder path using the setAddToFolderOption(parent) method. If the ACL is not specified, then the parent folder ACL is used. Non-existing folders in the path will always be created.

Version:

0.9

Author:

Tina Seto

See Also:

IfsCommand

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected IfsDetermineAclCommand	m_DetermineAclCommand Object that contains the logic for determining the Acl.
protected CommandContextPool	m_DetermineAclContextPool Context pool for command contexts.

Constructor Summary

Constructors

Constructor and Description
IfsCreateFolderCommand() Default Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected Folder	createFolder(LibrarySession session, String name, AccessControlList acl, boolean aclFromParent, Folder parent) Creates one Folder object.
protected Folder	createParentFolderPath(LibrarySession session, String folderPath, AccessControlList acl, boolean aclFromParent) Creates all folders in a path where the path contains at least one folder to be created.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(CreateFolderContext context) Executes a CreateFolderContext.
protected IfsDetermineAclCommand	getDetermineAclCommand() Return an instance of the IfsDetermineAclCommand.
protected AccessControlList	performDetermineAcl(FolderDefinition def, String name, Folder parent, LibrarySession sess, AccessControlList defaultAcl) Determines the Acl to use by making a call to the inner command.
void	populateNestedCommands(CommandInvoker commandInvoker) Populates the command and context pool for determining the Acl.

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

Field Detail

m_DetermineAclCommand

protected IfsDetermineAclCommand m_DetermineAclCommand

Object that contains the logic for determining the Acl.

(Unpublished)

m_DetermineAclContextPool

protected CommandContextPool m_DetermineAclContextPool

Context pool for command contexts.

(Unpublished)

Constructor Detail

IfsCreateFolderCommand

public IfsCreateFolderCommand()

Default Constructor

(Published)

Method Detail

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

Executes a CreateFolderContext.

Throws:

IfsException

(Published)

createParentFolderPath

protected Folder createParentFolderPath(LibrarySession session,
                                        String folderPath,
                                        AccessControlList acl,
                                        boolean aclFromParent)
                                 throws IfsException

Creates all folders in a path where the path contains at least one folder to be created.

Throws:

IfsException

(Unpublished)

createFolder

protected Folder createFolder(LibrarySession session,
                              String name,
                              AccessControlList acl,
                              boolean aclFromParent,
                              Folder parent)
                       throws IfsException

Creates one Folder object.

Throws:

IfsException

(Unpublished)

performDetermineAcl

protected AccessControlList performDetermineAcl(FolderDefinition def,
                                                String name,
                                                Folder parent,
                                                LibrarySession sess,
                                                AccessControlList defaultAcl)
                                         throws IfsException

Determines the Acl to use by making a call to the inner command.

Throws:

IfsException

(Unpublished)

populateNestedCommands

public void populateNestedCommands(CommandInvoker commandInvoker)
                            throws IfsException

Populates the command and context pool for determining the Acl.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

commandInvoker - the command invoker

Throws:

IfsException - if the operation fails

See Also:

CommandInvoker

(Published)

getDetermineAclCommand

protected IfsDetermineAclCommand getDetermineAclCommand()
                                                 throws IfsException

Return an instance of the IfsDetermineAclCommand.

Returns:

IfsDetermineAclCommand.

Throws:

IfsException

(Unpublished)

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:

the command context

Throws:

IfsException - if the operation fails

See Also:

CommandContext

(Published)