oracle.ifs.protocols.commands

Class IfsCopyCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCopyCommand

All Implemented Interfaces:

Command

public class IfsCopyCommand
extends IfsCommand

An IfsCopyCommand is a command that given a LibraryObject, an array of all the paths to that object is returned. Inputs:

• session : LibrarySession (required)
• srcPO : PublicObject (required)
• destParentFolder : Folder (required)
• newName : String (optional)
• overwrite : boolean (optional)

Outputs :

• NONE

Description:

• Copy the PublicObject po into the specified folder. An exception will be thrown if attempts are made to overwrite a non-Folder object with a Folder object, and vice versa.
  If po is a non-Folder object:
  • If overwrite is True, existing PublicObject in folder will be overwritten.
  • If overwrite is False, a new copy will be created with the naming convention "Copy of .." for the first copy, and "Copy (#) of .." for all other copies.
  For po is a Folder object:
  • A recursive copy is performed.
  • If overwrite is True, the content of po will be copied over to the existing PublicObject in folder with versioning semantics.
  • If overwrite is False, a new copy will be created with the naming convention "Copy of .." for the first copy, and "Copy (#) of .." for all other copies.

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.
protected IfsHandlePublicObjectVersioningCommand	m_HandlePublicObjectVersioningCommand Object that contains the logic for determining the Acl.
protected CommandContextPool	m_HandlePublicObjectVersioningContextPool Context pool for command contexts.

Constructor Summary

Constructors

Constructor and Description
IfsCopyCommand() Default Constructor

Method Summary

Modifier and Type	Method and Description
protected void	copy(LibrarySession session, FolderPathResolver fpr, PublicObject srcPO, Folder destParentFolder, String newName, boolean shouldOverwrite) Copy the PublicObject po into the specified folder.
protected PublicObject	copyFolderWithNameConflictOverwrite(LibrarySession session, FolderPathResolver fpr, Folder fromFolder, Folder toFolder) Recursively copies the folder, overwriting any objects with a name conflict.
protected PublicObject	copyNoNameConflict(LibrarySession session, PublicObject srcPO, Folder destParentFolder, String newName) Copies the PublicObject and adds the new PublicObject the destination parent folder.
protected PublicObject	copyNoOverwrite(LibrarySession session, PublicObject srcPO, Folder destParentFolder, String poName) Copy the PublicObject and do not overwrite.
protected PublicObject	copyWithNameConflictDeleteOverwrite(LibrarySession session, PublicObject srcPO, Folder destParentFolder, String newName, PublicObject existingPO) Copy the PublicObject and overwrite the existing object with the same name by deleting the existing object and replacing with the new object.
protected PublicObject	copyWithNameConflictOverwrite(LibrarySession session, PublicObject srcPO, Folder destParentFolder, String newName) Copy the PublicObject and overwrite the existing object with the same name.
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected PublicObject	duplicateObject(LibrarySession session, PublicObject srcPO, Folder destParentFolder, String newName) Duplicate the PublicObject.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(CopyContext context) Executes a CopyContext.
protected IfsDetermineAclCommand	getDetermineAclCommand() Return an instance of the IfsDetermineAclCommand.
protected IfsHandlePublicObjectVersioningCommand	getHandlePublicObjectVersioningCommand() Return an instance of the IfsHandlePublicObjectVersioningCommand.
protected void	handlePublicObjectVersioning(LibrarySession session, Folder destParentFolder, PublicObject newPO) Handles versioning the PublicObject.
protected PublicObject[]	listFolder(FolderPathResolver fpr, Folder folder, String pattern) Returns a list of PublicObjects in the specified folder.
protected AccessControlList	performDetermineAcl(PublicObjectDefinition def, String newName, Folder destParentFolder, LibrarySession session, 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.
protected void	validateArgument(Object arg, String name) Validate argument input.

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)

m_HandlePublicObjectVersioningCommand

protected IfsHandlePublicObjectVersioningCommand m_HandlePublicObjectVersioningCommand

Object that contains the logic for determining the Acl.

(Unpublished)

m_HandlePublicObjectVersioningContextPool

protected CommandContextPool m_HandlePublicObjectVersioningContextPool

Context pool for command contexts.

(Unpublished)

Constructor Detail

IfsCopyCommand

public IfsCopyCommand()

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

Executes a CopyContext.

Throws:

IfsException

(Published)

copy

protected void copy(LibrarySession session,
                    FolderPathResolver fpr,
                    PublicObject srcPO,
                    Folder destParentFolder,
                    String newName,
                    boolean shouldOverwrite)
             throws IfsException

Copy the PublicObject po into the specified folder. An exception will be thrown if attempts are made to overwrite a non-Folder object with a Folder object, and vice versa.

If po is a non-Folder object:

• If overwrite is True, existing PublicObject in folder will be overwritten.
• If overwrite is False, a new copy will be created with the naming convention "Copy of .." for the first copy, and "Copy (#) of .." for all other copies.

For po is a Folder object:

• A recursive copy is performed.
• If overwrite is True, the content of po will be copied over to the existing PublicObject in folder with versioning semantics.
• If overwrite is False, a new copy will be created with the naming convention "Copy of .." for the first copy, and "Copy (#) of .." for all other copies.

