org.alfresco.util.test.junitrules

Class TemporarySites

java.lang.Object

org.junit.rules.ExternalResource

org.alfresco.util.test.junitrules.AbstractPersonRule

org.alfresco.util.test.junitrules.TemporarySites

All Implemented Interfaces:

org.junit.rules.TestRule

public class TemporarySites
extends AbstractPersonRule

A JUnit rule designed to help with the automatic cleanup of temporary st:site nodes.

Since:

4.0.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemporarySites.TestSiteAndMemberInfo A simple POJO class to store the SiteInfo for this site and its initial, automatically created members' usernames.

Field Summary

Fields inherited from class org.alfresco.util.test.junitrules.AbstractPersonRule

appContext, appContextRule, EMAIL, FIRST_NAME, JOB_TITLE, LAST_NAME, PASSWORD

Constructor Summary

Constructors

Constructor and Description
TemporarySites(ApplicationContextInit appContextRule) Constructs the rule with a reference to a rule which can be used to retrieve the ApplicationContext.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSite(SiteInfo temporarySite) Add a specified site to the list of SiteInfos to be deleted by this rule.
protected void	after()
protected void	before()
SiteInfo	createSite(java.lang.String sitePreset, java.lang.String siteShortName, java.lang.String siteTitle, java.lang.String siteDescription, SiteVisibility visibility, org.alfresco.service.namespace.QName siteType, java.lang.String siteCreator) This method creates a Share Site (or subtype) and adds it to the internal list of NodeRefs to be tidied up by the rule.
SiteInfo	createSite(java.lang.String sitePreset, java.lang.String siteShortName, java.lang.String siteTitle, java.lang.String siteDescription, SiteVisibility visibility, java.lang.String siteCreator) This method creates a Share Site and adds it to the internal list of NodeRefs to be tidied up by the rule.
TemporarySites.TestSiteAndMemberInfo	createTestSiteWithUserPerRole(java.lang.String siteShortName, java.lang.String sitePreset, SiteVisibility visibility, java.lang.String siteCreator) This method creates a test site (of Alfresco type st:site) and one user for each of the Share Site Roles.

Methods inherited from class org.alfresco.util.test.junitrules.AbstractPersonRule

createPerson, deletePerson, getApplicationContext

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporarySites

public TemporarySites(ApplicationContextInit appContextRule)

Constructs the rule with a reference to a rule which can be used to retrieve the ApplicationContext.

Parameters:

appContextRule - a rule which can be used to retrieve the spring app context.

Method Detail

before

protected void before()
               throws java.lang.Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

java.lang.Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

addSite

public void addSite(SiteInfo temporarySite)

Add a specified site to the list of SiteInfos to be deleted by this rule.

Parameters:

temporarySite - a SiteInfo

createSite

public SiteInfo createSite(java.lang.String sitePreset,
                  java.lang.String siteShortName,
                  java.lang.String siteTitle,
                  java.lang.String siteDescription,
                  SiteVisibility visibility,
                  java.lang.String siteCreator)

This method creates a Share Site and adds it to the internal list of NodeRefs to be tidied up by the rule. This method will be run in its own transaction and will be run with the specified user as the fully authenticated user, thus ensuring the named user is the creator of the new site.

Parameters:

sitePreset - the site preset

siteShortName - the short name of the new site

siteTitle - the title of the new site

siteDescription - the description of the new site

visibility - the visibility

siteCreator - the username of the person who will create the site

Returns:

the newly created SiteInfo (will be of type st:site).

createSite

public SiteInfo createSite(java.lang.String sitePreset,
                  java.lang.String siteShortName,
                  java.lang.String siteTitle,
                  java.lang.String siteDescription,
                  SiteVisibility visibility,
                  org.alfresco.service.namespace.QName siteType,
                  java.lang.String siteCreator)

This method creates a Share Site (or subtype) and adds it to the internal list of NodeRefs to be tidied up by the rule. This method will be run in its own transaction and will be run with the specified user as the fully authenticated user, thus ensuring the named user is the creator of the new site.

Parameters:

sitePreset - the site preset

siteShortName - the short name of the new site

siteTitle - the title of the new site

siteDescription - the description of the new site

visibility - the visibility

node - type the node type of the site (must be st:site or subtype)

siteCreator - the username of the person who will create the site

Returns:

the newly created SiteInfo.

createTestSiteWithUserPerRole

public TemporarySites.TestSiteAndMemberInfo createTestSiteWithUserPerRole(java.lang.String siteShortName,
                                                                 java.lang.String sitePreset,
                                                                 SiteVisibility visibility,
                                                                 java.lang.String siteCreator)

This method creates a test site (of Alfresco type st:site) and one user for each of the Share Site Roles. This method will be run in its own transaction and will be run with the specified user as the fully authenticated user, thus ensuring the named user is the creator of the new site. The site and its users will be deleted automatically by the rule.

Parameters:

sitePreset - the site preset.

visibility - the Site visibility.

siteCreator - the username of a user who will be used to create the site (user must exist of course).

Returns:

the SiteInfo object for the newly created site.