org.alfresco.util.test.junitrules

Class TemporaryNodes

java.lang.Object

org.junit.rules.ExternalResource

org.alfresco.util.test.junitrules.TemporaryNodes

All Implemented Interfaces:

org.junit.rules.TestRule

public class TemporaryNodes
extends org.junit.rules.ExternalResource

A JUnit rule designed to help with the automatic cleanup of temporary test nodes.

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
TemporaryNodes(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	addNodeRef(org.alfresco.service.cmr.repository.NodeRef temporaryNodeRef) Add a specified NodeRef to the list of NodeRefs to be deleted by this rule.
protected void	after()
protected void	before()
org.alfresco.service.cmr.repository.NodeRef	createNode(org.alfresco.service.cmr.repository.NodeRef parentNode, java.lang.String nodeCmName, org.alfresco.service.namespace.QName nodeType, java.lang.String nodeCreator) This method creates a NodeRef and adds it to the internal list of NodeRefs to be tidied up by the rule.
org.alfresco.service.cmr.repository.NodeRef	createNodeWithTextContent(org.alfresco.service.cmr.repository.NodeRef parentNode, org.alfresco.service.namespace.QName childName, java.lang.String nodeCmName, org.alfresco.service.namespace.QName nodeType, java.lang.String nodeCreator, java.lang.String textContent) This method creates a NodeRef with some text/plain, UTF-8 content and adds it to the internal list of NodeRefs to be tidied up by the rule.
org.alfresco.service.cmr.repository.NodeRef	createNodeWithTextContent(org.alfresco.service.cmr.repository.NodeRef parentNode, java.lang.String nodeCmName, org.alfresco.service.namespace.QName nodeType, java.lang.String nodeCreator, java.lang.String textContent) This method creates a NodeRef with some text/plain, UTF-8 content and adds it to the internal list of NodeRefs to be tidied up by the rule.

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

TemporaryNodes

public TemporaryNodes(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

addNodeRef

public void addNodeRef(org.alfresco.service.cmr.repository.NodeRef temporaryNodeRef)

Add a specified NodeRef to the list of NodeRefs to be deleted by this rule.

Parameters:

temporaryNodeRef - a NodeRef

createNode

public org.alfresco.service.cmr.repository.NodeRef createNode(org.alfresco.service.cmr.repository.NodeRef parentNode,
                                                     java.lang.String nodeCmName,
                                                     org.alfresco.service.namespace.QName nodeType,
                                                     java.lang.String nodeCreator)

This method creates a NodeRef 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 cm:creator of the new node.

Parameters:

parentNode - the parent node

nodeCmName - the cm:name of the new node

nodeType - the type of the new node

nodeCreator - the username of the person who will create the node

Returns:

the newly created NodeRef.

createNodeWithTextContent

public org.alfresco.service.cmr.repository.NodeRef createNodeWithTextContent(org.alfresco.service.cmr.repository.NodeRef parentNode,
                                                                    java.lang.String nodeCmName,
                                                                    org.alfresco.service.namespace.QName nodeType,
                                                                    java.lang.String nodeCreator,
                                                                    java.lang.String textContent)

This method creates a NodeRef with some text/plain, UTF-8 content 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 cm:creator of the new node.

Parameters:

parentNode - the parent node

nodeCmName - the cm:name of the new node

nodeType - the type of the new node

nodeCreator - the username of the person who will create the node

textContent - the text/plain, UTF-8 content that will be stored in the node's content. null content will not be written.

Returns:

the newly created NodeRef.

createNodeWithTextContent

public org.alfresco.service.cmr.repository.NodeRef createNodeWithTextContent(org.alfresco.service.cmr.repository.NodeRef parentNode,
                                                                    org.alfresco.service.namespace.QName childName,
                                                                    java.lang.String nodeCmName,
                                                                    org.alfresco.service.namespace.QName nodeType,
                                                                    java.lang.String nodeCreator,
                                                                    java.lang.String textContent)

This method creates a NodeRef with some text/plain, UTF-8 content 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 cm:creator of the new node.

Parameters:

parentNode - the parent node

nodeCmName - the cm:name of the new node

nodeType - the type of the new node

nodeCreator - the username of the person who will create the node

textContent - the text/plain, UTF-8 content that will be stored in the node's content. null content will not be written.

Returns:

the newly created NodeRef.