org.exoplatform.ecm.connector.platform

Class ManageDocumentService

java.lang.Object

org.exoplatform.ecm.connector.platform.ManageDocumentService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

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

This service is used to perform some actions on a folder or on a file, such as creating, or deleting a folder/file, or uploading a file.

eXo level API

Provisional

eXo anchor for generated doc on REST API

ManageDocumentService

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXO_DOCUMENTFOLDER
static String	EXO_FAVOURITE_FOLDER
static String	EXO_MUSICFOLDER
static String	EXO_PICTUREFOLDER
static String	EXO_PRIMARYTYPE
static String	EXO_SEARCHFOLDER
static String	EXO_SYMLINK
static String	EXO_TRASH_FOLDER
static String	EXO_VIDEOFOLDER
protected FileUploadHandler	fileUploadHandler The file upload handler.
protected static String	IF_MODIFIED_SINCE_DATE_FORMAT The Constant IF_MODIFIED_SINCE_DATE_FORMAT.
protected static String	LAST_MODIFIED_PROPERTY The Constant LAST_MODIFIED_PROPERTY.
static String	NT_FOLDER
static String	NT_UNSTRUCTURED
static String[]	SPECIFIC_FOLDERS

Constructor Summary

Constructors

Constructor and Description
ManageDocumentService(ManageDriveService manageDriveService, LinkManager linkManager, org.exoplatform.container.xml.InitParams params) Instantiates a document service.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFolder(String driveName, String workspaceName, String currentFolder, String folderName) Creates a new folder and returns its information.
protected javax.ws.rs.core.Response	createProcessUploadResponse(String workspaceName, javax.jcr.Node currentFolderNode, String siteName, String userId, String action, String language, String fileName, String uploadId, String existenceAction) Creates the process upload response.
javax.ws.rs.core.Response	deleteFolderOrFile(String driveName, String workspaceName, String itemPath) Deletes a folder/file.
javax.ws.rs.core.Response	getDrives(String driveType, String showPrivate, String showPersonal) Gets all drives by type (General, Group or Personal).
javax.ws.rs.core.Response	getFoldersAndFiles(String driveName, String workspaceName, String currentFolder, String showHidden) Gets all folders and files which can be viewed by the current user.
static String	getNodeTypeIcon(javax.jcr.Node node)
javax.ws.rs.core.Response	processUpload(String workspaceName, String driveName, String currentFolder, String currentPortal, String action, String language, String fileName, String uploadId, String existenceAction) Returns information about the upload status of a file, such as the upload percentage, the file name, and more.
javax.ws.rs.core.Response	uploadFile(javax.servlet.http.HttpServletRequest servletRequest, String uploadId) Uploads a file to the server.

Methods inherited from class java.lang.Object

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

Field Detail

IF_MODIFIED_SINCE_DATE_FORMAT

protected static final String IF_MODIFIED_SINCE_DATE_FORMAT

The Constant IF_MODIFIED_SINCE_DATE_FORMAT.

See Also:

Constant Field Values

LAST_MODIFIED_PROPERTY

protected static final String LAST_MODIFIED_PROPERTY

The Constant LAST_MODIFIED_PROPERTY.

See Also:

Constant Field Values

fileUploadHandler

protected FileUploadHandler fileUploadHandler

The file upload handler.

EXO_MUSICFOLDER

public static final String EXO_MUSICFOLDER

See Also:

Constant Field Values

EXO_VIDEOFOLDER

public static final String EXO_VIDEOFOLDER

See Also:

Constant Field Values

EXO_PICTUREFOLDER

public static final String EXO_PICTUREFOLDER

See Also:

Constant Field Values

EXO_DOCUMENTFOLDER

public static final String EXO_DOCUMENTFOLDER

See Also:

Constant Field Values

EXO_SEARCHFOLDER

public static final String EXO_SEARCHFOLDER

See Also:

Constant Field Values

EXO_SYMLINK

public static final String EXO_SYMLINK

See Also:

Constant Field Values

EXO_PRIMARYTYPE

public static final String EXO_PRIMARYTYPE

See Also:

Constant Field Values

EXO_TRASH_FOLDER

public static final String EXO_TRASH_FOLDER

See Also:

Constant Field Values

EXO_FAVOURITE_FOLDER

public static final String EXO_FAVOURITE_FOLDER

See Also:

Constant Field Values

NT_UNSTRUCTURED

public static final String NT_UNSTRUCTURED

See Also:

Constant Field Values

