org.exoplatform.services.cms.drives.impl

Class ManageDriveServiceImpl

java.lang.Object

org.exoplatform.services.cms.drives.impl.ManageDriveServiceImpl

All Implemented Interfaces:

ManageDriveService, org.picocontainer.Startable

public class ManageDriveServiceImpl
extends Object
implements ManageDriveService, org.picocontainer.Startable

Created by The eXo Platform SARL Author : Nguyen Quang Hung nguyenkequanghung@yahoo.com Feb 27, 2006

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRIVE_PARAMATER_GROUP_ID
static String	DRIVE_PARAMATER_USER_ID
static String	GROUPS_DRIVE_NAME
static String	GROUPS_DRIVE_ROOT_NODE
static String	PERSONAL_DRIVE_NAME
static String	PERSONAL_DRIVE_PRIVATE_FOLDER_NAME
static String	PERSONAL_DRIVE_PUBLIC_FOLDER_NAME
static String	PERSONAL_DRIVE_ROOT_NODE
static String	USER_DRIVE_NAME

Fields inherited from interface org.exoplatform.services.cms.drives.ManageDriveService

COLLABORATION_DRIVE

Constructor Summary

Constructors

Constructor and Description

ManageDriveServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, DMSConfiguration dmsConfiguration, org.exoplatform.services.cache.CacheService caService, org.exoplatform.services.organization.OrganizationService organizationService) Constructor method Construcs RepositoryService, NodeHierarchyCreator, baseDrivePath_

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 name) Return an DriveData Object
List<DriveData>	getDriveByUserRoles(String userId, List<String> userRoles) 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.
protected List<String>	getUserMemberships(String userId)
protected boolean	hasPermissionOnDrive(DriveData drive, List<String> userMemberships)
void	init() Init drive node with specified repository
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	setManageDrivePlugin(ManageDrivePlugin drivePlugin) Add new ManageDrivePlugin to drivePlugins_
void	setNewRoleUpdated(boolean newRoleUpdated) Set the status of new added role
void	start() Implemented method from Startable class init all ManageDrivePlugin
void	stop() Implemented method from Startable class

Methods inherited from class java.lang.Object

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

Field Detail

GROUPS_DRIVE_NAME

public static final String GROUPS_DRIVE_NAME

See Also:

Constant Field Values

GROUPS_DRIVE_ROOT_NODE

public static final String GROUPS_DRIVE_ROOT_NODE

See Also:

Constant Field Values

PERSONAL_DRIVE_NAME

public static final String PERSONAL_DRIVE_NAME

See Also:

Constant Field Values

PERSONAL_DRIVE_PUBLIC_FOLDER_NAME

public static final String PERSONAL_DRIVE_PUBLIC_FOLDER_NAME

See Also:

Constant Field Values

PERSONAL_DRIVE_PRIVATE_FOLDER_NAME

public static final String PERSONAL_DRIVE_PRIVATE_FOLDER_NAME

See Also:

Constant Field Values

USER_DRIVE_NAME

public static final String USER_DRIVE_NAME

See Also:

Constant Field Values

PERSONAL_DRIVE_ROOT_NODE

public static final String PERSONAL_DRIVE_ROOT_NODE

See Also:

Constant Field Values

DRIVE_PARAMATER_USER_ID

public static final String DRIVE_PARAMATER_USER_ID

See Also:

Constant Field Values

DRIVE_PARAMATER_GROUP_ID

public static final String DRIVE_PARAMATER_GROUP_ID

See Also:

Constant Field Values

Constructor Detail

ManageDriveServiceImpl

public ManageDriveServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService,
                              org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                              DMSConfiguration dmsConfiguration,
                              org.exoplatform.services.cache.CacheService caService,
                              org.exoplatform.services.organization.OrganizationService organizationService)
                       throws Exception

Constructor method Construcs RepositoryService, NodeHierarchyCreator, baseDrivePath_

Parameters:

jcrService -

nodeHierarchyCreator -

Throws:

Exception

Method Detail

start

public void start()

Implemented method from Startable class init all ManageDrivePlugin

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Implemented method from Startable class

Specified by:

stop in interface org.picocontainer.Startable

init

public void init()
          throws Exception

Init drive node with specified repository

Specified by:

init in interface ManageDriveService

Throws:

Exception

setManageDrivePlugin

public void setManageDrivePlugin(ManageDrivePlugin drivePlugin)

Add new ManageDrivePlugin to drivePlugins_

