2013-08-20 17:17:31 +00:00

94 lines
3.5 KiB
Java

/*
* Copyright (C) 2005-2013 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.util.test.junitrules;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.test.testusers.TestUserComponent;
import org.springframework.context.ApplicationContext;
/**
* This class is an abstract base class for JUnit rules which manage the lifecycle of <code>cm:person</code>
* nodes and authentication details for the transient users often required within test code.
*
* @author Neil Mc Erlean
* @since Odin
*/
public abstract class AbstractPersonRule extends AbstractRule
{
/**
* Constructs a person rule with the specified spring context, which will be necessary
* to actually create and delete the users.
*
* @param appContext the spring app context (needed to get at Alfresco services).
*/
public AbstractPersonRule(ApplicationContext appContext)
{
super(appContext);
}
/**
* Constructs a person rule with a reference to an {@link ApplicationContextInit 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.
*
* @param appContext a rule which can provide the spring application context.
*/
public AbstractPersonRule(ApplicationContextInit appContextRule)
{
super(appContextRule);
}
/**
* 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.
*
* @param userName the username of the new user.
* @return the NodeRef of the created cm:person node.
*/
protected NodeRef createPerson(final String userName)
{
// Get the spring context
final ApplicationContext ctxt = getApplicationContext();
// Extract required service beans
final TestUserComponent testUserComponent = (TestUserComponent) ctxt.getBean("testUserComponent");
return testUserComponent.createTestUser(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.
*
* @param userName the username of the user to be deleted.
*/
protected void deletePerson(final String userName)
{
// Get the spring context
final ApplicationContext ctxt = getApplicationContext();
// Extract required service beans
final TestUserComponent testUserComponent = (TestUserComponent) ctxt.getBean("testUserComponent");
testUserComponent.deleteTestUser(userName);
}
}