org.exoplatform.wcm.connector.fckeditor

Class DriverConnector

java.lang.Object

org.exoplatform.wcm.connector.BaseConnector

org.exoplatform.wcm.connector.fckeditor.DriverConnector

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class DriverConnector
extends BaseConnector
implements org.exoplatform.services.rest.resource.ResourceContainer

Returns a list of drives/folders/documents in a specified location for a given user. Also, it processes the file uploading action. {{{{portalname}}}}: The name of portal. {{{{restcontextname}}}}: The context name of REST web application which is deployed to the "{{{{portalname}}}}" portal.

eXo level API

Provisional

eXo anchor for generated doc on REST API

DriverConnector

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_TYPE_ALL The Constant FILE_TYPE_MEDIAS.
static String	FILE_TYPE_DMSDOC The Constant FILE_TYPE_DMSDOC.
static String	FILE_TYPE_IMAGE The Constant FILE_TYPE_IMAGE.
static String	FILE_TYPE_MEDIAS The Constant FILE_TYPE_MEDIAS.
static String	FILE_TYPE_SIMPLE_IMAGE The Constant FILE_TYPE_SIMPLE_IMAGE for JPG/JPEG, PNG and GIF.
static String	FILE_TYPE_WEBCONTENT The Constant FILE_TYPE_WEBCONTENT.
static String[]	IMAGE_MIMETYPE The Constant MEDIA_MIMETYPE.
static String[]	MEDIA_MIMETYPE The Constant MEDIA_MIMETYPE.
static String[]	SIMPLE_IMAGE_MIMETYPE The Constant MEDIA_MIMETYPE.
static String	TYPE_CONTENT
static String	TYPE_EDITOR
static String	TYPE_FOLDER

Fields inherited from class org.exoplatform.wcm.connector.BaseConnector

fileHandler, fileUploadHandler, folderHandler, IF_MODIFIED_SINCE_DATE_FORMAT, LAST_MODIFIED_PROPERTY, linkManager, livePortalManagerService, repositoryService, votingService, webSchemaConfigService

Constructor Summary

Constructors

Constructor and Description
DriverConnector(org.exoplatform.container.xml.InitParams params, DocumentService documentService) Instantiates a new driver connector.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	checkExistence(String repositoryName, String workspaceName, String driverName, String currentFolder, String currentPortal, String language, String fileName) Check the status of uploading a file, such as aborting, deleting or progressing the file.
javax.ws.rs.core.Response	checkUploadAvailable() Checks if the drive can upload a new file.
javax.ws.rs.core.Response	cleanName(String fileName) Clean file name
protected javax.ws.rs.core.Response	createProcessUploadResponse(String workspaceName, javax.jcr.Node currentFolderNode, String siteName, String userId, String jcrPath, String action, String language, String fileName, String uploadId, String existenceAction)
protected String	getContentStorageType() Gets the content storage type.
javax.ws.rs.core.Response	getDriveOfNode(String nodePath) Returns the driveName according to the nodePath param which is composed by the driveHomePath and the path of the node
javax.ws.rs.core.Response	getDrivers(String lang) Returns a list of drives for the current user.
String	getDriveTitle(String name)
javax.ws.rs.core.Response	getFoldersAndFiles(String driverName, String currentFolder, String currentPortal, String repositoryName, String workspaceName, String filterBy, String type) Returns all folders and files in a given location.
String	getGroupLabel(String name)
String	getGroupLabel(String groupId, boolean isFull)
int	getLimitSize() Gets the maximum size of the uploaded file.
int	getMaxUploadCount() Gets the maximum number of files uploaded from the client side.
javax.jcr.Node	getNode(String workspace, String absPath)
protected javax.jcr.Node	getRootContentStorage(javax.jcr.Node node) Gets the root content storage.
javax.ws.rs.core.Response	processUpload(String repositoryName, String workspaceName, String driverName, String currentFolder, String currentPortal, String userId, String jcrPath, String action, String language, String fileName, String uploadId, String existenceAction, String srcAction) Controls the process of uploading a file, such as aborting, deleting or progressing the file.
javax.ws.rs.core.Response	uploadFile(javax.servlet.http.HttpServletRequest servletRequest, String uploadId) Uploads a file.

Methods inherited from class org.exoplatform.wcm.connector.BaseConnector

buildXMLResponseCommon, buildXMLResponseForContentStorage, buildXMLResponseForPortal, buildXMLResponseForRoot, buildXMLResponseOnExpand, getContent, getContent, getCorrectContentStorage, getCurrentPortalNode, getResponse, getWebContent

Methods inherited from class java.lang.Object

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

Field Detail

FILE_TYPE_WEBCONTENT

public static final String FILE_TYPE_WEBCONTENT

The Constant FILE_TYPE_WEBCONTENT.

See Also:

Constant Field Values

FILE_TYPE_DMSDOC

public static final String FILE_TYPE_DMSDOC

The Constant FILE_TYPE_DMSDOC.

See Also:

Constant Field Values

FILE_TYPE_MEDIAS

public static final String FILE_TYPE_MEDIAS

The Constant FILE_TYPE_MEDIAS.

See Also:

Constant Field Values

FILE_TYPE_ALL

public static final String FILE_TYPE_ALL

The Constant FILE_TYPE_MEDIAS.

See Also:

Constant Field Values

FILE_TYPE_IMAGE

public static final String FILE_TYPE_IMAGE

The Constant FILE_TYPE_IMAGE.

See Also:

Constant Field Values

FILE_TYPE_SIMPLE_IMAGE

public static final String FILE_TYPE_SIMPLE_IMAGE

