org.alfresco.bm.dataload

Class SiteFolderLoader

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.dataload.SiteFolderLoader

All Implemented Interfaces:

org.alfresco.bm.event.EventProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class SiteFolderLoader
extends org.alfresco.bm.event.AbstractEventProcessor

Schedule the folder and file loaders and reschedule self until there are enough folders and files.

Each site has one folder, the Document Library, that acts as the root of each tree. Each Document Library is at level one (depth zero) in the calculations.

Every folder receives the same number of files.
To calculate the number of folders and files:

     sites:           the total number of sites
     subfolders:      the number of subfolders in each folder (except the last level)
     filesPerFolder:  the number of files added to each folder
     maxDepth:        the depth of the last level of folders
                      of the site document libraries.
     
     folders = (sites)*(subfolders^0 + subfolders^1 + subfolders^2 + ... + subfolders^(maxDepth-1))
             = (sites)*(    1        +  subfolders  + subfolders^2 + ... + subfolders^(maxDepth-1))
     files   = (folders)*(filesPerFolder)
 

Using the test defaults:

• sites: 100
• subfolders: 5
• filesPerFolder: 100
• maxDepth: 3

     folders = (100)*( 1 + 5 + 25 ) =   3,100
     files   = 3100*100             = 310,000
 

TODO: Put on Wiki

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_FILE_RATIO
static long	DEFAULT_FILING_DELAY
static String	EVENT_NAME_SITE_FOLDER_LOADED

Fields inherited from class org.alfresco.bm.event.AbstractEventProcessor

DEFAULT_AUTO_CLOSE_SESSION_ID, DEFAULT_AUTO_PROPAGATE_SESSION_ID, DEFAULT_CHART, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description

SiteFolderLoader(org.alfresco.bm.session.SessionService sessionService, org.alfresco.bm.cm.FileFolderService fileFolderService, org.alfresco.bm.user.UserDataService userDataService, org.alfresco.bm.site.SiteDataService siteDataService, org.alfresco.bm.file.TestFileService testFileService, String cmisBindingUrl, String cmisBindingType, org.apache.chemistry.opencmis.client.api.OperationContext cmisCtx) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	getRmEnabled()
long	getRmFileDelay()
double	getRmFileRatio()
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event)
void	setEventNameSiteFolderLoaded(String eventNameSiteFolderLoaded) Override the default event name
void	setRmEnabled(boolean rmEnabled) Enables or disables RM
void	setRmFileDelay(long rmFileDelay) Override the DEFAULT_FILING_DELAY default value
void	setRmFileRatio(double rmFileRatio) Override the DEFAULT_FILE_RATIO default value

Methods inherited from class org.alfresco.bm.event.AbstractEventProcessor

getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NAME_SITE_FOLDER_LOADED

public static final String EVENT_NAME_SITE_FOLDER_LOADED

See Also:

Constant Field Values

DEFAULT_FILE_RATIO

public static final double DEFAULT_FILE_RATIO

See Also:

Constant Field Values

DEFAULT_FILING_DELAY

public static final long DEFAULT_FILING_DELAY

See Also:

Constant Field Values

Constructor Detail

SiteFolderLoader

public SiteFolderLoader(org.alfresco.bm.session.SessionService sessionService,
                        org.alfresco.bm.cm.FileFolderService fileFolderService,
                        org.alfresco.bm.user.UserDataService userDataService,
                        org.alfresco.bm.site.SiteDataService siteDataService,
                        org.alfresco.bm.file.TestFileService testFileService,
                        String cmisBindingUrl,
                        String cmisBindingType,
                        org.apache.chemistry.opencmis.client.api.OperationContext cmisCtx)

Constructor

Parameters:

sessionService - service to close this loader's session

fileFolderService - service to access folders

userDataService - service to access user names and passwords

siteDataService - service to access site details

testFileService - service to access sample documents

cmisBindingUrl - the CMIS browser binding URL

cmisCtx - the operation context for all calls made by the session.

Method Detail

setEventNameSiteFolderLoaded

public void setEventNameSiteFolderLoaded(String eventNameSiteFolderLoaded)

Override the default event name

Since:

2.6

getRmEnabled

public boolean getRmEnabled()

Returns:

whether if Records Management is enabled or not

Since:

2.6

setRmEnabled

public void setRmEnabled(boolean rmEnabled)

Enables or disables RM

Parameters:

rmEnabled -

Since:

2.6

getRmFileRatio

public double getRmFileRatio()

Returns:

RM file ration

Since:

2.6

setRmFileRatio

public void setRmFileRatio(double rmFileRatio)

Override the DEFAULT_FILE_RATIO default value

Since:

2.6

getRmFileDelay

public long getRmFileDelay()

Returns:

RM file delay for follow-up events

Since:

2.6

setRmFileDelay

public void setRmFileDelay(long rmFileDelay)

Override the DEFAULT_FILING_DELAY default value

Since:

2.6

processEvent

public org.alfresco.bm.event.EventResult processEvent(org.alfresco.bm.event.Event event)
                                               throws Exception

Specified by:

processEvent in class org.alfresco.bm.event.AbstractEventProcessor

Throws:

Exception