org.exoplatform.clouddrive.ecms.action

Class CloudFileAction

java.lang.Object

org.exoplatform.clouddrive.ecms.action.CloudFileAction

public class CloudFileAction
extends Object

Support of Cloud Drive file operations (move, copy and linking) in ECMS. If not a cloud file then this helper return false and the caller code should apply default logic for the file.
Code parts of this class based on original PasteManageComponent and MoveNodeManageComponent (state of ECMS 4.0.4).
Created by The eXo Platform SAS.

Version:

$Id: CloudFileAction.java 00000 May 12, 2014 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.jcr.Node	destNode The dest node.
protected String	destPath The dest path.
protected String	destWorkspace The dest path.
protected String[]	emptyParams The empty params.
protected javax.jcr.Node	link The link.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected boolean	move The move.
protected Set<javax.jcr.Node>	srcNodes Set of source nodes for the operation.
protected org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer	uiExplorer The ui explorer.

Constructor Summary

Constructors

Constructor and Description
CloudFileAction(org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer uiExplorer) Instantiates a new cloud file action.

Method Summary

Modifier and Type	Method and Description
CloudFileAction	addSource(javax.jcr.Node srcNode) Add source file (target file).
CloudFileAction	addSource(String srcInfo) Add source file path (path to target file).
CloudFileAction	addSource(String srcWorkspace, String srcPath) Add source file by its wokrspace name and path.
boolean	apply() Apply an action for all added source files: move, copy or link from source to destination.
javax.jcr.Node	getDestinationNode() Node of already set destination or null if not yet set.
String	getDestinationWorkspace() Workspace of already set destination or null if not yet set.
String	getDestonationPath() Path of already set destination or null if not yet set.
javax.jcr.Node	getLink() Return symlink-node created by apply() method if it returned true.
protected javax.jcr.Node	getNodeByInfo(String pathInfo, boolean giveTarget) Gets the node by info.
protected javax.jcr.Node	getNodeByPath(String workspace, String path, boolean giveTarget) Gets the node by path.
CloudFileAction	move() Link behaviour as instead of "move" operation.
void	rollback() Rollback the symlink at its destination in JCR.
CloudFileAction	setDestination(javax.jcr.Node destNode) Set link destination node.
CloudFileAction	setDestination(String destInfo) Set path of link destination.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

emptyParams

protected final String[] emptyParams

The empty params.

uiExplorer

protected final org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer uiExplorer

The ui explorer.

srcNodes

protected final Set<javax.jcr.Node> srcNodes

Set of source nodes for the operation. We rely on proper implementation of Node's hash code and equality to avoid duplicates.

destWorkspace

protected String destWorkspace

The dest path.

destPath

protected String destPath

The dest path.

destNode

protected javax.jcr.Node destNode

The dest node.

link

protected javax.jcr.Node link

The link.

move

protected boolean move

The move.

Constructor Detail

CloudFileAction

public CloudFileAction(org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer uiExplorer)

Instantiates a new cloud file action.

Parameters:

uiExplorer - the ui explorer

Method Detail

addSource

public CloudFileAction addSource(javax.jcr.Node srcNode)

Add source file (target file).

Parameters:

srcNode - Node

Returns:

the cloud file action

addSource

public CloudFileAction addSource(String srcInfo)
                          throws Exception

Add source file path (path to target file).

Parameters:

srcInfo - String in format of portal request ObjectId, see UIWorkingArea.FILE_EXPLORER_URL_SYNTAX

Returns:

the cloud file action

Throws:

Exception - if cannot find node by given path

addSource

public CloudFileAction addSource(String srcWorkspace,
                                 String srcPath)
                          throws Exception

Add source file by its wokrspace name and path.

Parameters:

srcWorkspace - String

srcPath - String

Returns:

the cloud file action

Throws:

Exception - the exception

setDestination

public CloudFileAction setDestination(javax.jcr.Node destNode)
                               throws Exception

Set link destination node.

Parameters:

destNode - Node

Returns:

the cloud file action

Throws:

Exception - the exception

setDestination

public CloudFileAction setDestination(String destInfo)
                               throws Exception

Set path of link destination.

Parameters:

destInfo - String in format of portal request ObjectId, see UIWorkingArea.FILE_EXPLORER_URL_SYNTAX

Returns:

the cloud file action

Throws:

Exception - if cannot find node by given path or cannot read its metadata

move

public CloudFileAction move()

Link behaviour as instead of "move" operation. Behaviour of "copy" by default.

Returns:

the cloud file action

getLink

public javax.jcr.Node getLink()

Return symlink-node created by apply() method if it returned true. This method has sense only after calling the mentioned method, otherwise this method returns null.

Returns:

the link Node or null if link not yet created or creation wasn't successful.

getDestinationWorkspace

public String getDestinationWorkspace()

Workspace of already set destination or null if not yet set.

Returns:

the destWorkspace String

getDestonationPath

public String getDestonationPath()

Path of already set destination or null if not yet set.

Returns:

the destPath String

getDestinationNode

public javax.jcr.Node getDestinationNode()

Node of already set destination or null if not yet set.

Returns:

the destNode Node

rollback

public void rollback()
              throws javax.jcr.RepositoryException

Rollback the symlink at its destination in JCR.

Throws:

javax.jcr.RepositoryException - the repository exception

apply

public boolean apply()
              throws CloudFileActionException,
                     Exception

Apply an action for all added source files: move, copy or link from source to destination. This method will save the session of destination node in case of symlink creation.

Returns:

true if all sources were linked in destination successfully, false otherwise. If nothing applied return false also.

Throws:

CloudFileActionException - if destination cannot be created locally, this exception will contain detailed message and a internationalized text for WebUI application.

Exception - the exception

getNodeByInfo

protected javax.jcr.Node getNodeByInfo(String pathInfo,
                                       boolean giveTarget)
                                throws Exception

Gets the node by info.

Parameters:

pathInfo - the path info

giveTarget - the give target

Returns:

the node by info

Throws:

Exception - the exception

getNodeByPath

protected javax.jcr.Node getNodeByPath(String workspace,
                                       String path,
                                       boolean giveTarget)
                                throws Exception

Gets the node by path.

Parameters:

workspace - the workspace

path - the path

giveTarget - the give target

Returns:

the node by path

Throws:

Exception - the exception