org.alfresco.util.test.junitrules

Class AlfrescoPerson

java.lang.Object

org.junit.rules.ExternalResource

org.alfresco.util.test.junitrules.AbstractPersonRule

org.alfresco.util.test.junitrules.AlfrescoPerson

All Implemented Interfaces:

org.junit.rules.TestRule

public class AlfrescoPerson
extends AbstractPersonRule

This JUnit rule can be used to setup and teardown a single Alfresco user for test purposes.

Example usage:

 public class YourTestClass
 {
     // Normally we would initialise the spring application context in another rule.
     @ClassRule public static final ApplicationContextInit APP_CONTEXT_RULE = new ApplicationContextInit();
     
     // We pass the rule that creates the spring application context.
     // This rule will give us a user with username 'NeilM'.
     @Rule public final AlfrescoPerson namedPerson = new AlfrescoPerson(APP_CONTEXT_RULE, "NeilM");
     // This rule with give us a user with a GUID-generated name.
     @Rule public final AlfrescoPerson guidPerson = new AlfrescoPerson(APP_CONTEXT_RULE);
     
     @Test public void aTestMethod()
     {
         AuthenticationUtil.setFullyAuthenticatedUser(namedPerson.getUsername());
         // etc
     }
 }
 

Since:

Odin

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
AlfrescoPerson(org.springframework.context.ApplicationContext appContext) Constructs the rule with a spring ApplicationContext.
AlfrescoPerson(ApplicationContextInit appContextRule) Constructs the rule with a reference to a rule which can be used to retrieve the ApplicationContext.
AlfrescoPerson(ApplicationContextInit appContextRule, java.lang.String userName) Constructs the rule with a reference to a rule which can be used to retrieve the ApplicationContext.
AlfrescoPerson(org.springframework.context.ApplicationContext appContext, java.lang.String userName) Constructs the rule with a spring ApplicationContext.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	after()
protected void	before()
java.lang.String	getPassword()
org.alfresco.service.cmr.repository.NodeRef	getPersonNode() Gets the person node.
java.lang.String	getUsername()

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

AlfrescoPerson

public AlfrescoPerson(org.springframework.context.ApplicationContext appContext)

Constructs the rule with a spring ApplicationContext. A GUID-generated username will be used for the test user.

Parameters:

appContext - the spring app context (needed to get at Alfresco services).

AlfrescoPerson

public AlfrescoPerson(ApplicationContextInit appContextRule)

Constructs the rule with a reference to a rule which can be used to retrieve the ApplicationContext. A GUID-generated username will be used for the test user.

Parameters:

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

AlfrescoPerson

public AlfrescoPerson(org.springframework.context.ApplicationContext appContext,
              java.lang.String userName)

Constructs the rule with a spring ApplicationContext.

Parameters:

appContext - the spring app context (needed to get at Alfresco services).

userName - the username for the person to be created.

AlfrescoPerson

public AlfrescoPerson(ApplicationContextInit appContextRule,
              java.lang.String userName)

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.

userName - the username for the person to be created.

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

getUsername

public java.lang.String getUsername()

Returns:

the username of the person created by this rule.

getPassword

public java.lang.String getPassword()

Returns:

the password of the person created by this rule.

getPersonNode

public org.alfresco.service.cmr.repository.NodeRef getPersonNode()

Gets the person node.

Returns:

the person node.