Parameters:

session - LibrarySession

srcPO - PublicObject to copy from

destParentFolder - Folder object to copy to

newName - name of new object

shouldOverwrite - If true, overwrite existing PublicObject in folder . Note: overwrite behaves differently if po is a Folder. See above for details.

Throws:

IfsException - if operation fails

(Unpublished)

copyNoNameConflict

protected PublicObject copyNoNameConflict(LibrarySession session,
                                          PublicObject srcPO,
                                          Folder destParentFolder,
                                          String newName)
                                   throws IfsException

Copies the PublicObject and adds the new PublicObject the destination parent folder. In this case, there is no name conflict in the parent folder.

Parameters:

session - LibrarySession

srcPO - source PublicObject

destParentFolder -

newName - name of new object

Returns:

PublicObject the duplicate object

Throws:

IfsException - if the operation fails

(Unpublished)

duplicateObject

protected PublicObject duplicateObject(LibrarySession session,
                                       PublicObject srcPO,
                                       Folder destParentFolder,
                                       String newName)
                                throws IfsException

Duplicate the PublicObject.

Parameters:

session - LibrarySession

srcPO - source PublicObject

destParentFolder -

newName - name of new object

Returns:

PublicObject the duplicate object

Throws:

IfsException - if the operation fails

(Unpublished)

copyFolderWithNameConflictOverwrite

protected PublicObject copyFolderWithNameConflictOverwrite(LibrarySession session,
                                                           FolderPathResolver fpr,
                                                           Folder fromFolder,
                                                           Folder toFolder)
                                                    throws IfsException

Recursively copies the folder, overwriting any objects with a name conflict.

Parameters:

session - LibrarySession

fromFolder - the source Folder

toFolder - the destination Folder

Returns:

PublicObject the toFolder

Throws:

IfsException - if the operation fails

(Unpublished)

copyWithNameConflictOverwrite

protected PublicObject copyWithNameConflictOverwrite(LibrarySession session,
                                                     PublicObject srcPO,
                                                     Folder destParentFolder,
                                                     String newName)
                                              throws IfsException

Copy the PublicObject and overwrite the existing object with the same name.

Parameters:

session - LibrarySession

srcPO - source PublicObject

destParentFolder -

newName - name of new object

Returns:

PublicObject the duplicate object

Throws:

IfsException - if the operation fails

(Unpublished)

copyWithNameConflictDeleteOverwrite

protected PublicObject copyWithNameConflictDeleteOverwrite(LibrarySession session,
                                                           PublicObject srcPO,
                                                           Folder destParentFolder,
                                                           String newName,
                                                           PublicObject existingPO)
                                                    throws IfsException

Copy the PublicObject and overwrite the existing object with the same name by deleting the existing object and replacing with the new object. This case handles overwriting an existing object that is not versioned.

Parameters:

session - LibrarySession

srcPO - source PublicObject

destParentFolder -

newName - name of new object

existingPO - existing PublicObject

Returns:

PublicObject the duplicate object

Throws:

IfsException - if the operation fails

(Unpublished)

listFolder

protected PublicObject[] listFolder(FolderPathResolver fpr,
                                    Folder folder,
                                    String pattern)
                             throws IfsException

Returns a list of PublicObjects in the specified folder.

Parameters:

fpr - FolderPathResolver

folder - parent folder

pattern -

Returns:

array of PublicObjects

Throws:

IfsException - if the operation fails

(Unpublished)

validateArgument

protected void validateArgument(Object arg,
                                String name)
                         throws IfsException

Validate argument input. If null, throw an exception.

Parameters:

arg - object to be validated

name - object type

Throws:

IfsException - if the operation fails

(Unpublished)

copyNoOverwrite

protected PublicObject copyNoOverwrite(LibrarySession session,
                                       PublicObject srcPO,
                                       Folder destParentFolder,
                                       String poName)
                                throws IfsException

Copy the PublicObject and do not overwrite.

Parameters:

session - LibrarySession

srcPO - source PublicObject

destParentFolder -

poName - name of new object

Returns:

PublicObject the duplicate object

Throws:

IfsException - if the operation fails

(Unpublished)

performDetermineAcl

protected AccessControlList performDetermineAcl(PublicObjectDefinition def,
                                                String newName,
                                                Folder destParentFolder,
                                                LibrarySession session,
                                                AccessControlList defaultAcl)
                                         throws IfsException

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

Throws:

IfsException

(Unpublished)

handlePublicObjectVersioning

protected void handlePublicObjectVersioning(LibrarySession session,
                                            Folder destParentFolder,
                                            PublicObject newPO)
                                     throws IfsException

Handles versioning the PublicObject.

Parameters:

session - LibrarySession

destParentFolder - parent folder

newPO - new PublicObject

Throws:

IfsException - if the operation fails

(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)

getHandlePublicObjectVersioningCommand

protected IfsHandlePublicObjectVersioningCommand getHandlePublicObjectVersioningCommand()
                                                                                 throws IfsException

Return an instance of the IfsHandlePublicObjectVersioningCommand.

Returns:

IfsHandlePublicObjectVersioningCommand.

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)