org.nuxeo.functionaltests

Class RestHelper

java.lang.Object

org.nuxeo.functionaltests.RestHelper

public class RestHelper
extends Object

Since:

8.3

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,Set<String>>	directoryEntryIdsToDelete
protected static org.apache.commons.logging.Log	log

Method Summary

Modifier and Type	Method and Description
static void	addDirectoryEntryToDelete(String directoryName, String entryId)
static void	addDocumentToDelete(String idOrPath)
static void	addDocumentToDelete(String id, String path)
static void	addGroupToDelete(String groupName)
static void	addPermission(String idOrPath, String username, String permission)
static void	addUserToDelete(String userName)
static void	cleanup()
static void	cleanupDirectoryEntries()
static void	cleanupDocuments()
static void	cleanupGroups()
static void	cleanupUsers()
static void	clearDirectoryEntryIdsToDelete()
static int	countQueryPageProvider(String providerName) Runs a page provider on Nuxeo instance and return the total size of documents.
static String	createDirectoryEntry(String directoryName, Map<String,String> properties)
static String	createDocument(String idOrPath, String type, String title)
static String	createDocument(String idOrPath, String type, String title, Map<String,Object> props)
static String	createDocument(String idOrPath, String type, String title, String description)
static void	createGroup(String name, String label)
static void	createGroup(String name, String label, String[] members, String[] subGroups)
static String	createUser(String username, String password)
static String	createUser(String username, String password, String firstName, String lastName, String company, String email, String group)
static void	deleteDirectoryEntries(String directoryName)
static void	deleteDirectoryEntry(String directoryName, String entryId)
static void	deleteDocument(String idOrPath)
static void	deleteGroup(String name)
static void	deleteUser(String username)
static boolean	documentExists(String idOrPath)
static boolean	documentHasWorkflowStarted(String idOrPath)
protected static boolean	executeHTTP(Supplier<okhttp3.Response> fetcher)
protected static <T> boolean	exists(Supplier<T> fetcher)
static Map<String,Object>	fetchDirectoryEntryProperties(String directoryName, String entryId)
protected static org.nuxeo.client.objects.Document	fetchDocumentByIdOrPath(String idOrPath) Fetches a Document instance according the input parameter which can be a document id or path.
static void	followLifecycleTransition(String idOrPath, String transitionName)
static boolean	get(String path) Performs a GET request and return whether or not request was successful.
static String	getWorkflowInstanceTitle(String workflowId)
static boolean	groupExists(String groupName)
static void	logOnServer(String message) Logs on server with RestHelper as source and warn as level.
static void	logOnServer(String level, String message) Logs on server with RestHelper as source.
static void	logOnServer(String source, String level, String message)
static void	operation(String operationId, Map<String,Object> parameters)
static boolean	post(String path, String body) Performs a POST request and return whether or not request was successful.
static void	removeDirectoryEntryToDelete(String directoryName, String entryId)
static void	removeDocumentToDelete(String idOrPath)
static void	removePermissions(String idOrPath, String username)
static void	removeUserToDelete(String userName)
static void	startWorkflowInstance(String idOrPath, String workflowId)
static void	updateDirectoryEntry(String directoryName, String entryId, Map<String,String> properties)
static boolean	userExists(String username)

Methods inherited from class java.lang.Object

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

Field Detail

directoryEntryIdsToDelete

protected static final Map<String,Set<String>> directoryEntryIdsToDelete

log

protected static final org.apache.commons.logging.Log log

Method Detail

cleanup

public static void cleanup()

cleanupDocuments

public static void cleanupDocuments()

cleanupUsers

public static void cleanupUsers()

cleanupGroups

public static void cleanupGroups()

cleanupDirectoryEntries

public static void cleanupDirectoryEntries()

addDocumentToDelete

public static void addDocumentToDelete(String idOrPath)

Since:

9.3

addDocumentToDelete

public static void addDocumentToDelete(String id,
                                       String path)

Since:

9.3

removeDocumentToDelete

public static void removeDocumentToDelete(String idOrPath)

Since:

9.3

addUserToDelete

public static void addUserToDelete(String userName)

removeUserToDelete

public static void removeUserToDelete(String userName)

addGroupToDelete

public static void addGroupToDelete(String groupName)

