org.alfresco.util.test.junitrules

Class AbstractPersonRule

java.lang.Object

org.junit.rules.ExternalResource

org.alfresco.util.test.junitrules.AbstractPersonRule

All Implemented Interfaces:

org.junit.rules.TestRule

Direct Known Subclasses:

AlfrescoPeople, AlfrescoPerson, TemporarySites

public abstract class AbstractPersonRule
extends org.junit.rules.ExternalResource

This class is an abstract base class for JUnit rules which manage the lifecycle of cm:person nodes and authentication details for the transient users often required within test code.

Since:

Odin

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	appContext
protected ApplicationContextInit	appContextRule
protected static java.lang.String	EMAIL
protected static java.lang.String	FIRST_NAME
protected static java.lang.String	JOB_TITLE
protected static java.lang.String	LAST_NAME
protected static java.lang.String	PASSWORD

Constructor Summary

Constructors

Constructor and Description
AbstractPersonRule(org.springframework.context.ApplicationContext appContext) Constructs a person rule with the specified spring context, which will be necessary to actually create and delete the users.
AbstractPersonRule(ApplicationContextInit appContextRule) Constructs a person rule with a reference to an rule.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.alfresco.service.cmr.repository.NodeRef	createPerson(java.lang.String userName) This method creates a user with the specified username.
protected void	deletePerson(java.lang.String userName) This method deletes the specified user's person and authentication details if they are present in the system.
protected org.springframework.context.ApplicationContext	getApplicationContext() This method retrieves the spring application context given to this rule.

Methods inherited from class org.junit.rules.ExternalResource

after, apply, before

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD

protected static final java.lang.String PASSWORD

See Also:

Constant Field Values

FIRST_NAME

protected static final java.lang.String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

protected static final java.lang.String LAST_NAME

See Also:

Constant Field Values

EMAIL

protected static final java.lang.String EMAIL

See Also:

Constant Field Values

JOB_TITLE

protected static final java.lang.String JOB_TITLE

See Also:

Constant Field Values

appContext

protected final org.springframework.context.ApplicationContext appContext

appContextRule

protected final ApplicationContextInit appContextRule

Constructor Detail

AbstractPersonRule

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

Constructs a person rule with the specified spring context, which will be necessary to actually create and delete the users.

Parameters:

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

AbstractPersonRule

public AbstractPersonRule(ApplicationContextInit appContextRule)

Constructs a person rule with a reference to an rule. This other rule will be used to access the application context and from there the necessary services for the creation and deletion of users.

Parameters:

appContext - a rule which can provide the spring application context.

Method Detail

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

This method retrieves the spring application context given to this rule.

Returns:

the spring application context

Throws:

java.lang.NullPointerException - if the application context has not been initialised when requested.

createPerson

protected org.alfresco.service.cmr.repository.NodeRef createPerson(java.lang.String userName)

This method creates a user with the specified username. If an authentication for this username does not exist, it is created. If a cm:person for this username does not exist, it is created. This method does not handle transactions.

Parameters:

userName - the username of the new user.

Returns:

the NodeRef of the created cm:person node.

deletePerson

protected void deletePerson(java.lang.String userName)

This method deletes the specified user's person and authentication details if they are present in the system. This method does not handle transactions.

Parameters:

userName - the username of the user to be deleted.