Parameters:

drivePlugin -

getAllDrives

public List<DriveData> getAllDrives()
                             throws Exception

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

Specified by:

getAllDrives in interface ManageDriveService

Returns:

list of DriveData with specified repository

Throws:

Exception

getAllDrives

public List<DriveData> getAllDrives(boolean withVirtualDrives)
                             throws Exception

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

Specified by:

getAllDrives in interface ManageDriveService

Parameters:

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

Returns:

list of DriveData with specified repository

Throws:

Exception

getDriveByName

public DriveData getDriveByName(String name)
                         throws Exception

Return an DriveData Object

Specified by:

getDriveByName in interface ManageDriveService

Parameters:

name - the string contain the drive name

Returns:

DriveData with specified drive name and repository

Throws:

Exception

See Also:

DriveData

addDrive

public 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

Specified by:

addDrive in interface ManageDriveService

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

Throws:

Exception

getAllDriveByPermission

public 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

Specified by:

getAllDriveByPermission in interface ManageDriveService

Parameters:

permission - the string contain the permission

Returns:

list of DriveData with specified repository and permission

Throws:

Exception

See Also:

DriveData

removeDrive

public void removeDrive(String driveName)
                 throws Exception

Remove drive with specified drive name and repository

Specified by:

removeDrive in interface ManageDriveService

Parameters:

driveName - drive name

Throws:

Exception

isUsedView

public boolean isUsedView(String viewName)
                   throws Exception

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

Specified by:

isUsedView in interface ManageDriveService

Parameters:

viewName - view name

Returns:

the status of current view is in used or not

Throws:

Exception

getDriveByUserRoles

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

Get all drives by user roles

Specified by:

getDriveByUserRoles in interface ManageDriveService

Parameters:

userId - User name

userRoles - Roles of user

Returns:

list of drives

Throws:

Exception

getGroupDrives

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

Get all group drives

Specified by:

getGroupDrives in interface ManageDriveService

Parameters:

userId - Name of user

userRoles - Roles of user

Returns:

list of drives

Throws:

Exception

getGroupDriveTemplate

public DriveData getGroupDriveTemplate()

Get the Groups drive

Specified by:

getGroupDriveTemplate in interface ManageDriveService

Returns:

The Groups drive

getMainDrives

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

Get all main drives.

Specified by:

getMainDrives in interface ManageDriveService

Parameters:

userId - Name of user

userRoles - Roles of user

Returns:

list of drives

Throws:

Exception

getPersonalDrives

public List<DriveData> getPersonalDrives(String userId)
                                  throws Exception

Get all personal drives.

Specified by:

getPersonalDrives in interface ManageDriveService

Parameters:

userId - Name of user

Returns:

list of drives

Throws:

Exception

hasPermissionOnDrive

protected boolean hasPermissionOnDrive(DriveData drive,
                                       List<String> userMemberships)

getUserMemberships

protected List<String> getUserMemberships(String userId)
                                   throws Exception

Throws:

Exception

isVitualDrive

public boolean isVitualDrive(String driveName)

Check if a drive is vitual(Group Drive Template)

Specified by:

isVitualDrive in interface ManageDriveService

Parameters:

driveName - the string contain the drive name

Returns:

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

clearAllDrivesCache

public void clearAllDrivesCache()

Clear all drives cache

Specified by:

clearAllDrivesCache in interface ManageDriveService

clearGroupCache

public void clearGroupCache(String userId)

Clear group drives cache

Specified by:

clearGroupCache in interface ManageDriveService

Parameters:

userId - User name of current user

newRoleUpdated

public boolean newRoleUpdated()

Inform when have new role added

Specified by:

newRoleUpdated in interface ManageDriveService

Returns:

Boolean

setNewRoleUpdated

public void setNewRoleUpdated(boolean newRoleUpdated)

Set the status of new added role

Specified by:

setNewRoleUpdated in interface ManageDriveService

getDriveOfDefaultWorkspace

public String getDriveOfDefaultWorkspace()
                                  throws Exception

Get Drive name which point to root folder of default workspace

Specified by:

getDriveOfDefaultWorkspace in interface ManageDriveService

Returns:

String Name of drive.

Throws:

Exception

getDeletedDriveNames

public Set<String> getDeletedDriveNames()
                                 throws Exception

Description copied from interface: ManageDriveService

Get deleted drive names.

Specified by:

getDeletedDriveNames in interface ManageDriveService

Returns:

list of deleted drive names

Throws:

Exception