org.exoplatform.wcm.connector.collaboration

Class RenameConnector

java.lang.Object

org.exoplatform.wcm.connector.collaboration.RenameConnector

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class RenameConnector
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

The RenameConnector aims to enhance the use of the _rename_ action on the Sites Explorer. The system allows setting two values: _name_ and _title_. The _title_ is a logical name that is used to display in the Sites Explorer. The _name_ is the technical name of the file at JCR level. It is notably exposed via the WEBDAV layer.

eXo level API

Experimental

eXo anchor for generated doc on REST API

RenameConnector

Constructor Summary

Constructors

Constructor and Description
RenameConnector()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getObjectId(String nodePath) Gets _objectid_ of the renamed node.
javax.ws.rs.core.Response	rename(String oldPath, String newTitle) Calls RenameConnector REST service to execute the "_rename_" process.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameConnector

public RenameConnector()

Method Detail

getObjectId

public javax.ws.rs.core.Response getObjectId(String nodePath)
                                      throws Exception

Gets _objectid_ of the renamed node. Basically, _objectid_ is a pattern which is useful to find HTML tags of a specific node. _objectid_ actually is the node path encoded by _URLEncoder_.

Parameters:

nodePath - The node path

Returns:

_objectid_

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

RenameConnector.getObjectId

rename

@RolesAllowed(value="users")
public javax.ws.rs.core.Response rename(String oldPath,
                                                                     String newTitle)
                                                              throws Exception

Calls RenameConnector REST service to execute the "_rename_" process.

Parameters:

oldPath - The old path of the renamed node with syntax: [workspace:node path]

newTitle - The new title of the node.

Returns:

Httpstatus 400 if renaming fails, otherwise the UUID of the renamed node is returned.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

RenameConnector.rename