org.alfresco.bm.process.share.soak

Class ShareSearchScenario

java.lang.Object

org.alfresco.bm.process.share.soak.AbstractShareScenario

org.alfresco.bm.process.share.soak.ShareSearchScenario

All Implemented Interfaces:

ShareScenario, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class ShareSearchScenario
extends AbstractShareScenario

Executes an search using the general search box before widening the results and doing paging.

The following page is executed. * indicates a possible start location.

• * 1. Any page after login (including search results page): Search string chosen (see notes)
• 2. Search results page:

Notes on search terms:
The TestFileService is used to find a file searchterms.txt, which is then read and random lines used (a search term per line). If the file does not exist, some default search strings are chosen.

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_SEARCH_STRINGS
static String	DEFAULT_SEARCH_TERMS_FILENAME
static String	EVENT_NAME_SEARCH
String[]	searchStrings

Constructor Summary

Constructors

Constructor and Description
ShareSearchScenario(ShareScenarioRegistry registry, double weight)

Method Summary

Modifier and Type	Method and Description
List<org.alfresco.bm.event.Event>	getNextEvents(org.alfresco.bm.event.Event event, ShareEventData eventData, ShareSoakData soakData, long nextEventTime) If the browser is not on the user dashboard then an event is fired to navigate to the user dashboard.
static String	getRandomSearchString(String[] searchStrings) Choose a random string from the search strings provided
static String[]	getSearchStrings(org.alfresco.bm.file.TestFileService testFileService, String searchTermsFilename) Static helper to find and extract a search term from the given file
void	setEventNameSearch(String eventNameSearch) Override the default name for the search event
void	setSearchTermsFilename(String searchTermsFilename) Override the default test filename containing search terms (one on each line).
void	setTestFileService(org.alfresco.bm.file.TestFileService testFileService) Optionally set the test file service to locate the setSearchTermsFilename(String) file containing search terms to use.

Methods inherited from class org.alfresco.bm.process.share.soak.AbstractShareScenario

afterPropertiesSet, setBeanName, setScenarioName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEARCH_STRINGS

public static final String[] DEFAULT_SEARCH_STRINGS

DEFAULT_SEARCH_TERMS_FILENAME

public static final String DEFAULT_SEARCH_TERMS_FILENAME

See Also:

Constant Field Values

EVENT_NAME_SEARCH

public static final String EVENT_NAME_SEARCH

See Also:

Constant Field Values

searchStrings

public String[] searchStrings

Constructor Detail

ShareSearchScenario

public ShareSearchScenario(ShareScenarioRegistry registry,
                           double weight)

Parameters:

registry - registry with which this instance will be registered

weight - the weight relative to other scenarios registered in the registry

Method Detail

setTestFileService

public void setTestFileService(org.alfresco.bm.file.TestFileService testFileService)

Optionally set the test file service to locate the setSearchTermsFilename(String) file containing search terms to use. If this property is set, the file must be accessible.

Parameters:

testFileService - service providing remote access to test files

setSearchTermsFilename

public void setSearchTermsFilename(String searchTermsFilename)

Override the default test filename containing search terms (one on each line).

Parameters:

searchTermsFilename - the name of the remote file in the test file list

setEventNameSearch

public void setEventNameSearch(String eventNameSearch)

Override the default name for the search event

getNextEvents

public List<org.alfresco.bm.event.Event> getNextEvents(org.alfresco.bm.event.Event event,
                                                       ShareEventData eventData,
                                                       ShareSoakData soakData,
                                                       long nextEventTime)

If the browser is not on the user dashboard then an event is fired to navigate to the user dashboard. If the user dashboard is the currrent page then nothing is done.

Parameters:

event - the event that triggered this choice

eventData - Share-specific data associated with the event

soakData - Session-specific data for the event

nextEventTime - the suggested next event time (for guidance)

Returns:

a list of events to publish (never null) or an empty list if the scenario cannot continue

getSearchStrings

public static String[] getSearchStrings(org.alfresco.bm.file.TestFileService testFileService,
                                        String searchTermsFilename)

Static helper to find and extract a search term from the given file

Parameters:

testFileService - the test files

searchTermsFilename - the name of the file to find

Returns:

a list of search terms (empty if there are none or the remote file does not exist)

getRandomSearchString

public static String getRandomSearchString(String[] searchStrings)

Choose a random string from the search strings provided