NT_FOLDER

public static final String NT_FOLDER

See Also:

Constant Field Values

SPECIFIC_FOLDERS

public static final String[] SPECIFIC_FOLDERS

Constructor Detail

ManageDocumentService

public ManageDocumentService(ManageDriveService manageDriveService,
                             LinkManager linkManager,
                             org.exoplatform.container.xml.InitParams params)

Instantiates a document service.

Parameters:

manageDriveService - Instantiates a drive manager service.

linkManager - Instantiates a link manager service.

Method Detail

getDrives

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getDrives(String driveType,
                                                                        String showPrivate,
                                                                        String showPersonal)
                                                                 throws Exception

Gets all drives by type (General, Group or Personal).

Parameters:

driveType - The types of drive (General, Group, or Personal).

showPrivate - Shows the Private drive or not. The default value is false.

showPersonal - Shows the Personal drive or not. The default value is false.

Returns:

Document which contains the drives.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

ManageDocumentService.getDrives

getFoldersAndFiles

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getFoldersAndFiles(String driveName,
                                                                                 String workspaceName,
                                                                                 String currentFolder,
                                                                                 String showHidden)

Gets all folders and files which can be viewed by the current user.

Parameters:

driveName - The drive name.

workspaceName - The workspace name.

currentFolder - The path to the folder to achieve its folders and files.

showHidden - Shows the hidden items or not. The default value is false.

Returns:

Document which contains the folders and files.

eXo anchor for generated doc on REST API

ManageDocumentService.getFoldersAndFiles

deleteFolderOrFile

@RolesAllowed(value="users")
public javax.ws.rs.core.Response deleteFolderOrFile(String driveName,
                                                                                 String workspaceName,
                                                                                 String itemPath)

Deletes a folder/file.

Parameters:

driveName - The drive name.

workspaceName - The workspace name.

itemPath - The path to the folder/file.

Returns:

Response Returns the status of an item which has been deleted.

eXo anchor for generated doc on REST API

ManageDocumentService.deleteFolderOrFile

createFolder

@RolesAllowed(value="users")
public javax.ws.rs.core.Response createFolder(String driveName,
                                                                           String workspaceName,
                                                                           String currentFolder,
                                                                           String folderName)
                                                                    throws Exception

Creates a new folder and returns its information.

Parameters:

driveName - The drive name.

workspaceName - The workspace name.

currentFolder - The path to the folder where a child folder is added.

folderName - The folder name.

Returns:

Document which contains the created folder.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

ManageDocumentService.createFolder

uploadFile

@RolesAllowed(value="users")
public javax.ws.rs.core.Response uploadFile(@Context
                                                                         javax.servlet.http.HttpServletRequest servletRequest,
                                                                         String uploadId)
                                                                  throws Exception

Uploads a file to the server.

Parameters:

uploadId - The Id of the uploaded resource.

servletRequest - The request.

Returns:

The response.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

ManageDocumentService.uploadFile

processUpload

@RolesAllowed(value="users")
public javax.ws.rs.core.Response processUpload(String workspaceName,
                                                                            String driveName,
                                                                            String currentFolder,
                                                                            String currentPortal,
                                                                            String action,
                                                                            String language,
                                                                            String fileName,
                                                                            String uploadId,
                                                                            String existenceAction)
                                                                     throws Exception

Returns information about the upload status of a file, such as the upload percentage, the file name, and more.

Parameters:

workspaceName - The workspace name.

driveName - The drive name.

currentFolder - The path to the current folder.

currentPortal - The name of the current site.

action - The action to perform (saving, processing, and more).

language - The language of the user.

fileName - The name of the file.

uploadId - The Id of the uploaded resource.

Returns:

The response.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

ManageDocumentService.processUpload

getNodeTypeIcon

public static String getNodeTypeIcon(javax.jcr.Node node)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

createProcessUploadResponse

protected javax.ws.rs.core.Response createProcessUploadResponse(String workspaceName,
                                                                javax.jcr.Node currentFolderNode,
                                                                String siteName,
                                                                String userId,
                                                                String action,
                                                                String language,
                                                                String fileName,
                                                                String uploadId,
                                                                String existenceAction)
                                                         throws Exception

Creates the process upload response.

Parameters:

workspaceName - the workspace name.

userId - The user Id.

action - The action.

language - The language.

fileName - The file name.

uploadId - The upload Id.

siteName - The portal name.

currentFolderNode - The current folder node.

Returns:

the response

Throws:

Exception - the exception