Files
alfresco-community-repo/source/test-java/org/alfresco/util/test/junitrules/AbstractPersonRule.java
Alan Davis 84841e063f Merged 5.2.N (5.2.1) to HEAD (5.2)
125788 rmunteanu: Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
      125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
         125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127810 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-06-03 17:08:06 +00:00

101 lines
3.8 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* 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/>.
* #L%
*/
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 appContextRule 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);
}
}