The Constant FILE_TYPE_SIMPLE_IMAGE for JPG/JPEG, PNG and GIF.

See Also:

Constant Field Values

MEDIA_MIMETYPE

public static final String[] MEDIA_MIMETYPE

The Constant MEDIA_MIMETYPE.

IMAGE_MIMETYPE

public static final String[] IMAGE_MIMETYPE

The Constant MEDIA_MIMETYPE.

SIMPLE_IMAGE_MIMETYPE

public static final String[] SIMPLE_IMAGE_MIMETYPE

The Constant MEDIA_MIMETYPE.

TYPE_FOLDER

public static final String TYPE_FOLDER

See Also:

Constant Field Values

TYPE_EDITOR

public static final String TYPE_EDITOR

See Also:

Constant Field Values

TYPE_CONTENT

public static final String TYPE_CONTENT

See Also:

Constant Field Values

Constructor Detail

DriverConnector

public DriverConnector(org.exoplatform.container.xml.InitParams params,
                       DocumentService documentService)

Instantiates a new driver connector.

Parameters:

params - The init parameters.

Method Detail

getLimitSize

public int getLimitSize()

Gets the maximum size of the uploaded file.

Returns:

The file size limit.

getMaxUploadCount

public int getMaxUploadCount()

Gets the maximum number of files uploaded from the client side.

Returns:

The maximum number of files uploaded on the client side.

getDriveOfNode

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getDriveOfNode(String nodePath)
                                                                      throws Exception

Returns the driveName according to the nodePath param which is composed by the driveHomePath and the path of the node

Parameters:

nodePath - the path of the webContent

Returns:

the driveName

Throws:

Exception

getDrivers

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getDrivers(String lang)
                                                                  throws Exception

Returns a list of drives for the current user.

Parameters:

lang - The language of the drive name.

Returns:

The drives.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

DriverConnector.getDrivers

getFoldersAndFiles

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getFoldersAndFiles(String driverName,
                                                                                 String currentFolder,
                                                                                 String currentPortal,
                                                                                 String repositoryName,
                                                                                 String workspaceName,
                                                                                 String filterBy,
                                                                                 String type)
                                                                          throws Exception

Returns all folders and files in a given location.

Parameters:

driverName - The drive name.

currentFolder - The current folder.

currentPortal - The current portal.

repositoryName - The repository name.

workspaceName - The workspace name.

filterBy - The type of filter.

Returns:

The folders and files.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

DriverConnector.getFoldersAndFiles

checkUploadAvailable

@RolesAllowed(value="users")
public javax.ws.rs.core.Response checkUploadAvailable()
                                                                            throws Exception

Checks if the drive can upload a new file.

Returns:

Response containing the status indicating if upload is available.

Throws:

Exception

eXo anchor for generated doc on REST API

DriverConnector.checkUploadAvailable

uploadFile

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

Uploads a file.

Parameters:

uploadId - The Id of the uploaded file.

Returns:

The response.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

DriverConnector.uploadFile

checkExistence

@RolesAllowed(value="users")
public javax.ws.rs.core.Response checkExistence(String repositoryName,
                                                                             String workspaceName,
                                                                             String driverName,
                                                                             String currentFolder,
                                                                             String currentPortal,
                                                                             String language,
                                                                             String fileName)
                                                                      throws Exception

Check the status of uploading a file, such as aborting, deleting or progressing the file.

Parameters:

repositoryName - The repository name.

workspaceName - The workspace name.

driverName - The drive name.

currentFolder - The current folder.

currentPortal - The portal name.

language - The language file.

fileName - The file name.

Returns:

The response

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

DriverConnector.checkExistence

cleanName

@RolesAllowed(value="users")
public javax.ws.rs.core.Response cleanName(String fileName)
                                                                 throws Exception

Clean file name

Parameters:

fileName - original file name

Returns:

the response

Throws:

Exception

processUpload

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

Controls the process of uploading a file, such as aborting, deleting or progressing the file.

Parameters:

repositoryName - The repository name.

workspaceName - The workspace name.

driverName - The drive name.

currentFolder - The current folder.

currentPortal - The current portal.

userId - The user identity.

jcrPath - The path of the file.

action - The action.

language - The language.

fileName - The file name.

uploadId - The Id of upload.

existenceAction - Checks if an action exists or not.

Returns:

The response.

Throws:

Exception - The exception

eXo anchor for generated doc on REST API

DriverConnector.processUpload

getContentStorageType

protected String getContentStorageType()
                                throws Exception

Description copied from class: BaseConnector

Gets the content storage type.

Specified by:

getContentStorageType in class BaseConnector

Returns:

the content storage type

Throws:

Exception - the exception

getRootContentStorage

protected javax.jcr.Node getRootContentStorage(javax.jcr.Node node)
                                        throws Exception

Description copied from class: BaseConnector

Gets the root content storage.

Specified by:

getRootContentStorage in class BaseConnector

Parameters:

node - the node

Returns:

the root content storage

Throws:

Exception - the exception

createProcessUploadResponse

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

Parameters:

workspaceName - The workspace name.

currentFolderNode - The current folder.

siteName - The portal name.

userId - The user Id.

jcrPath - The path of the file.

action - The action.

language - The language.

fileName - The file name.

uploadId - The Id of upload.

existenceAction - Checks if an action exists.

Returns:

the response

Throws:

Exception - the exception

getDriveTitle

public String getDriveTitle(String name)

getGroupLabel

public String getGroupLabel(String groupId,
                            boolean isFull)

getGroupLabel

public String getGroupLabel(String name)

getNode

public javax.jcr.Node getNode(String workspace,
                              String absPath)
                       throws Exception

Throws:

Exception