FuncTestRpcHandler (Atlassian Confluence 7.8.1 API)

All Known Implementing Classes:

FuncTestRpcDelegator, FuncTestRpcHandlerImpl
```
public interface FuncTestRpcHandler
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addExistingProfilePicture(String token, String userName, String fileName)` Attempts to add a existing profile picture to a user's profile.
`boolean`	`addGroupAnyCase(String token, String groupname)` Allows addition of a group without enforcing that the name be all lower case.
`int`	`addLabelToLabelable(String token, String labelName, String labelableId, String labelableType)` Adds a label to a labelable, because the public RPC API doesn't let you do it.
`boolean`	`addMailServer(String token, String serverName, String protocol, String hostname, int port, String username, String password, String toAddress)` Add a POP server to poll for emails in a particular account.
`boolean`	`addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)` Add an SMTP mail server.
`boolean`	`addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)`
`boolean`	`addUserAnyCase(String token, String username, String email, String fullname, String password)` Allows addition of a user without enforcing that the username be all lower case.
`boolean`	`assertThatIndexQueueEntryHasBeenProcessed(String token, String searchableClassname, String searchableId)`
`boolean`	`changeAttachmentCreatedDate(String token, String contentId, String attachmentFileName, Date createdDate)` Change the created date of an attachment
`boolean`	`changeBlogPostModificationDate(String token, String blogId, Date modificationDate)` Change the modification date of a blog post
`boolean`	`changeCommentCreatedDate(String token, String commentId, Date createdDate)` Change the created date of a comment
`String`	`changeLoggerLevel(String token, String loggerName, String level)` Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.
`boolean`	`changePageCreatedDate(String token, String pageId, Date createdDate)` Change the created date of a page
`boolean`	`changePageModificationDate(String token, String pageId, Date modificationDate)` Change the modification date of a page
`boolean`	`changeSpaceCreatedDate(String token, String spaceKey, Date createdDate)` Change the created date of a space
`boolean`	`clearCustomHtml(String token)` Clears the global custom html.
`boolean`	`clearEventListeners(String token)` Removes all temporary event listeners, regardless of their state.
`boolean`	`clearIndex(String token)` Blows away the main Confluence search index.
`boolean`	`clearQueue(String token, String queueName)` Removes all items from the specified queue
`boolean`	`clearRecordedLogMessages(String token)`
`Boolean`	`clearSystemProperty(String token, String name)` Unset a system property.
`String`	`convertMarkupToXhtml(String token, String wikiMarkup, String pageId)` Render a page as XHTML.
`String`	`convertXhtmlToMarkup(String token, String xhtml, String pageId)` Convert XHTML to WikiMarkup.
`int`	`countDrafts(String token, String owner)`
`Hashtable`	`createDraft(String token, Hashtable draft)` Creates a draft for the draft owner and draft type with the specified title and content.
`boolean`	`createJohnsonEvent(String token, String message)` Creates a Johnson event inside Confluence.
`Vector<Hashtable>`	`createPagesFromPrototype(String token, Hashtable pageStruct, int count)` Creates a series of pages based on a prototype.
`Vector<String>`	`createSpaces(String token, int count)` Creates a bunch of spaces.
`String`	`createTemplate(String token, String templateName, String content, String spaceKey)` Create a new template.
`String`	`createTemplateWithStorageFormat(String token, String templateName, String storageFormat, String spaceKey)` Create a new template from storage format code.
`int`	`createTestUsers(String token, int count)` Create test users with usernames "testuser0", "testuser1", etc.
`boolean`	`createUserMacro(String token, String name, boolean hasBody, String bodyType, String outputType, String template, String title, String description, String category, String iconUrl, String documentationUrl, boolean hidden)` Create a User Macro
`boolean`	`disablePlugin(String token, String pluginKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`disablePluginModule(String tokdis, String pluginKey, String moduleKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`disablePluginWithoutPersisting(String token, String pluginKey)` Disable a plugin without persisting.
`boolean`	`disableSiteFeature(String token, String featureKey)` Deprecated. since 5.6. Use the REST resource.
`boolean`	`disableUserFeature(String token, String featureKey)` Deprecated. since 5.6. Use the REST resource.
`boolean`	`disconnectGroup(String token, String groupName)` Disconnect a group from Confluence.
`boolean`	`disconnectUser(String token, String username)` Disconnect a user from Confluence.
`boolean`	`doesDraftExist(String token, String contentId, String owner, String draftType, String spaceKey)` Determines if a draft of the specified type and belonging to the specified owner exists.
`boolean`	`enableCaptcha(String token, boolean enable)` Sets the captcha mode
`boolean`	`enableCaptchaDebugMode(String token, boolean enable)` Sets the captcha mode into debug mode.
`boolean`	`enableDailyReportNotification(String token, String userName, boolean dailyReportEnabled)` Sets the Daily Report email for a user to enabled or disabled.
`boolean`	`enableElevatedSecurityCheck(String token, boolean enabled)`
`boolean`	`enablePlugin(String token, String pluginKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`enablePluginModule(String token, String pluginKey, String moduleKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`enablePublicSignUp(String token, boolean enabled)` Sets the public sign up enabled status
`boolean`	`enableSiteFeature(String token, String featureKey)` Deprecated. since 5.6. Use the REST resource.
`boolean`	`enableUserFeature(String token, String featureKey)` Deprecated. since 5.6. Use the REST resource.
`boolean`	`enableWebSudo(String token, boolean enabled)` Sets the web sudo enabled status
`Vector<String>`	`finishLoggingRequests(String token)` Finish logging http request and return any requests made.
`boolean`	`flushAllCaches(String token)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`boolean`	`followUser(String token, String userName, boolean followUser)` Follows or stops following a user.
`Vector<Hashtable>`	`getAliveThreads(String token)`
`Hashtable<String,Object>`	`getAllContentForAllLabels(String token, int offset, int maxResults, String labelsString)` Returns current and trashed CEOs having all of the labels supplied in the string.
`String`	`getAnonyimizedClusterNodeIdentifier(String token)`
`Object`	`getApplicationConfigProperty(String token, String propertyKey)` Returns a property of the global `ApplicationConfiguration` instance.
`Object`	`getBandanaValue(String token, String space, String key)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`Integer`	`getCacheMaximumNumberOfElements(String token, String cacheName)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`Hashtable`	`getCacheStatistics(String token, String cacheName)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`Vector<String>`	`getCacheStatisticsCapabilities(String token)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`String`	`getConfiguredThemeForSpace(String token, String spaceKey)` Deprecated. since 5.6. Use FuncTestAdminThemeResource.
`Hashtable<String,Object>`	`getContentForAllLabels(String token, int offset, int maxResults, String labels)` Returns CEOs having all of the labels supplied in the string.
`Hashtable<String,Object>`	`getContentInSpacesForAllLabels(String token, int offset, int maxResults, String spaceKeysString, String labelsString)` Returns CEOs in the given spaces having all of the labels supplied in the string.
`String`	`getContentPropertiesString(String token, String entityId, String key)` Get the string value of a `ContentProperty` associated with a content entity given its id and the property name
`String`	`getContentPropertiesStringForSpace(String token, String spaceKey, String key)` Get the string value of a `ContentProperty` associated with the `SpaceDescription` of the space
`String`	`getContentProperty(String token, String entityId, String key)` Get the content property value for a content entity given its id and the property key
`Vector`	`getContentPropertyKeys(String token, String entityId)` Get the content property keys for a content entity given its id
`String`	`getContentStringProperty(String token, String entityId, String key)` Get the content property string value (in OS_PROPERTYENTRY) for a content entity given its id and property key
`String`	`getContentTextProperty(String token, String entityId, String key)` Get the content property text value (in OS_PROPERTYENTRY) for a content entity given its id and property key
`String`	`getDatabaseStatistics(String token)` Return database statistics.
`String`	`getExportBuildNumber(String token)` Returns the backward-compatibility of an export
`Hashtable<String,Object>`	`getForLabels(String token, String labelableType, int offset, int maxResults, String labelsString)` Returns any kind of Labelable entities having all of the labels supplied in the string.
`String`	`getGlobalConfiguredTheme(String token)` Deprecated. since 5.6. Use FuncTestAdminThemeResource.
`String[]`	`getGlobalPermissionsForGroup(String token, String groupName)` Gets the global permissions that the given group has.
`String`	`getIdOfPagePermission(String token, String contentId, String permissionType, String username)`
`boolean`	`getIgnoreBaseURLWarning(String token)` Whether the warning message for an un-advisable value for the Base URL is ignored or not.
`String`	`getLeastRecentTestAppenderLogMessage(String token, String className)`
`String`	`getLocaleForUser(String token, String username)` Gets the locale preference for the user.
`String`	`getLocalisedText(String token, String messageKey)` Get the localised string for given the message key in the logged-in user's locale.
`int`	`getNumberOfActiveUsers(String token)` Returns the number of active users, i.e.
`int`	`getNumberOfIndexTasksInQueue(String token)` Returns the size of the index queue.
`String`	`getOldestSpaceImportAllowed(String token)` Returns the backwards-compatibility of a space import
`String`	`getPersonalInformationId(String token, String username)` Gets the personal information id for a given username
`String`	`getPluginExportCompatibility(String token, String pluginKey)` Returns the plugin compatibility matrix for exports
`int`	`getQueueSize(String token, String queueName)` Returns the size of the task queue with the specified name.
`Vector<String>`	`getRecordedErrorLogMessages(String token)`
`String`	`getStackDump(String token, String threadNameRegex)`
`Hashtable<String,String>`	`getSystemProperty(String token, String name)` Retrieve the value of a system property.
`Vector`	`getUsersForActivity(String key)` Call getUsersForActivity on the heartbeatManager bean
`int`	`getVersionForPage(String token, String pageId)` Get the version number for the page with pageId
`boolean`	`increaseHighValue(String token)` Put a number bigger than 65535 in Hibernate_unique_key table to force generated ids to be greater than max integer.
`boolean`	`isCurrentApplicationSet(String token)` Check whether or not the trustedApplicationManager has its currentApplication set.
`boolean`	`isImportTaskRunning(String token)`
`boolean`	`isPluginModuleEnabled(String token, String pluginKey, String moduleKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`isPluginUpgradeTasksComplete(String token)` Returns true if the plugin dependent upgrade tasks
`boolean`	`isSpringComponentPresent(String token, String name)` Returns true if a Spring component with the given name exists in the application context.
`boolean`	`isUnlimitedUserLicense(String token)`
`boolean`	`logMessage(String token, String destination, String message)` Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.
`boolean`	`logTestMessageForClass(String token, String className, String message, String level)`
`boolean`	`massCreateAttachments(String token, String pageId, String prefix, String numAttachments)` Create a whole series of attachments on a single page.
`boolean`	`moveBlogPost(String token, String blogPostId, String targetSpaceKey)`
`boolean`	`pauseAllJobs(String token)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`pauseJob(String token, String jobSpec)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`pauseJobGroup(String token, String jobGroupName)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`putStringMappingInCache(String token, String cacheName, String key, String value)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`boolean`	`registerEventListener(String token, String eventClassName)` Registers a temporary event listener on the server to listen for the specified event.
`boolean`	`registerTestAppenderForClass(String token, String className)`
`boolean`	`removeAllJohnsonEvents(String token)` Removes all Johnson events from Confluence
`boolean`	`removeAllSpaces(String token)` Kill all the spaces and flush all the queues and caches.
`boolean`	`removeAllTrustedApplications(String token)` Removes all trusted applications from the database.
`boolean`	`removeAttachmentUncleanly(String token, String contentId, String attachmentFileName)` Removes an attachment without cleaning up associated attachment info
`boolean`	`removeBandanaKey(String token, String space, String key)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`removeDrafts(String token, String username)` Removes all drafts owned by the specified User.
`boolean`	`removeGroupUncleanly(String token, String groupname)` Remove a Group without removing the things that refer to that group.
`boolean`	`removeMailServer(String token, String serverName)` Remove the named mail server.
`boolean`	`removePersonalInformation(String token, String username)` PersonalInformation gets created automatically by the standard create user methods.
`boolean`	`removeTestData(String token, Vector<String> usersToKeep, Vector<String> groupsToKeep, Hashtable<String,Vector<String>> userGroupMemberships)` Big Kahuna remove method.
`boolean`	`removeTestDataAfterExternalUserManagement(String token)` Called at the start of tests for which User management is handled by an external server such as LDAP or Crowd.
`int`	`removeTestUsers(String token, int count)` Removes test users with usernames "testuser0", "testuser1", etc.
`boolean`	`removeUserDirectory(String token, String directoryId)` Removes user directory
`boolean`	`removeUserMacro(String token, String name)` Remove a User Macro with the given name if it exists.
`boolean`	`removeUserUncleanly(String token, String username)` Remove a User without removing the things that refer to that user.
`boolean`	`resetDatabaseStatistics(String token)` Reset database statistics.
`boolean`	`resetWelcomeMessage(String token)`
`boolean`	`restoreAbstractPage(String token, String abstractPageId)` Restores an abstract page from the trash.
`boolean`	`resumeAllJobs(String token)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`resumeJob(String token, String jobSpec)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`runGarbageCollection(String token)`
`boolean`	`saveDateFormat(String token, String dateFormat)`
`boolean`	`saveDateTimeFormat(String token, String dateTimeFormat)`
`boolean`	`setApplicationConfigProperty(String token, String propertyKey, String propertyValue)` Sets a property on the global `ApplicationConfiguration` instance.
`boolean`	`setBandanaKey(String token, String space, String key, String value)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`setBandanaKeyBoolean(String token, String space, String key, boolean value)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`setBandanaKeyInteger(String token, String space, String key, int value)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`setBandanaStringList(String token, String space, String key, Vector<String> value)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`setBandanaStringSet(String token, String space, String key, Vector<String> value)` Deprecated. since 5.6. Use FuncTestAdminBandanaResource.
`boolean`	`setBooleanUserPreference(String token, String userName, String preferenceKey, String value)` Sets a boolean user preference.
`boolean`	`setCacheMaximumNumberOfElements(String token, String cacheName, int maxNumElements)` Deprecated. since 5.6. Use FuncTestAdminCacheResource.
`boolean`	`setContentPropertiesString(String token, String entityId, String key, String value)` Sets the string value of a `ContentProperty` associated with a content entity given its id and the property name
`boolean`	`setContentPropertiesStringForSpace(String token, String spaceKey, String key, String value)` Sets the string value of a `ContentProperty` associated with the `SpaceDescription` of the space
`boolean`	`setContentStringProperty(String token, String entityId, String key, String value)` Set the content property string value (in OS_PROPERTYENTRY) for a content entity given its id, property key and value
`boolean`	`setContentTextProperty(String token, String entityId, String key, String value)` Sets a text content property for a content entity given its id
`boolean`	`setDirectoryPasswordEncoder(String token, String directoryName, String encoder)` Changes the password encoder for the given directory
`boolean`	`setDraftSaveInterval(String token, int seconds)` Sets the given draft save interval.
`boolean`	`setEnableAnonymousRpc(String token, String value)` Toggle the setting to allow/deny anonymous RPC calls.
`boolean`	`setGlobalLanguage(String token, String language)` Changes to the default site language
`boolean`	`setGlobalTheme(String token, String themeKey)` Deprecated. since 5.6. Use FuncTestAdminThemeResource.
`boolean`	`setIgnoreBaseURLWarning(String token, boolean value)` Affects whether the warning message for an un-advisable value for the Base URL is ignored or not.
`boolean`	`setIndexingLanguage(String token, String language)` Changes the indexing language
`boolean`	`setKeyboardShortcutPref(String token, String username, String enabled)` Enables/Disables keyboard shortcuts for the given uesr
`boolean`	`setLocaleForUser(String token, String username, String locale)` Sets the locale preference for the user to the given named locale.
`boolean`	`setNetworkNotificationForUser(String token, String userName, boolean watchNetwork)` Sets Network watch emails for a user to enabled or disabled.
`boolean`	`setSiteBlogNotificationForUser(String token, String userName, boolean globalBlogWatchForUser)` Sets Site Blog watch emails for a user to enabled or disabled.
`boolean`	`setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)` Remove all existing SMTP servers and add the given server.
`boolean`	`setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)` Remove all existing SMTP servers and add the given server.
`boolean`	`setStringUserPreference(String token, String userName, String preferenceKey, String value)` Sets a string user preference.
`Boolean`	`setSystemProperty(String token, String name, String value)` Set a system property on the server to the supplied value.
`boolean`	`setThemeForSpace(String token, String spaceKey, String themeKey)` Deprecated. since 5.6. Use FuncTestAdminThemeResource.
`boolean`	`setUserDetailProperty(String token, String username, String propertyKey, String propertyValue)` Sets a single UserDetails property through the UserDetailsManager.
`boolean`	`setUserDetails(String token, String username, String fullName, String email)` Sets the fullname and email address of a user with a given username.
`boolean`	`setUserFollows(String token, String followingUsername, Hashtable followUsers)` Change the follow or unfollow state between a follower user and s a set of folowees users
`boolean`	`setWatchOwnContentPref(String token, String username, String enabled)` Enables/Disables autowatching for the given uesr
`boolean`	`setWatchSpace(String token, String username, String spaceKey, String contentType, String enabled)` Enables/Disables watching a space for the given user and content type.
`boolean`	`setWatchSpaces(String token, String username, String contentTypeStr, Hashtable spaces)` Enables/Disables watching spaces for the given user and content type.
`boolean`	`setWebSudoTimeout(String token, int timeoutMinutes)` Sets the web sudo timeout in minutes
`boolean`	`setWelcomeMessage(String token, String welcomeMessage)`
`boolean`	`shutdownScheduler(String token)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`startActivity(String token, String key, String user)` Call startActivity on the heartbeat manager bean
`boolean`	`startLoggingRequests(String token)` Start logging http request urls.
`boolean`	`stopActivity(String token, String key, String user)` Call stopActivity on the heartbeatManager bean
`Hashtable`	`storeXhtmlPage(String token, Hashtable pageStruct)` The Confluence remote API store page performs wiki to XHTML conversion on the page content.
`boolean`	`synchroniseUserDirectories(String token)` Synchronizes all remote user directories with the local database cache
`boolean`	`triggerJob(String token, String jobSpec, boolean pauseBackgroundJobs)` Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.
`boolean`	`uninstallPlugin(String token, String pluginKey)` Deprecated. since 5.6. Use PluginsRpc in test client code.
`boolean`	`unregisterEventListener(String token, String eventClassName)` Unregisters the temporary listener registered for the specified event.
`boolean`	`unregisterTestAppenderForClass(String token, String className)`
`Hashtable`	`updateDraft(String token, Hashtable draft)` Updates a draft located using the draft owner and draft type.
`boolean`	`updateGlobalSettingBoolean(String token, String name, boolean value)` Update a `Settings` boolean field.
`String`	`updateGlobalSettingString(String token, String name, String value)` Update a `Settings` String field.
`boolean`	`waitForEvent(String token, String eventClassName, String timeout, String timeUnit)` Waits for an event to occur and returns when it has finished.
`boolean`	`waitForEventQueue(String token, String timeoutStr, String timeUnitStr)` Waits for all events in queue to be processed.

Method Detail

logMessage
```
@Deprecated
boolean logMessage(String token,
                               String destination,
                               String message)
                        throws RemoteException
```
Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.
Log a message to the server's console.
Only administrators can log messages.
The destination of the message has the following valid values:
- info - message will be logged at INFO level
- debug - message will be logged at DEBUG level
- warn - message will be logged at WARN level
- error - message will be logged at ERROR level
- sout - message will be written via System.out.println
- serr - message will be written via System.err.println
Parameters:

token - The token idenfitying the user.

destination - The destination of the message to be logged

message - The text message to be logged to the console

Returns:

boolean True if the message is logged (ie destination is a valid level)

Throws:

RemoteException

changeLoggerLevel
```
@Deprecated
String changeLoggerLevel(String token,
                                     String loggerName,
                                     String level)
                              throws RemoteException
```
Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.
Change the level of the specified logger.

The level parameter can be one of -
- DEBUG
- INFO
- WARN
- ERROR
- FATAL
Parameters:

token - the token identifying the user.

loggerName - the full name of the logger e.g. com.atlassian.confluence.test.rpc.FuncTestRpcHandler

level - the level to change the logger to

Returns:

the original level of the logger before changing.

Throws:

RemoteException

removeTestData
```
boolean removeTestData(String token,
                       Vector<String> usersToKeep,
                       Vector<String> groupsToKeep,
                       Hashtable<String,Vector<String>> userGroupMemberships)
                throws RemoteException
```
Big Kahuna remove method. Removes EVERYTHING that is meant to be removed on test setup, keeping only the users, groups and memberships specified. This includes removing global templates.

Parameters:

token - the token identifying the user.

usersToKeep - users like admin and sysadmin that should not be removed

groupsToKeep - groups like admins and users that should not be removed

userGroupMemberships - a map where the keys are group names and the values are lists of usernames in the group

Throws:

NotPermittedException

RemoteException

removeTestDataAfterExternalUserManagement
```
boolean removeTestDataAfterExternalUserManagement(String token)
                                           throws Exception
```
Called at the start of tests for which User management is handled by an external server such as LDAP or Crowd.
All remove/create User calls can be made to that server in one batch, and then the Confluence instance data can be cleaned up. Generally this will take part in three stages:
1. Clean up requiring the 'old' users, groups and memberships to exist (e.g. personal spaces, permissions) 2. Sync with the external server, which will reset the user, groups and memberships 3. Perform any other clean-up required, from removing spaces to flushing caches.
see ServerStateManager.removeTestData()

Throws:

Exception

removeAllSpaces
```
boolean removeAllSpaces(String token)
                 throws RemoteException
```
Kill all the spaces and flush all the queues and caches.

Throws:

RemoteException

createTemplate

String createTemplate(String token,
                      String templateName,
                      String content,
                      String spaceKey)
               throws RemoteException,
                      XhtmlException

Create a new template. If spaceKey is not defined, a global template will be created.

Returns:: template id
Throws:: RemoteException; XhtmlException

createTemplateWithStorageFormat

String createTemplateWithStorageFormat(String token,
                                       String templateName,
                                       String storageFormat,
                                       String spaceKey)
                                throws RemoteException,
                                       XhtmlException

Create a new template from storage format code. If spaceKey is not defined, a global template will be created.

Returns:: template id
Throws:: RemoteException; XhtmlException

getGlobalPermissionsForGroup

String[] getGlobalPermissionsForGroup(String token,
                                      String groupName)
                               throws RemoteException

Gets the global permissions that the given group has.

Throws:: RemoteException

disconnectUser
```
boolean disconnectUser(String token,
                       String username)
                throws RemoteException
```
Disconnect a user from Confluence. Removes all their permissions, group memberships, their profile information and their personal space.

Throws:

RemoteException

disconnectGroup

boolean disconnectGroup(String token,
                        String groupName)
                 throws RemoteException

Disconnect a group from Confluence. Removes all its permissions.

Throws:: RemoteException

isCurrentApplicationSet
```
boolean isCurrentApplicationSet(String token)
                         throws NotPermittedException
```
Check whether or not the trustedApplicationManager has its currentApplication set.

Throws:

NotPermittedException

removeAllTrustedApplications

boolean removeAllTrustedApplications(String token)
                              throws Exception

Removes all trusted applications from the database.

Throws:: Exception

massCreateAttachments

boolean massCreateAttachments(String token,
                              String pageId,
                              String prefix,
                              String numAttachments)
                       throws Exception

Create a whole series of attachments on a single page.

Throws:: Exception

getGlobalConfiguredTheme
```
@Deprecated
String getGlobalConfiguredTheme(String token)
                                     throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Get the key of the configured global theme, whether or not that theme exists.

Throws:

Exception

getConfiguredThemeForSpace

@Deprecated
String getConfiguredThemeForSpace(String token,
                                              String spaceKey)
                                       throws Exception

Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Get the key of the configured theme for a space, whether or not that theme exists.

Throws:: Exception

setGlobalTheme

@Deprecated
boolean setGlobalTheme(String token,
                                   String themeKey)
                            throws Exception

Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Sets the global theme

Parameters:: themeKey - - the complete theme key
Throws:: Exception

setThemeForSpace

@Deprecated
boolean setThemeForSpace(String token,
                                     String spaceKey,
                                     String themeKey)
                              throws Exception

Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Sets the theme for the specified space

Parameters:: spaceKey - - the key of the space to change; themeKey - - the complete theme key
Throws:: Exception

clearCustomHtml
```
boolean clearCustomHtml(String token)
                 throws Exception
```
Clears the global custom html.

Returns:

true always.

Throws:

Exception

uninstallPlugin
```
@Deprecated
boolean uninstallPlugin(String token,
                                    String pluginKey)
                             throws NotPermittedException
```
Deprecated. since 5.6. Use PluginsRpc in test client code.

Uninstall a plugin. (There's an install method in the standard rpc plugin)

Returns:

true because a return type is required by XMLRPC

Throws:

NotPermittedException

disablePlugin

@Deprecated
boolean disablePlugin(String token,
                                  String pluginKey)
                           throws NotPermittedException

Deprecated. since 5.6. Use PluginsRpc in test client code.

Disable a plugin.

Returns:: true because a return type is required by XMLRPC
Throws:: NotPermittedException

disablePluginWithoutPersisting

boolean disablePluginWithoutPersisting(String token,
                                       String pluginKey)
                                throws NotPermittedException

Disable a plugin without persisting.

Returns:: true because a return type is required by XMLRPC
Throws:: NotPermittedException

enablePlugin

@Deprecated
boolean enablePlugin(String token,
                                 String pluginKey)
                          throws NotPermittedException

Deprecated. since 5.6. Use PluginsRpc in test client code.

Enable a plugin.

Returns:: true because a return type is required by XMLRPC
Throws:: NotPermittedException

enablePluginModule

@Deprecated
boolean enablePluginModule(String token,
                                       String pluginKey,
                                       String moduleKey)
                                throws NotPermittedException

Deprecated. since 5.6. Use PluginsRpc in test client code.

Enable plugin module

Parameters:: pluginKey - the key of the plugin; moduleKey - the key of the module
Returns:: true because a return type is required by XMLRPC
Throws:: NotPermittedException

disablePluginModule

@Deprecated
boolean disablePluginModule(String tokdis,
                                        String pluginKey,
                                        String moduleKey)
                                 throws NotPermittedException

Deprecated. since 5.6. Use PluginsRpc in test client code.

Disable plugin module

Parameters:: pluginKey - the key of the plugin; moduleKey - the key of the module
Returns:: true because a return type is required by XMLRPC
Throws:: NotPermittedException

isPluginModuleEnabled
```
@Deprecated
boolean isPluginModuleEnabled(String token,
                                          String pluginKey,
                                          String moduleKey)
                                   throws NotPermittedException
```
Deprecated. since 5.6. Use PluginsRpc in test client code.

Find out if a plugin module is enabled or not. If the plugin exists and is enabled and the module exists and is enabled, then this method should return true, otherwise it should return false.

Parameters:

pluginKey - the key of the plugin

moduleKey - the key of the module excluding the plugin key

Returns:

true if the plugin module exists and is enabled, false otherwise

Throws:

NotPermittedException

isSpringComponentPresent

boolean isSpringComponentPresent(String token,
                                 String name)

Returns true if a Spring component with the given name exists in the application context.

isPluginUpgradeTasksComplete
```
boolean isPluginUpgradeTasksComplete(String token)
```
Returns true if the plugin dependent upgrade tasks

pauseAllJobs
```
@Deprecated
boolean pauseAllJobs(String token)
                          throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Pauses the quartz scheduler.

Throws:

Exception

resumeAllJobs
```
@Deprecated
boolean resumeAllJobs(String token)
                           throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Resume the quartz scheduler. Returns true on success and exception on error.

Throws:

Exception

pauseJobGroup

@Deprecated
boolean pauseJobGroup(String token,
                                  String jobGroupName)
                           throws Exception

Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Pauses the named job group in the quartz scheduler.

Throws:: Exception

pauseJob
```
@Deprecated
boolean pauseJob(String token,
                             String jobSpec)
                      throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Pauses the named job in the quartz scheduler. Supports groupname:jobname for the jobSpec.

Throws:

Exception

resumeJob
```
@Deprecated
boolean resumeJob(String token,
                              String jobSpec)
                       throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Resumes the named job in the quartz scheduler. Supports groupname:jobname for the jobSpec.

Throws:

Exception

triggerJob
```
@Deprecated
boolean triggerJob(String token,
                               String jobSpec,
                               boolean pauseBackgroundJobs)
                        throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Triggers the named job in the quartz scheduler synchronously. Note that Quartz's triggerJob function is asynchronous, but we use a listener internally to provide synchronicity. Supports groupname:jobname for the jobSpec.

Throws:

Exception

waitForEvent
```
boolean waitForEvent(String token,
                     String eventClassName,
                     String timeout,
                     String timeUnit)
              throws Exception
```
Waits for an event to occur and returns when it has finished.

Parameters:

eventClassName - the fully qualified classname of the event to wait for.

timeout - number of milliseconds to wait for the event before giving up completely.

timeUnit - See TimeUnit.name

Returns:

true if the event occurs within the timeout.

Throws:

Exception

waitForEventQueue

boolean waitForEventQueue(String token,
                          String timeoutStr,
                          String timeUnitStr)
                   throws Exception

Waits for all events in queue to be processed.

Returns:: true if queue was exhausted, false on timeout or any error.
Throws:: Exception

shutdownScheduler
```
@Deprecated
boolean shutdownScheduler(String token)
                               throws Exception
```
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Shutdown the scheduler to ensure single threadedness for testing

Throws:

Exception