addDirectoryEntryToDelete

public static void addDirectoryEntryToDelete(String directoryName,
                                             String entryId)

removeDirectoryEntryToDelete

public static void removeDirectoryEntryToDelete(String directoryName,
                                                String entryId)

Since:

9.10

clearDirectoryEntryIdsToDelete

public static void clearDirectoryEntryIdsToDelete()

createUser

public static String createUser(String username,
                                String password)

createUser

public static String createUser(String username,
                                String password,
                                String firstName,
                                String lastName,
                                String company,
                                String email,
                                String group)

deleteUser

public static void deleteUser(String username)

userExists

public static boolean userExists(String username)

Since:

9.3

createGroup

public static void createGroup(String name,
                               String label)

createGroup

public static void createGroup(String name,
                               String label,
                               String[] members,
                               String[] subGroups)

deleteGroup

public static void deleteGroup(String name)

groupExists

public static boolean groupExists(String groupName)

Since:

9.3

createDocument

public static String createDocument(String idOrPath,
                                    String type,
                                    String title)

Since:

9.3

createDocument

public static String createDocument(String idOrPath,
                                    String type,
                                    String title,
                                    String description)

createDocument

public static String createDocument(String idOrPath,
                                    String type,
                                    String title,
                                    Map<String,Object> props)

Since:

9.3

deleteDocument

public static void deleteDocument(String idOrPath)

addPermission

public static void addPermission(String idOrPath,
                                 String username,
                                 String permission)

removePermissions

public static void removePermissions(String idOrPath,
                                     String username)

followLifecycleTransition

public static void followLifecycleTransition(String idOrPath,
                                             String transitionName)

Since:

9.3

documentExists

public static boolean documentExists(String idOrPath)

Since:

9.3

startWorkflowInstance

public static void startWorkflowInstance(String idOrPath,
                                         String workflowId)

Since:

9.3

documentHasWorkflowStarted

public static boolean documentHasWorkflowStarted(String idOrPath)

Since:

9.3

getWorkflowInstanceTitle

public static String getWorkflowInstanceTitle(String workflowId)

Since:

10.10

fetchDocumentByIdOrPath

protected static org.nuxeo.client.objects.Document fetchDocumentByIdOrPath(String idOrPath)

Fetches a Document instance according the input parameter which can be a document id or path.

CAUTION: Keep this method protected, we want to keep nuxeo-java-client objects here.

Since:

9.3

countQueryPageProvider

public static int countQueryPageProvider(String providerName)

Runs a page provider on Nuxeo instance and return the total size of documents.

Returns:

the total size of documents

Since:

9.3

createDirectoryEntry

public static String createDirectoryEntry(String directoryName,
                                          Map<String,String> properties)

Since:

9.2

fetchDirectoryEntryProperties

public static Map<String,Object> fetchDirectoryEntryProperties(String directoryName,
                                                               String entryId)

Since:

9.3

updateDirectoryEntry

public static void updateDirectoryEntry(String directoryName,
                                        String entryId,
                                        Map<String,String> properties)

Since:

9.10

deleteDirectoryEntry

public static void deleteDirectoryEntry(String directoryName,
                                        String entryId)

Since:

9.2

deleteDirectoryEntries

public static void deleteDirectoryEntries(String directoryName)

Since:

9.10

operation

public static void operation(String operationId,
                             Map<String,Object> parameters)

Since:

9.3

logOnServer

public static void logOnServer(String message)

Logs on server with RestHelper as source and warn as level.

Since:

9.3

logOnServer

public static void logOnServer(String level,
                               String message)

Logs on server with RestHelper as source.

logOnServer

public static void logOnServer(String source,
                               String level,
                               String message)

Parameters:

source - the logger source, usually RestHelper or WebDriver

level - the log level

Since:

9.3

get

public static boolean get(String path)

Performs a GET request and return whether or not request was successful.

Since:

9.3

post

public static boolean post(String path,
                           String body)

Performs a POST request and return whether or not request was successful.

Since:

9.3

executeHTTP

protected static boolean executeHTTP(Supplier<okhttp3.Response> fetcher)

Since:

9.3

exists

protected static <T> boolean exists(Supplier<T> fetcher)

Since:

9.3