org.exoplatform.services.cms.drives

Interface ManageDriveService

All Known Implementing Classes:

ManageDriveServiceImpl

public interface ManageDriveService

Function to manage Drive to be able to add, remove or manage them.

eXo level API

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLABORATION_DRIVE

Method Summary

Modifier and Type	Method and Description
void	addDrive(String name, String workspace, String permissions, String homePath, String views, String icon, boolean viewReferences, boolean viewNonDocument, boolean viewSideBar, boolean showHiddenNode, String allowCreateFolder, String allowNodeTypesOnTree) Register a new drive to workspace or update if the drive is existing
void	clearAllDrivesCache() Clear all drives cache
void	clearGroupCache(String userId) Clear group drives cache
List<DriveData>	getAllDriveByPermission(String permission) Return the list of DriveData This method will look up in all workspaces of repository to find DriveData with specified permission
List<DriveData>	getAllDrives() This method will look up in all workspaces of current repository to find DriveData
List<DriveData>	getAllDrives(boolean withVirtualDrives) This method will look up in all workspaces of current repository to find DriveData
Set<String>	getDeletedDriveNames() Get deleted drive names.
DriveData	getDriveByName(String driveName) Return an DriveData Object
List<DriveData>	getDriveByUserRoles(String userId, List<String> roles) Get all drives by user roles
String	getDriveOfDefaultWorkspace() Get Drive name which point to root folder of default workspace
List<DriveData>	getGroupDrives(String userId, List<String> userRoles) Get all group drives
DriveData	getGroupDriveTemplate() Get the Groups drive
List<DriveData>	getMainDrives(String userId, List<String> userRoles) Get all main drives.
List<DriveData>	getPersonalDrives(String userId) Get all personal drives.
void	init() Register all drive plugins
boolean	isUsedView(String viewName) This method will check to make sure the view is not in used before remove this view
boolean	isVitualDrive(String driveName) Check if a drive is vitual(Group Drive Template)
boolean	newRoleUpdated() Inform when have new role added
void	removeDrive(String driveName) Remove drive with specified drive name and repository
void	setNewRoleUpdated(boolean newRoleUpdated) Set the status of new added role

Field Detail

COLLABORATION_DRIVE

static final String COLLABORATION_DRIVE

See Also:

Constant Field Values

Method Detail

getDriveOfDefaultWorkspace

String getDriveOfDefaultWorkspace()
                           throws Exception

Get Drive name which point to root folder of default workspace

Returns:

String Name of drive.

Throws:

Exception

addDrive

void addDrive(String name,
              String workspace,
              String permissions,
              String homePath,
              String views,
              String icon,
              boolean viewReferences,
              boolean viewNonDocument,
              boolean viewSideBar,
              boolean showHiddenNode,
              String allowCreateFolder,
              String allowNodeTypesOnTree)
       throws Exception

Register a new drive to workspace or update if the drive is existing

Parameters:

name - drive name

workspace - the workspace name where will store the drive

permissions - specify who can access to this drive

homePath - specify the location of drive

views - include all views can see in drive

icon - the drive icon which can see in drive browser

viewReferences - the boolean to set default for drive can view references node or not

viewNonDocument - the boolean to set default for drive can view non document node or not

viewSideBar - the boolean to set default for drive can view side bar or not

showHiddenNode - the boolean to set default for drive can see hidden node or not

allowCreateFolder - the string to specify which type of folder can add in the drive

allowNodeTypesOnTree -

Throws:

Exception

getDriveByName

DriveData getDriveByName(String driveName)
                  throws Exception

Return an DriveData Object

Parameters:

driveName - the string contain the drive name

Returns:

DriveData with specified drive name and repository

Throws:

Exception

See Also:

DriveData

getAllDriveByPermission

List<DriveData> getAllDriveByPermission(String permission)
                                 throws Exception

Return the list of DriveData This method will look up in all workspaces of repository to find DriveData with specified permission

Parameters:

permission - the string contain the permission

Returns:

list of DriveData with specified repository and permission

Throws:

Exception

See Also:

DriveData

removeDrive

void removeDrive(String driveName)
          throws Exception

Remove drive with specified drive name and repository

Parameters:

driveName - drive name

Throws:

Exception

getAllDrives

List<DriveData> getAllDrives(boolean withVirtualDrives)
                      throws Exception

This method will look up in all workspaces of current repository to find DriveData

Parameters:

withVirtualDrives - true: include Virtual Drives, false: not include Virtual Drives

Returns:

list of DriveData with specified repository

Throws:

Exception

getAllDrives

List<DriveData> getAllDrives()
                      throws Exception

This method will look up in all workspaces of current repository to find DriveData

Returns:

list of DriveData with specified repository

Throws:

Exception

isUsedView

boolean isUsedView(String viewName)
            throws Exception

This method will check to make sure the view is not in used before remove this view

Parameters:

viewName - view name

Returns:

the status of current view is in used or not

Throws:

Exception

init

void init()
   throws Exception

Register all drive plugins

Throws:

Exception

getDriveByUserRoles

List<DriveData> getDriveByUserRoles(String userId,
                                    List<String> roles)
                             throws Exception

Get all drives by user roles

Parameters:

userId - User name

roles - Roles of user

Returns:

list of drives

Throws:

Exception

getMainDrives

List<DriveData> getMainDrives(String userId,
                              List<String> userRoles)
                       throws Exception

Get all main drives.

Parameters:

userId - Name of user

userRoles - Roles of user

Returns:

list of drives

Throws:

Exception

getPersonalDrives

List<DriveData> getPersonalDrives(String userId)
                           throws Exception

Get all personal drives.

Parameters:

userId - Name of user

Returns:

list of drives

Throws:

Exception

getGroupDrives

List<DriveData> getGroupDrives(String userId,
                               List<String> userRoles)
                        throws Exception

Get all group drives

Parameters:

userId - Name of user

userRoles - Roles of user

Returns:

list of drives

Throws:

Exception

getGroupDriveTemplate

DriveData getGroupDriveTemplate()

Get the Groups drive

Returns:

The Groups drive

isVitualDrive

boolean isVitualDrive(String driveName)

Check if a drive is vitual(Group Drive Template)

Parameters:

driveName - the string contain the drive name

Returns:

true: is Virtual Drive, false: not is Virtual Drive

clearAllDrivesCache

void clearAllDrivesCache()

Clear all drives cache

clearGroupCache

void clearGroupCache(String userId)

Clear group drives cache

Parameters:

userId - User name of current user

newRoleUpdated

boolean newRoleUpdated()

Inform when have new role added

Returns:

Boolean

setNewRoleUpdated

void setNewRoleUpdated(boolean newRoleUpdated)

Set the status of new added role

Parameters:

newRoleUpdated -

getDeletedDriveNames

Set<String> getDeletedDriveNames()
                          throws Exception

Get deleted drive names.

Returns:

list of deleted drive names

Throws:

Exception