java.lang.Object
- com.atlassian.confluence.test.rpc.FuncTestRpcDelegator

All Implemented Interfaces:: FuncTestRpcHandler

public class FuncTestRpcDelegator
extends Object
implements FuncTestRpcHandler

Constructor Summary

Constructors
Constructor Description

FuncTestRpcDelegator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`	Change the level of the specified logger.
`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`	`clearHibernateConnectionProviderLastExceptionTime(String token)`
`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)`	Disable a plugin.
`boolean`	`disablePluginModule(String token, String pluginKey, String moduleKey)`	Disable plugin module
`boolean`	`disablePluginWithoutPersisting(String token, String pluginKey)`	Disable a plugin without persisting.
`boolean`	`disableSiteFeature(String token, String featureKey)`	Disables a given dark feature for the entire site.
`boolean`	`disableUserFeature(String token, String featureKey)`	Disables a given dark feature for the logged in user.
`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)`	Enable a plugin.
`boolean`	`enablePluginModule(String token, String pluginKey, String moduleKey)`	Enable plugin module
`boolean`	`enablePublicSignUp(String token, boolean enabled)`	Sets the public sign up enabled status
`boolean`	`enableSiteFeature(String token, String featureKey)`	Enables a given dark feature for the entire site.
`boolean`	`enableUserFeature(String token, String featureKey)`	Enables a given dark feature for the logged in user.
`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)`	Flushes all the caches.
`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)`	Gets a value from Bandana
`Integer`	`getCacheMaximumNumberOfElements(String token, String cacheName)`	Returns the configured maximum number of elements in the given cache
`Hashtable`	`getCacheStatistics(String token, String cacheName)`	Returns the cache statistics for a particular named cache.
`Vector<String>`	`getCacheStatisticsCapabilities(String token)`	Returns the capabiltiies exposed by the cache statics service.
`String`	`getConfiguredThemeForSpace(String token, String spaceKey)`	Get the key of the configured theme for a space, whether or not that theme exists.
`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`	`getDateTimeFormat(String token)`	Get current DateTime format
`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)`	Get the key of the configured global theme, whether or not that theme exists.
`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)`	Find out if a plugin module is enabled or not.
`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)`	Log a message to the server's console.
`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`	`putStringMappingInCache(String token, String cacheName, String key, String value)`	Map a key to a value for a given cache.
`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)`	Remove a key from Bandana
`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`	`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)`	Sets a key in Bandana
`boolean`	`setBandanaKeyBoolean(String token, String space, String key, boolean value)`	Sets a key in Bandana
`boolean`	`setBandanaKeyInteger(String token, String space, String key, int value)`	Sets a key in Bandana
`boolean`	`setBandanaStringList(String token, String space, String key, Vector<String> value)`	Sets a key in Bandana with a List of Strings as value
`boolean`	`setBandanaStringSet(String token, String space, String key, Vector<String> value)`	Sets a key in Bandana with a Set of Strings as value
`boolean`	`setBooleanUserPreference(String token, String userName, String preferenceKey, String value)`	Sets a boolean user preference.
`boolean`	`setCacheMaximumNumberOfElements(String token, String cacheName, int maxNumElements)`	(Re)configures the maximum number of elements in the given cache
`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.
`void`	`setFuncTestRpcImpl(FuncTestRpcHandler funcTestRpcImpl)`
`boolean`	`setGlobalLanguage(String token, String language)`	Changes to the default site language
`boolean`	`setGlobalTheme(String token, String themeKey)`	Sets the global theme
`boolean`	`setHibernateConnectionProviderLastExceptionTime(String token, String timeStr)`
`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)`	Sets the theme for the specified space
`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)`	Shutdown the scheduler to ensure single threadedness for testing
`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`	`uninstallPlugin(String token, String pluginKey)`	Uninstall a plugin.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FuncTestRpcDelegator
```
public FuncTestRpcDelegator()
```
- Method Detail
  - logMessage
```
public boolean logMessage(String token,
                          String destination,
                          String message)
                   throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    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
    Specified by:
    
    logMessage in interface FuncTestRpcHandler
    
    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
```
public String changeLoggerLevel(String token,
                                String loggerName,
                                String level)
                         throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    Change the level of the specified logger.
    The level parameter can be one of:
    
    DEBUG
    INFO
    WARN
    ERROR
    FATAL
    Specified by:
    
    changeLoggerLevel in interface FuncTestRpcHandler
    
    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
```
public boolean removeTestData(String token,
                              Vector<String> usersToKeep,
                              Vector<String> groupsToKeep,
                              Hashtable<String,Vector<String>> userGroupMemberships)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    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.
    
    Specified by:
    
    removeTestData in interface FuncTestRpcHandler
    
    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
```
public boolean removeTestDataAfterExternalUserManagement(String token)
                                                  throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    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()
    
    Specified by:
    
    removeTestDataAfterExternalUserManagement in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - removeAllSpaces
```
public boolean removeAllSpaces(String token)
                        throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Kill all the spaces and flush all the queues and caches.
    
    Specified by:
    
    removeAllSpaces in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - createTemplate
```
public String createTemplate(String token,
                             String templateName,
                             String content,
                             String spaceKey)
                      throws RemoteException,
                             XhtmlException
```
    Description copied from interface: FuncTestRpcHandler
    
    Create a new template. If spaceKey is not defined, a global template will be created.
    
    Specified by:
    
    createTemplate in interface FuncTestRpcHandler
    
    Returns:
    
    template id
    
    Throws:
    
    RemoteException
    
    XhtmlException
  - createTemplateWithStorageFormat
```
public String createTemplateWithStorageFormat(String token,
                                              String templateName,
                                              String storageFormat,
                                              String spaceKey)
                                       throws RemoteException,
                                              XhtmlException
```
    Description copied from interface: FuncTestRpcHandler
    
    Create a new template from storage format code. If spaceKey is not defined, a global template will be created.
    
    Specified by:
    
    createTemplateWithStorageFormat in interface FuncTestRpcHandler
    
    Returns:
    
    template id
    
    Throws:
    
    RemoteException
    
    XhtmlException
  - disconnectUser
```
public boolean disconnectUser(String token,
                              String username)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disconnect a user from Confluence. Removes all their permissions, group memberships, their profile information and their personal space.
    
    Specified by:
    
    disconnectUser in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - disconnectGroup
```
public boolean disconnectGroup(String token,
                               String groupname)
                        throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disconnect a group from Confluence. Removes all its permissions.
    
    Specified by:
    
    disconnectGroup in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - isCurrentApplicationSet
```
public boolean isCurrentApplicationSet(String token)
                                throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Check whether or not the trustedApplicationManager has its currentApplication set.
    
    Specified by:
    
    isCurrentApplicationSet in interface FuncTestRpcHandler
    
    Throws:
    
    NotPermittedException
  - removeAllTrustedApplications
```
public boolean removeAllTrustedApplications(String token)
                                     throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes all trusted applications from the database.
    
    Specified by:
    
    removeAllTrustedApplications in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - massCreateAttachments
```
public boolean massCreateAttachments(String token,
                                     String pageId,
                                     String prefix,
                                     String numAttachments)
                              throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Create a whole series of attachments on a single page.
    
    Specified by:
    
    massCreateAttachments in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - getGlobalConfiguredTheme
```
public String getGlobalConfiguredTheme(String token)
                                throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the key of the configured global theme, whether or not that theme exists.
    
    Specified by:
    
    getGlobalConfiguredTheme in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - isPluginModuleEnabled
```
public boolean isPluginModuleEnabled(String token,
                                     String pluginKey,
                                     String moduleKey)
                              throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    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.
    
    Specified by:
    
    isPluginModuleEnabled in interface FuncTestRpcHandler
    
    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
  - getConfiguredThemeForSpace
```
public String getConfiguredThemeForSpace(String token,
                                         String spaceKey)
                                  throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the key of the configured theme for a space, whether or not that theme exists.
    
    Specified by:
    
    getConfiguredThemeForSpace in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - setGlobalTheme
```
public boolean setGlobalTheme(String token,
                              String themeKey)
                       throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the global theme
    
    Specified by:
    
    setGlobalTheme in interface FuncTestRpcHandler
    
    themeKey - - the complete theme key
    
    Throws:
    
    Exception
  - setThemeForSpace
```
public boolean setThemeForSpace(String token,
                                String spaceKey,
                                String themeKey)
                         throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the theme for the specified space
    
    Specified by:
    
    setThemeForSpace in interface FuncTestRpcHandler
    
    spaceKey - - the key of the space to change
    
    themeKey - - the complete theme key
    
    Throws:
    
    Exception
  - clearCustomHtml
```
public boolean clearCustomHtml(String token)
                        throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Clears the global custom html.
    
    Specified by:
    
    clearCustomHtml in interface FuncTestRpcHandler
    
    Returns:
    
    true always.
    
    Throws:
    
    Exception
  - uninstallPlugin
```
public boolean uninstallPlugin(String token,
                               String pluginKey)
                        throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Uninstall a plugin. (There's an install method in the standard rpc plugin)
    
    Specified by:
    
    uninstallPlugin in interface FuncTestRpcHandler
    
    Returns:
    
    true because a return type is required by XMLRPC
    
    Throws:
    
    NotPermittedException
  - disablePlugin
```
public boolean disablePlugin(String token,
                             String pluginKey)
                      throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disable a plugin.
    
    Specified by:
    
    disablePlugin in interface FuncTestRpcHandler
    
    Returns:
    
    true because a return type is required by XMLRPC
    
    Throws:
    
    NotPermittedException
  - disablePluginWithoutPersisting
```
public boolean disablePluginWithoutPersisting(String token,
                                              String pluginKey)
                                       throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disable a plugin without persisting.
    
    Specified by:
    
    disablePluginWithoutPersisting in interface FuncTestRpcHandler
    
    Returns:
    
    true because a return type is required by XMLRPC
    
    Throws:
    
    NotPermittedException
  - enablePlugin
```
public boolean enablePlugin(String token,
                            String pluginKey)
                     throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enable a plugin.
    
    Specified by:
    
    enablePlugin in interface FuncTestRpcHandler
    
    Returns:
    
    true because a return type is required by XMLRPC
    
    Throws:
    
    NotPermittedException
  - enablePluginModule
```
public boolean enablePluginModule(String token,
                                  String pluginKey,
                                  String moduleKey)
                           throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enable plugin module
    
    Specified by:
    
    enablePluginModule in interface FuncTestRpcHandler
    
    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
```
public boolean disablePluginModule(String token,
                                   String pluginKey,
                                   String moduleKey)
                            throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disable plugin module
    
    Specified by:
    
    disablePluginModule in interface FuncTestRpcHandler
    
    pluginKey - the key of the plugin
    
    moduleKey - the key of the module
    
    Returns:
    
    true because a return type is required by XMLRPC
    
    Throws:
    
    NotPermittedException
  - isSpringComponentPresent
```
public boolean isSpringComponentPresent(String token,
                                        String name)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns true if a Spring component with the given name exists in the application context.
    
    Specified by:
    
    isSpringComponentPresent in interface FuncTestRpcHandler
  - isPluginUpgradeTasksComplete
```
public boolean isPluginUpgradeTasksComplete(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns true if the plugin dependent upgrade tasks
    
    Specified by:
    
    isPluginUpgradeTasksComplete in interface FuncTestRpcHandler
  - waitForEvent
```
public boolean waitForEvent(String token,
                            String eventClassName,
                            String timeout,
                            String timeUnit)
                     throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Waits for an event to occur and returns when it has finished.
    
    Specified by:
    
    waitForEvent in interface FuncTestRpcHandler
    
    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
```
public boolean waitForEventQueue(String token,
                                 String timeoutStr,
                                 String timeUnitStr)
                          throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Waits for all events in queue to be processed.
    
    Specified by:
    
    waitForEventQueue in interface FuncTestRpcHandler
    
    Returns:
    
    true if queue was exhausted, false on timeout or any error.
    
    Throws:
    
    Exception
  - shutdownScheduler
```
public boolean shutdownScheduler(String token)
                          throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Shutdown the scheduler to ensure single threadedness for testing
    
    Specified by:
    
    shutdownScheduler in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - removeBandanaKey
```
public boolean removeBandanaKey(String token,
                                String space,
                                String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove a key from Bandana
    
    Specified by:
    
    removeBandanaKey in interface FuncTestRpcHandler
  - setBandanaStringSet
```
public boolean setBandanaStringSet(String token,
                                   String space,
                                   String key,
                                   Vector<String> value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a key in Bandana with a Set of Strings as value
    
    Specified by:
    
    setBandanaStringSet in interface FuncTestRpcHandler
  - setBandanaStringList
```
public boolean setBandanaStringList(String token,
                                    String space,
                                    String key,
                                    Vector<String> value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a key in Bandana with a List of Strings as value
    
    Specified by:
    
    setBandanaStringList in interface FuncTestRpcHandler
  - setBandanaKey
```
public boolean setBandanaKey(String token,
                             String space,
                             String key,
                             String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a key in Bandana
    
    Specified by:
    
    setBandanaKey in interface FuncTestRpcHandler
  - setBandanaKeyBoolean
```
public boolean setBandanaKeyBoolean(String token,
                                    String space,
                                    String key,
                                    boolean value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a key in Bandana
    
    Specified by:
    
    setBandanaKeyBoolean in interface FuncTestRpcHandler
  - setBandanaKeyInteger
```
public boolean setBandanaKeyInteger(String token,
                                    String space,
                                    String key,
                                    int value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a key in Bandana
    
    Specified by:
    
    setBandanaKeyInteger in interface FuncTestRpcHandler
  - getBandanaValue
```
public Object getBandanaValue(String token,
                              String space,
                              String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Gets a value from Bandana
    
    Specified by:
    
    getBandanaValue in interface FuncTestRpcHandler
  - getContentPropertyKeys
```
public Vector getContentPropertyKeys(String token,
                                     String entityId)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the content property keys for a content entity given its id
    
    Specified by:
    
    getContentPropertyKeys in interface FuncTestRpcHandler
  - getContentProperty
```
public String getContentProperty(String token,
                                 String entityId,
                                 String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the content property value for a content entity given its id and the property key
    
    Specified by:
    
    getContentProperty in interface FuncTestRpcHandler
  - getContentTextProperty
```
public String getContentTextProperty(String token,
                                     String entityId,
                                     String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the content property text value (in OS_PROPERTYENTRY) for a content entity given its id and property key
    
    Specified by:
    
    getContentTextProperty in interface FuncTestRpcHandler
    
    entityId - the ID of the content object this property is stored against
    
    key - the entity key of the property being stored
    
    Returns:
    
    The string value of the property (or an empty string if no property was found)
  - getContentStringProperty
```
public String getContentStringProperty(String token,
                                       String entityId,
                                       String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the content property string value (in OS_PROPERTYENTRY) for a content entity given its id and property key
    
    Specified by:
    
    getContentStringProperty in interface FuncTestRpcHandler
    
    entityId - the ID of the content object this property is stored against
    
    key - the entity key of the property being stored
    
    Returns:
    
    The string value of the property (or an empty string if no property was found)
  - getContentPropertiesString
```
public String getContentPropertiesString(String token,
                                         String entityId,
                                         String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the string value of a ContentProperty associated with a content entity given its id and the property name
    
    Specified by:
    
    getContentPropertiesString in interface FuncTestRpcHandler
  - getContentPropertiesStringForSpace
```
public String getContentPropertiesStringForSpace(String token,
                                                 String spaceKey,
                                                 String key)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the string value of a ContentProperty associated with the SpaceDescription of the space
    
    Specified by:
    
    getContentPropertiesStringForSpace in interface FuncTestRpcHandler
  - setContentTextProperty
```
public boolean setContentTextProperty(String token,
                                      String entityId,
                                      String key,
                                      String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a text content property for a content entity given its id
    
    Specified by:
    
    setContentTextProperty in interface FuncTestRpcHandler
  - setContentStringProperty
```
public boolean setContentStringProperty(String token,
                                        String entityId,
                                        String key,
                                        String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Set the content property string value (in OS_PROPERTYENTRY) for a content entity given its id, property key and value
    
    Specified by:
    
    setContentStringProperty in interface FuncTestRpcHandler
    
    entityId - the ID of the content object this property is stored against
    
    key - the entity key of the property being stored
    
    value - the string value of the property to set
  - setContentPropertiesString
```
public boolean setContentPropertiesString(String token,
                                          String entityId,
                                          String key,
                                          String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the string value of a ContentProperty associated with a content entity given its id and the property name
    
    Specified by:
    
    setContentPropertiesString in interface FuncTestRpcHandler
  - setContentPropertiesStringForSpace
```
public boolean setContentPropertiesStringForSpace(String token,
                                                  String spaceKey,
                                                  String key,
                                                  String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the string value of a ContentProperty associated with the SpaceDescription of the space
    
    Specified by:
    
    setContentPropertiesStringForSpace in interface FuncTestRpcHandler
  - getPersonalInformationId
```
public String getPersonalInformationId(String token,
                                       String username)
```
    Description copied from interface: FuncTestRpcHandler
    
    Gets the personal information id for a given username
    
    Specified by:
    
    getPersonalInformationId in interface FuncTestRpcHandler
  - removePersonalInformation
```
public boolean removePersonalInformation(String token,
                                         String username)
                                  throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    PersonalInformation gets created automatically by the standard create user methods. This method exists to allow testing that the PersonalInformation will get created appropriately when it doesn't exist (eg for LDAP users logging in).
    
    Specified by:
    
    removePersonalInformation in interface FuncTestRpcHandler
    
    username - user whose personalInformation will be removed
    
    Returns:
    
    true because it has to return something
    
    Throws:
    
    NotPermittedException
  - getLocaleForUser
```
public String getLocaleForUser(String token,
                               String username)
```
    Description copied from interface: FuncTestRpcHandler
    
    Gets the locale preference for the user.
    
    Specified by:
    
    getLocaleForUser in interface FuncTestRpcHandler
  - setLocaleForUser
```
public boolean setLocaleForUser(String token,
                                String username,
                                String locale)
                         throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the locale preference for the user to the given named locale.
    
    Specified by:
    
    setLocaleForUser in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setUserDetails
```
public boolean setUserDetails(String token,
                              String username,
                              String fullName,
                              String email)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the fullname and email address of a user with a given username.
    
    Specified by:
    
    setUserDetails in interface FuncTestRpcHandler
    
    Returns:
    
    true because XMLRPC methods have to return something
    
    Throws:
    
    RemoteException - if the user was not found.
  - setUserDetailProperty
```
public boolean setUserDetailProperty(String token,
                                     String username,
                                     String propertyKey,
                                     String propertyValue)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a single UserDetails property through the UserDetailsManager.
    
    Specified by:
    
    setUserDetailProperty in interface FuncTestRpcHandler
    
    Returns:
    
    true because XMLRPC methods have to return something
  - putStringMappingInCache
```
public boolean putStringMappingInCache(String token,
                                       String cacheName,
                                       String key,
                                       String value)
                                throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Map a key to a value for a given cache. Only accepts strings. This allows us to manipulate the number of entries in the cache. This method will create the named cache if it doesn't exist.
    
    Specified by:
    
    putStringMappingInCache in interface FuncTestRpcHandler
    
    Returns:
    
    true because void is not allowed.
    
    Throws:
    
    Exception
  - getCacheStatistics
```
public Hashtable getCacheStatistics(String token,
                                    String cacheName)
                             throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the cache statistics for a particular named cache.
    
    Specified by:
    
    getCacheStatistics in interface FuncTestRpcHandler
    
    cacheName - the key of the cache, rather than the "niceName"
    
    Returns:
    
    A hashtable representing the cache statistics
    
    Throws:
    
    Exception
  - getCacheMaximumNumberOfElements
```
public Integer getCacheMaximumNumberOfElements(String token,
                                               String cacheName)
                                        throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the configured maximum number of elements in the given cache
    
    Specified by:
    
    getCacheMaximumNumberOfElements in interface FuncTestRpcHandler
    
    cacheName - the key of the cache, rather than the "niceName"
    
    Throws:
    
    Exception
  - setCacheMaximumNumberOfElements
```
public boolean setCacheMaximumNumberOfElements(String token,
                                               String cacheName,
                                               int maxNumElements)
                                        throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    (Re)configures the maximum number of elements in the given cache
    
    Specified by:
    
    setCacheMaximumNumberOfElements in interface FuncTestRpcHandler
    
    cacheName - the key of the cache, rather than the "niceName"
    
    Throws:
    
    Exception
  - getCacheStatisticsCapabilities
```
public Vector<String> getCacheStatisticsCapabilities(String token)
                                              throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the capabiltiies exposed by the cache statics service.
    
    Specified by:
    
    getCacheStatisticsCapabilities in interface FuncTestRpcHandler
    
    Throws:
    
    NotPermittedException
  - flushAllCaches
```
public boolean flushAllCaches(String token)
                       throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Flushes all the caches.
    
    Specified by:
    
    flushAllCaches in interface FuncTestRpcHandler
    
    Returns:
    
    true because void isn't allowed.
    
    Throws:
    
    Exception
  - enableWebSudo
```
public boolean enableWebSudo(String token,
                             boolean enabled)
                      throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the web sudo enabled status
    
    Specified by:
    
    enableWebSudo in interface FuncTestRpcHandler
    
    Returns:
    
    true because void isn't allowed.
    
    Throws:
    
    Exception
  - setWebSudoTimeout
```
public boolean setWebSudoTimeout(String token,
                                 int timeoutMinutes)
                          throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the web sudo timeout in minutes
    
    Specified by:
    
    setWebSudoTimeout in interface FuncTestRpcHandler
    
    Returns:
    
    true because void isn't allowed.
    
    Throws:
    
    Exception
  - enableElevatedSecurityCheck
```
public boolean enableElevatedSecurityCheck(String token,
                                           boolean enabled)
                                    throws Exception
```
    Specified by:
    
    enableElevatedSecurityCheck in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - enablePublicSignUp
```
public boolean enablePublicSignUp(String token,
                                  boolean enabled)
                           throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the public sign up enabled status
    
    Specified by:
    
    enablePublicSignUp in interface FuncTestRpcHandler
    
    Returns:
    
    true because void isn't allowed.
    
    Throws:
    
    Exception
  - startActivity
```
public boolean startActivity(String token,
                             String key,
                             String user)
                      throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Call startActivity on the heartbeat manager bean
    
    Specified by:
    
    startActivity in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    key - the activity key to start
    
    user - the username of the user starting the activity
    
    Returns:
    
    true if executes start activity without error.
    
    Throws:
    
    Exception
  - stopActivity
```
public boolean stopActivity(String token,
                            String key,
                            String user)
                     throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Call stopActivity on the heartbeatManager bean
    
    Specified by:
    
    stopActivity in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    key - the activity key to stop
    
    user - the username of the user stopping the activity
    
    Throws:
    
    Exception
  - setKeyboardShortcutPref
```
public boolean setKeyboardShortcutPref(String token,
                                       String username,
                                       String enabled)
                                throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables/Disables keyboard shortcuts for the given uesr
    
    Specified by:
    
    setKeyboardShortcutPref in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setWatchOwnContentPref
```
public boolean setWatchOwnContentPref(String token,
                                      String username,
                                      String enabled)
                               throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables/Disables autowatching for the given uesr
    
    Specified by:
    
    setWatchOwnContentPref in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setWatchSpaces
```
public boolean setWatchSpaces(String token,
                              String username,
                              String contentTypeStr,
                              Hashtable spaces)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables/Disables watching spaces for the given user and content type.
    
    Specified by:
    
    setWatchSpaces in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setWatchSpace
```
public boolean setWatchSpace(String token,
                             String username,
                             String spaceKey,
                             String contentType,
                             String enabled)
                      throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables/Disables watching a space for the given user and content type.
    
    Specified by:
    
    setWatchSpace in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - getUsersForActivity
```
public Vector getUsersForActivity(String key)
                           throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Call getUsersForActivity on the heartbeatManager bean
    
    Specified by:
    
    getUsersForActivity in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - registerEventListener
```
public boolean registerEventListener(String token,
                                     String eventClassName)
                              throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Registers a temporary event listener on the server to listen for the specified event. It is recommended that clients also unregister the event listener using FuncTestRpcHandler.unregisterEventListener(String, String) in a finally clause to ensure the temporary listener is cleaned up.
    Once the listener is registered, clients can use FuncTestRpcHandler.waitForEvent(String, String, String, String) to block until the event is published.
    
    Specified by:
    
    registerEventListener in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - unregisterEventListener
```
public boolean unregisterEventListener(String token,
                                       String eventClassName)
                                throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Unregisters the temporary listener registered for the specified event.
    
    Specified by:
    
    unregisterEventListener in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - clearEventListeners
```
public boolean clearEventListeners(String token)
                            throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes all temporary event listeners, regardless of their state.
    
    Specified by:
    
    clearEventListeners in interface FuncTestRpcHandler
    
    Returns:
    
    true because some result is required.
    
    Throws:
    
    Exception
  - removeMailServer
```
public boolean removeMailServer(String token,
                                String serverName)
                         throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove the named mail server.
    
    Specified by:
    
    removeMailServer in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the rpc authentication token
    
    serverName - the name of the server to be removed.
    
    Returns:
    
    true if the named server was removed (or there was no server by that name), otherwise false.
    
    Throws:
    
    Exception
  - getLeastRecentTestAppenderLogMessage
```
public String getLeastRecentTestAppenderLogMessage(String token,
                                                   String className)
```
    Specified by:
    
    getLeastRecentTestAppenderLogMessage in interface FuncTestRpcHandler
  - registerTestAppenderForClass
```
public boolean registerTestAppenderForClass(String token,
                                            String className)
```
    Specified by:
    
    registerTestAppenderForClass in interface FuncTestRpcHandler
  - unregisterTestAppenderForClass
```
public boolean unregisterTestAppenderForClass(String token,
                                              String className)
```
    Specified by:
    
    unregisterTestAppenderForClass in interface FuncTestRpcHandler
  - logTestMessageForClass
```
public boolean logTestMessageForClass(String token,
                                      String className,
                                      String message,
                                      String level)
```
    Specified by:
    
    logTestMessageForClass in interface FuncTestRpcHandler
  - getLocalisedText
```
public String getLocalisedText(String token,
                               String messageKey)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the localised string for given the message key in the logged-in user's locale.
    
    Specified by:
    
    getLocalisedText in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the rpc authentication token
    
    messageKey - the i18n message key
    
    Returns:
    
    the localised version of the message key in the logged-in user's locale, or the message key itself if it does not have a corresponding value.
  - removeUserUncleanly
```
public boolean removeUserUncleanly(String token,
                                   String username)
                            throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove a User without removing the things that refer to that user.
    
    Specified by:
    
    removeUserUncleanly in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - removeGroupUncleanly
```
public boolean removeGroupUncleanly(String token,
                                    String groupname)
                             throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove a Group without removing the things that refer to that group.
    
    Specified by:
    
    removeGroupUncleanly in interface FuncTestRpcHandler
    
    Throws:
    
    Exception
  - doesDraftExist
```
public boolean doesDraftExist(String token,
                              String contentId,
                              String owner,
                              String draftType,
                              String spaceKey)
```
    Description copied from interface: FuncTestRpcHandler
    
    Determines if a draft of the specified type and belonging to the specified owner exists.
    
    Specified by:
    
    doesDraftExist in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    contentId - id of the content this draft is for ('0' for new content)
    
    owner - owner/author of the draft
    
    draftType - type of content this draft is for
    
    spaceKey - space key, to allow new drafts in multiple spaces
    
    Returns:
    
    true if a draft of the specified type and belonging to the specified owner exists, else false
  - countDrafts
```
public int countDrafts(String token,
                       String owner)
```
    Specified by:
    
    countDrafts in interface FuncTestRpcHandler
  - createDraft
```
public Hashtable createDraft(String token,
                             Hashtable draft)
```
    Description copied from interface: FuncTestRpcHandler
    
    Creates a draft for the draft owner and draft type with the specified title and content. If the draft already exists the current draft is updated.
    
    Specified by:
    
    createDraft in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    draft - the draft object to create Required: "owner" - the username of owner/author of the draft. Set to null for anonymous users. "draftType" - type of content the draft is for i.e. BlogPost.getType() or Page.getType(). "title" - title of the draft. "content" - content of the draft as a String in Confluence XML storage format. Optional: "pageId" - page that the draft is associated with. "spaceKey" - if no there is no page, the space that the draft is written in.
    
    Returns:
    
    the draft created returned in the same format as above, with the additional field id.
  - updateDraft
```
public Hashtable updateDraft(String token,
                             Hashtable draft)
```
    Description copied from interface: FuncTestRpcHandler
    
    Updates a draft located using the draft owner and draft type. Draft is then updated with the specified title and content
    
    Specified by:
    
    updateDraft in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    draft - the draft object to create see #createDraft(java.lang.String, java.util.Hashtable)
    
    Returns:
    
    the draft updated returns null if the draft does not exist
  - removeDrafts
```
public boolean removeDrafts(String token,
                            String username)
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes all drafts owned by the specified User.
    
    Specified by:
    
    removeDrafts in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    username - user to remove drafts for
    
    Returns:
    
    true if this is successful, false if no user with this name.
  - setDraftSaveInterval
```
public boolean setDraftSaveInterval(String token,
                                    int seconds)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the given draft save interval.
    
    Specified by:
    
    setDraftSaveInterval in interface FuncTestRpcHandler
    
    Parameters:
    
    token - rpc authentication token
    
    seconds - number of seconds for which the draft save interval should be
    
    Returns:
    
    true if this is successful, false if not set
  - clearQueue
```
public boolean clearQueue(String token,
                          String queueName)
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes all items from the specified queue
    
    Specified by:
    
    clearQueue in interface FuncTestRpcHandler
    
    Returns:
    
    true if this is successful, false if no queue with this name exists
  - getQueueSize
```
public int getQueueSize(String token,
                        String queueName)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the size of the task queue with the specified name.
    
    Specified by:
    
    getQueueSize in interface FuncTestRpcHandler
    
    Returns:
    
    the size of the task queue with the specified name.
  - addUserAnyCase
```
public boolean addUserAnyCase(String token,
                              String username,
                              String email,
                              String fullname,
                              String password)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Allows addition of a user without enforcing that the username be all lower case. This is for use in tests where you need mixed case user - useful for emulating an external provider such as LDAP.
    
    Specified by:
    
    addUserAnyCase in interface FuncTestRpcHandler
    
    Throws:
    
    NotPermittedException - if you do not have permissions to add the user.
    
    RemoteException
  - addGroupAnyCase
```
public boolean addGroupAnyCase(String token,
                               String groupname)
                        throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Allows addition of a group without enforcing that the name be all lower case. This is for use in tests where you need mixed case user - useful for emulating an external provider such as LDAP.
    
    Specified by:
    
    addGroupAnyCase in interface FuncTestRpcHandler
    
    groupname - the name of the group to add
    
    Returns:
    
    true if successfully added, otherwise false
    
    Throws:
    
    RemoteException
  - changeSpaceCreatedDate
```
public boolean changeSpaceCreatedDate(String token,
                                      String spaceKey,
                                      Date createdDate)
                               throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the created date of a space
    
    Specified by:
    
    changeSpaceCreatedDate in interface FuncTestRpcHandler
    
    spaceKey - the space key of the space to change the created date
    
    Throws:
    
    RemoteException
  - changeCommentCreatedDate
```
public boolean changeCommentCreatedDate(String token,
                                        String commentId,
                                        Date createdDate)
                                 throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the created date of a comment
    
    Specified by:
    
    changeCommentCreatedDate in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - changePageCreatedDate
```
public boolean changePageCreatedDate(String token,
                                     String pageId,
                                     Date createdDate)
                              throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the created date of a page
    
    Specified by:
    
    changePageCreatedDate in interface FuncTestRpcHandler
    
    pageId - the page id of the page to change the created date
    
    Throws:
    
    RemoteException
  - removeAttachmentUncleanly
```
public boolean removeAttachmentUncleanly(String token,
                                         String contentId,
                                         String attachmentFileName)
                                  throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes an attachment without cleaning up associated attachment info
    
    Specified by:
    
    removeAttachmentUncleanly in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the authentication
    
    contentId - the content that the attachment is attached to
    
    attachmentFileName - the attachment
    
    Returns:
    
    true
    
    Throws:
    
    RemoteException
  - changeAttachmentCreatedDate
```
public boolean changeAttachmentCreatedDate(String token,
                                           String contentId,
                                           String attachmentFileName,
                                           Date createdDate)
                                    throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the created date of an attachment
    
    Specified by:
    
    changeAttachmentCreatedDate in interface FuncTestRpcHandler
    
    contentId - the id of the page or blogpost the attachment is attached to
    
    attachmentFileName - the attachment file name of the attachment to change the created date
    
    Throws:
    
    RemoteException
  - changeBlogPostModificationDate
```
public boolean changeBlogPostModificationDate(String token,
                                              String blogId,
                                              Date modificationDate)
                                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the modification date of a blog post
    
    Specified by:
    
    changeBlogPostModificationDate in interface FuncTestRpcHandler
    
    blogId - the id of the blog to modify
    
    modificationDate - the last modification date to be set.
    
    Returns:
    
    true if successful, otherwise false.
    
    Throws:
    
    RemoteException
  - changePageModificationDate
```
public boolean changePageModificationDate(String token,
                                          String pageId,
                                          Date modificationDate)
                                   throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the modification date of a page
    
    Specified by:
    
    changePageModificationDate in interface FuncTestRpcHandler
    
    pageId - the page id of the page to change the modification date
    
    modificationDate - the last modification date to be set.
    
    Throws:
    
    RemoteException
  - getVersionForPage
```
public int getVersionForPage(String token,
                             String pageId)
                      throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Get the version number for the page with pageId
    
    Specified by:
    
    getVersionForPage in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - saveDateFormat
```
public boolean saveDateFormat(String token,
                              String dateFormat)
```
    Specified by:
    
    saveDateFormat in interface FuncTestRpcHandler
  - saveDateTimeFormat
```
public boolean saveDateTimeFormat(String token,
                                  String dateTimeFormat)
```
    Specified by:
    
    saveDateTimeFormat in interface FuncTestRpcHandler
  - getDateTimeFormat
```
public String getDateTimeFormat(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Get current DateTime format
    
    Specified by:
    
    getDateTimeFormat in interface FuncTestRpcHandler
  - addSmtpServer
```
public boolean addSmtpServer(String token,
                             String name,
                             String from,
                             String subjectPrefix,
                             String hostname,
                             int port)
```
    Description copied from interface: FuncTestRpcHandler
    
    Add an SMTP mail server.
    
    Specified by:
    
    addSmtpServer in interface FuncTestRpcHandler
  - addSmtpServer
```
public boolean addSmtpServer(String token,
                             String name,
                             String from,
                             String subjectPrefix,
                             String hostname,
                             int port,
                             String fromName)
```
    Specified by:
    
    addSmtpServer in interface FuncTestRpcHandler
  - setSmtpServer
```
public boolean setSmtpServer(String token,
                             String name,
                             String from,
                             String subjectPrefix,
                             String hostname,
                             int port)
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove all existing SMTP servers and add the given server.
    
    Specified by:
    
    setSmtpServer in interface FuncTestRpcHandler
  - setSmtpServer
```
public boolean setSmtpServer(String token,
                             String name,
                             String from,
                             String subjectPrefix,
                             String hostname,
                             int port,
                             String fromName)
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove all existing SMTP servers and add the given server.
    
    Specified by:
    
    setSmtpServer in interface FuncTestRpcHandler
  - addMailServer
```
public boolean addMailServer(String token,
                             String serverName,
                             String protocol,
                             String hostname,
                             int port,
                             String username,
                             String password,
                             String toAddress)
```
    Description copied from interface: FuncTestRpcHandler
    
    Add a POP server to poll for emails in a particular account. The account's associated email address must also be passed.
    
    Specified by:
    
    addMailServer in interface FuncTestRpcHandler
  - convertMarkupToXhtml
```
public String convertMarkupToXhtml(String token,
                                   String wikiMarkup,
                                   String pageId)
```
    Description copied from interface: FuncTestRpcHandler
    
    Render a page as XHTML.
    
    Specified by:
    
    convertMarkupToXhtml in interface FuncTestRpcHandler
  - convertXhtmlToMarkup
```
public String convertXhtmlToMarkup(String token,
                                   String xhtml,
                                   String pageId)
```
    Description copied from interface: FuncTestRpcHandler
    
    Convert XHTML to WikiMarkup.
    
    Specified by:
    
    convertXhtmlToMarkup in interface FuncTestRpcHandler
  - setFuncTestRpcImpl
```
public void setFuncTestRpcImpl(FuncTestRpcHandler funcTestRpcImpl)
```
  - removeAllJohnsonEvents
```
public boolean removeAllJohnsonEvents(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes all Johnson events from Confluence
    
    Specified by:
    
    removeAllJohnsonEvents in interface FuncTestRpcHandler
  - enableCaptcha
```
public boolean enableCaptcha(String token,
                             boolean enable)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the captcha mode
    
    Specified by:
    
    enableCaptcha in interface FuncTestRpcHandler
  - enableCaptchaDebugMode
```
public boolean enableCaptchaDebugMode(String token,
                                      boolean enable)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the captcha mode into debug mode. See CaptchaManager.setDebugMode(boolean).
    
    Specified by:
    
    enableCaptchaDebugMode in interface FuncTestRpcHandler
  - createJohnsonEvent
```
public boolean createJohnsonEvent(String token,
                                  String message)
```
    Description copied from interface: FuncTestRpcHandler
    
    Creates a Johnson event inside Confluence. This method is used to test the ConfluenceJohnsonFilter.
    
    Specified by:
    
    createJohnsonEvent in interface FuncTestRpcHandler
    
    message - the description of the event to create
  - getSystemProperty
```
public Hashtable<String,String> getSystemProperty(String token,
                                                        String name)
```
    Description copied from interface: FuncTestRpcHandler
    
    Retrieve the value of a system property. The property is returned as a map of the property key to its value, as XML-RPC doesn't support nulls and it's reasonably important to be able to tell if the property is set.
    
    Specified by:
    
    getSystemProperty in interface FuncTestRpcHandler
    
    name - the name of the property
    
    Returns:
    
    a hash mapping the requested key to its value, if the property is set. Otherwise an empty map.
  - setSystemProperty
```
public Boolean setSystemProperty(String token,
                                 String name,
                                 String value)
```
    Description copied from interface: FuncTestRpcHandler
    
    Set a system property on the server to the supplied value.
    
    Specified by:
    
    setSystemProperty in interface FuncTestRpcHandler
    
    name - the name of the property
    
    value - the value of the property
    
    Returns:
    
    always true since XML RPC can't handle void
  - clearSystemProperty
```
public Boolean clearSystemProperty(String token,
                                   String name)
```
    Description copied from interface: FuncTestRpcHandler
    
    Unset a system property.
    
    Specified by:
    
    clearSystemProperty in interface FuncTestRpcHandler
    
    name - the name of the property
    
    Returns:
    
    always true since XML RPC can't handle void
  - clearIndex
```
public boolean clearIndex(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Blows away the main Confluence search index.
    
    Specified by:
    
    clearIndex in interface FuncTestRpcHandler
  - getGlobalPermissionsForGroup
```
public String[] getGlobalPermissionsForGroup(String token,
                                             String groupName)
                                      throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Gets the global permissions that the given group has.
    
    Specified by:
    
    getGlobalPermissionsForGroup in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - restoreAbstractPage
```
public boolean restoreAbstractPage(String token,
                                   String abstractPageId)
```
    Description copied from interface: FuncTestRpcHandler
    
    Restores an abstract page from the trash.
    
    Specified by:
    
    restoreAbstractPage in interface FuncTestRpcHandler
  - getIdOfPagePermission
```
public String getIdOfPagePermission(String token,
                                    String contentId,
                                    String permissionType,
                                    String username)
```
    Specified by:
    
    getIdOfPagePermission in interface FuncTestRpcHandler
    
    Returns:
    
    the id of the identified content permission or 0 if there is no match found.
  - createTestUsers
```
public int createTestUsers(String token,
                           int count)
```
    Description copied from interface: FuncTestRpcHandler
    
    Create test users with usernames "testuser0", "testuser1", etc. Each user's password is the same as their username.
    
    Specified by:
    
    createTestUsers in interface FuncTestRpcHandler
    
    Returns:
    
    the number of users created
  - removeTestUsers
```
public int removeTestUsers(String token,
                           int count)
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes test users with usernames "testuser0", "testuser1", etc. Logs a warning if a user cannot be removed.
    
    Specified by:
    
    removeTestUsers in interface FuncTestRpcHandler
    
    Returns:
    
    the number of users removed
  - createUserMacro
```
public 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)
                        throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Create a User Macro
    
    Specified by:
    
    createUserMacro in interface FuncTestRpcHandler
    
    bodyType - how the body should be treated. "raw", "escapehtml", or "rendered". May be null only if hasBody is false.
    
    outputType - whether the macro is expected to return html or wiki markup. "html" or "wiki".
    
    template - the velocity rendered by the macro
    
    title - the title of the macro that appears in the Macro Browser
    
    description - the description of the macro that appears in the Macro Browser
    
    category - the category the macro should be listed under in the Macro Browser
    
    iconUrl - the URL of the macro icon that appears in the Macro Browser
    
    documentationUrl - the URL of the macro documentation
    
    hidden - true if the Macro should not be searchable in the Macro Browser
    
    Returns:
    
    true all the time because XMLRPC methods need a non-void return type.
    
    Throws:
    
    NotPermittedException
  - removeUserMacro
```
public boolean removeUserMacro(String token,
                               String name)
                        throws NotPermittedException
```
    Description copied from interface: FuncTestRpcHandler
    
    Remove a User Macro with the given name if it exists.
    
    Specified by:
    
    removeUserMacro in interface FuncTestRpcHandler
    
    Returns:
    
    true all the time because XMLRPC methods need a non-void return type.
    
    Throws:
    
    NotPermittedException
  - setApplicationConfigProperty
```
public boolean setApplicationConfigProperty(String token,
                                            String propertyKey,
                                            String propertyValue)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a property on the global ApplicationConfiguration instance.
    
    Specified by:
    
    setApplicationConfigProperty in interface FuncTestRpcHandler
    
    Returns:
    
    the previous value of the property
  - getApplicationConfigProperty
```
public Object getApplicationConfigProperty(String token,
                                           String propertyKey)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns a property of the global ApplicationConfiguration instance.
    
    Specified by:
    
    getApplicationConfigProperty in interface FuncTestRpcHandler
    
    Returns:
    
    the property mapped to propertyKey
  - setUserFollows
```
public boolean setUserFollows(String token,
                              String followingUsername,
                              Hashtable followUsers)
                       throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Change the follow or unfollow state between a follower user and s a set of folowees users
    
    Specified by:
    
    setUserFollows in interface FuncTestRpcHandler
    
    followingUsername - The username of the user that is doing the following
    
    followUsers - A map of usernames to bbe followed/unfollowed, and a boolean indicating the desired follow status
    
    Throws:
    
    RemoteException
  - followUser
```
public boolean followUser(String token,
                          String userName,
                          boolean followUser)
                   throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Follows or stops following a user. Can be done by any user, not just admins.
    
    Specified by:
    
    followUser in interface FuncTestRpcHandler
    
    followUser - true to follow a user, false to stop following
    
    Throws:
    
    RemoteException
  - storeXhtmlPage
```
public Hashtable storeXhtmlPage(String token,
                                Hashtable pageStruct)
                         throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    The Confluence remote API store page performs wiki to XHTML conversion on the page content. This version will store the supplied content exactly as it is. This is necessary for tests where the automatic conversion is not helpful, such as user macro testing.
    
    Specified by:
    
    storeXhtmlPage in interface FuncTestRpcHandler
    
    Returns:
    
    the created page
    
    Throws:
    
    RemoteException
  - synchroniseUserDirectories
```
public boolean synchroniseUserDirectories(String token)
                                   throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Synchronizes all remote user directories with the local database cache
    
    Specified by:
    
    synchroniseUserDirectories in interface FuncTestRpcHandler
    
    Returns:
    
    true
    
    Throws:
    
    Exception
  - setDirectoryPasswordEncoder
```
public boolean setDirectoryPasswordEncoder(String token,
                                           String directoryName,
                                           String encoder)
                                    throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Changes the password encoder for the given directory
    
    Specified by:
    
    setDirectoryPasswordEncoder in interface FuncTestRpcHandler
    
    Returns:
    
    true
    
    Throws:
    
    Exception
  - removeUserDirectory
```
public boolean removeUserDirectory(String token,
                                   String directoryId)
                            throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Removes user directory
    
    Specified by:
    
    removeUserDirectory in interface FuncTestRpcHandler
    
    directoryId - the id of the directory
    
    Returns:
    
    true if the directory existed and was removed
    
    Throws:
    
    Exception
  - getNumberOfIndexTasksInQueue
```
public int getNumberOfIndexTasksInQueue(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the size of the index queue.
    
    Specified by:
    
    getNumberOfIndexTasksInQueue in interface FuncTestRpcHandler
    
    Returns:
  - addExistingProfilePicture
```
public boolean addExistingProfilePicture(String token,
                                         String userName,
                                         String fileName)
                                  throws Exception
```
    Description copied from interface: FuncTestRpcHandler
    
    Attempts to add a existing profile picture to a user's profile.
    
    Specified by:
    
    addExistingProfilePicture in interface FuncTestRpcHandler
    
    userName - the user name of the profile
    
    fileName - file name of the picture
    
    Returns:
    
    true if the picture is successfully added
    
    Throws:
    
    Exception
  - setBooleanUserPreference
```
public boolean setBooleanUserPreference(String token,
                                        String userName,
                                        String preferenceKey,
                                        String value)
                                 throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a boolean user preference.
    
    Specified by:
    
    setBooleanUserPreference in interface FuncTestRpcHandler
    
    userName - the user name to set the preference for
    
    preferenceKey - the key of the preference to set
    
    value - the string "true" or "false" to set as the preference
    
    Throws:
    
    RemoteException
  - setStringUserPreference
```
public boolean setStringUserPreference(String token,
                                       String userName,
                                       String preferenceKey,
                                       String value)
                                throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets a string user preference.
    
    Specified by:
    
    setStringUserPreference in interface FuncTestRpcHandler
    
    userName - the user name to set the preference for
    
    preferenceKey - the key of the preference to set
    
    value - a string to set as the preference
    
    Throws:
    
    RemoteException
  - enableDailyReportNotification
```
public boolean enableDailyReportNotification(String token,
                                             String userName,
                                             boolean dailyReportEnabled)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets the Daily Report email for a user to enabled or disabled.
    
    Specified by:
    
    enableDailyReportNotification in interface FuncTestRpcHandler
    
    userName - the user name to set the report state for
    
    dailyReportEnabled - true if the daily report should be sent, false if not
  - setNetworkNotificationForUser
```
public boolean setNetworkNotificationForUser(String token,
                                             String userName,
                                             boolean watchNetwork)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets Network watch emails for a user to enabled or disabled.
    
    Specified by:
    
    setNetworkNotificationForUser in interface FuncTestRpcHandler
    
    userName - the user name to set the watch state for
    
    watchNetwork - true if the user should watch their network, false if not
  - setSiteBlogNotificationForUser
```
public boolean setSiteBlogNotificationForUser(String token,
                                              String userName,
                                              boolean globalBlogWatchForUser)
```
    Description copied from interface: FuncTestRpcHandler
    
    Sets Site Blog watch emails for a user to enabled or disabled.
    
    Specified by:
    
    setSiteBlogNotificationForUser in interface FuncTestRpcHandler
    
    userName - the user name to set the watch state for
    
    globalBlogWatchForUser - true if the user should watch all blogs on the site network, false if not
  - getIgnoreBaseURLWarning
```
public boolean getIgnoreBaseURLWarning(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Whether the warning message for an un-advisable value for the Base URL is ignored or not.
    
    Specified by:
    
    getIgnoreBaseURLWarning in interface FuncTestRpcHandler
    
    Returns:
    
    true if the warning message is ignored.
  - setIgnoreBaseURLWarning
```
public boolean setIgnoreBaseURLWarning(String token,
                                       boolean value)
                                throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Affects whether the warning message for an un-advisable value for the Base URL is ignored or not. If ignored, any warning messages about the Base URL will not be displayed.
    
    Specified by:
    
    setIgnoreBaseURLWarning in interface FuncTestRpcHandler
    
    value - set to true to ignore the warning.
    
    Throws:
    
    RemoteException
  - enableUserFeature
```
public boolean enableUserFeature(String token,
                                 String featureKey)
                          throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables a given dark feature for the logged in user.
    
    Specified by:
    
    enableUserFeature in interface FuncTestRpcHandler
    
    featureKey - - the key of the feature to enable
    
    Throws:
    
    RemoteException
  - disableUserFeature
```
public boolean disableUserFeature(String token,
                                  String featureKey)
                           throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disables a given dark feature for the logged in user.
    
    Specified by:
    
    disableUserFeature in interface FuncTestRpcHandler
    
    featureKey - - the key of the feature to disable
    
    Throws:
    
    RemoteException
  - enableSiteFeature
```
public boolean enableSiteFeature(String token,
                                 String featureKey)
                          throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Enables a given dark feature for the entire site.
    
    Specified by:
    
    enableSiteFeature in interface FuncTestRpcHandler
    
    featureKey - - the key of the feature to enable
    
    Throws:
    
    RemoteException
  - disableSiteFeature
```
public boolean disableSiteFeature(String token,
                                  String featureKey)
                           throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Disables a given dark feature for the entire site.
    
    Specified by:
    
    disableSiteFeature in interface FuncTestRpcHandler
    
    featureKey - - the key of the feature to disable
    
    Throws:
    
    RemoteException
  - setWelcomeMessage
```
public boolean setWelcomeMessage(String token,
                                 String welcomeMessage)
```
    Specified by:
    
    setWelcomeMessage in interface FuncTestRpcHandler
  - resetWelcomeMessage
```
public boolean resetWelcomeMessage(String token)
```
    Specified by:
    
    resetWelcomeMessage in interface FuncTestRpcHandler
  - getExportBuildNumber
```
public String getExportBuildNumber(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the backward-compatibility of an export
    
    Specified by:
    
    getExportBuildNumber in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the authentication
    
    Returns:
    
    the build number
  - getOldestSpaceImportAllowed
```
public String getOldestSpaceImportAllowed(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the backwards-compatibility of a space import
    
    Specified by:
    
    getOldestSpaceImportAllowed in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the authentication
    
    Returns:
    
    the oldest build number allowed
  - getPluginExportCompatibility
```
public String getPluginExportCompatibility(String token,
                                           String pluginKey)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the plugin compatibility matrix for exports
    
    Specified by:
    
    getPluginExportCompatibility in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the authentication
    
    pluginKey - the plugin key
    
    Returns:
    
    a version range in the form "4.3..5.0", separated by 2 dots, or null
  - createPagesFromPrototype
```
public Vector<Hashtable> createPagesFromPrototype(String token,
                                                  Hashtable pageStruct,
                                                  int count)
                                           throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Creates a series of pages based on a prototype. Each page will have the same parent and content, and the title will be that of the template plus a space and an index.
    e.g. if the page title passed is "Hey Ho", the created pages will be "Hey Ho 1", "Hey Ho 2" and so on.
    
    Specified by:
    
    createPagesFromPrototype in interface FuncTestRpcHandler
    
    pageStruct - a template page to create multiple pages from
    
    count - the number of pages to create - pages created are 1-indexed
    
    Throws:
    
    RemoteException
  - updateGlobalSettingBoolean
```
public boolean updateGlobalSettingBoolean(String token,
                                          String name,
                                          boolean value)
                                   throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Update a Settings boolean field.
    
    Specified by:
    
    updateGlobalSettingBoolean in interface FuncTestRpcHandler
    
    name - name of the field used to store the setting (see field names inside Settings.
    
    Returns:
    
    the old value
    
    Throws:
    
    RemoteException
  - updateGlobalSettingString
```
public String updateGlobalSettingString(String token,
                                        String name,
                                        String value)
                                 throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Update a Settings String field.
    
    Specified by:
    
    updateGlobalSettingString in interface FuncTestRpcHandler
    
    name - name of the field used to store the setting (see field names inside Settings.
    
    value - the String value the field should take
    
    Returns:
    
    the old value
    
    Throws:
    
    RemoteException
  - createSpaces
```
public Vector<String> createSpaces(String token,
                                   int count)
                            throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Creates a bunch of spaces.
    
    Specified by:
    
    createSpaces in interface FuncTestRpcHandler
    
    count - the number to create
    
    Returns:
    
    the keys of the spaces created
    
    Throws:
    
    RemoteException - if you are not awesome enough to use this method
  - getNumberOfActiveUsers
```
public int getNumberOfActiveUsers(String token)
                           throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns the number of active users, i.e. the number of users used for license purposes.
    
    Specified by:
    
    getNumberOfActiveUsers in interface FuncTestRpcHandler
    
    Returns:
    
    the number of active users
    
    Throws:
    
    RemoteException
  - isUnlimitedUserLicense
```
public boolean isUnlimitedUserLicense(String token)
                               throws RemoteException
```
    Specified by:
    
    isUnlimitedUserLicense in interface FuncTestRpcHandler
    
    Returns:
    
    true if the current licence has no user limit, false otherwise
    
    Throws:
    
    RemoteException
  - getAliveThreads
```
public Vector<Hashtable> getAliveThreads(String token)
                                  throws RemoteException
```
    Specified by:
    
    getAliveThreads in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - getStackDump
```
public String getStackDump(String token,
                           String threadNameRegex)
                    throws RemoteException
```
    Specified by:
    
    getStackDump in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setEnableAnonymousRpc
```
public boolean setEnableAnonymousRpc(String token,
                                     String value)
                              throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Toggle the setting to allow/deny anonymous RPC calls. You will also need to enable anonymous access at the permissions level using the Admin RPC interface.
    
    Specified by:
    
    setEnableAnonymousRpc in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - getContentForAllLabels
```
public Hashtable<String,Object> getContentForAllLabels(String token,
                                                             int offset,
                                                             int maxResults,
                                                             String labels)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns CEOs having all of the labels supplied in the string. Labels are space-separated.
    
    Specified by:
    
    getContentForAllLabels in interface FuncTestRpcHandler
  - getContentInSpacesForAllLabels
```
public Hashtable<String,Object> getContentInSpacesForAllLabels(String token,
                                                                     int offset,
                                                                     int maxResults,
                                                                     String spaceKeysString,
                                                                     String labelsString)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns CEOs in the given spaces having all of the labels supplied in the string. Labels and space keys are space-separated.
    
    Specified by:
    
    getContentInSpacesForAllLabels in interface FuncTestRpcHandler
  - getAllContentForAllLabels
```
public Hashtable<String,Object> getAllContentForAllLabels(String token,
                                                                int offset,
                                                                int maxResults,
                                                                String labelsString)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns current and trashed CEOs having all of the labels supplied in the string. Labels are space-separated.
    
    Specified by:
    
    getAllContentForAllLabels in interface FuncTestRpcHandler
  - getForLabels
```
public Hashtable<String,Object> getForLabels(String token,
                                                   String labelableType,
                                                   int offset,
                                                   int maxResults,
                                                   String labelsString)
```
    Description copied from interface: FuncTestRpcHandler
    
    Returns any kind of Labelable entities having all of the labels supplied in the string. Labels are space-separated.
    
    Specified by:
    
    getForLabels in interface FuncTestRpcHandler
  - addLabelToLabelable
```
public int addLabelToLabelable(String token,
                               String labelName,
                               String labelableId,
                               String labelableType)
```
    Description copied from interface: FuncTestRpcHandler
    
    Adds a label to a labelable, because the public RPC API doesn't let you do it. Feel free to turn it all into REST to make the pain go away.
    
    Specified by:
    
    addLabelToLabelable in interface FuncTestRpcHandler
  - startLoggingRequests
```
public boolean startLoggingRequests(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Start logging http request urls.
    Call FuncTestRpcHandler.finishLoggingRequests(String) to stop logging and to retrieve results.
    
    Specified by:
    
    startLoggingRequests in interface FuncTestRpcHandler
    
    Returns:
    
    true
  - finishLoggingRequests
```
public Vector<String> finishLoggingRequests(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Finish logging http request and return any requests made.
    Logging must have been previously started using FuncTestRpcHandler.startLoggingRequests(String).
    
    Specified by:
    
    finishLoggingRequests in interface FuncTestRpcHandler
    
    Returns:
    
    url of each request made
  - resetDatabaseStatistics
```
public boolean resetDatabaseStatistics(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Reset database statistics.
    Call FuncTestRpcHandler.getDatabaseStatistics(String) to get results since the last reset.
    
    Specified by:
    
    resetDatabaseStatistics in interface FuncTestRpcHandler
    
    Returns:
    
    true
  - getDatabaseStatistics
```
public String getDatabaseStatistics(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Return database statistics.
    Statistics since the last call to FuncTestRpcHandler.resetDatabaseStatistics(String) are returned.
    
    Specified by:
    
    getDatabaseStatistics in interface FuncTestRpcHandler
    
    Returns:
    
    stabase statistics
  - runGarbageCollection
```
public boolean runGarbageCollection(String token)
```
    Specified by:
    
    runGarbageCollection in interface FuncTestRpcHandler
  - isImportTaskRunning
```
public boolean isImportTaskRunning(String token)
```
    Specified by:
    
    isImportTaskRunning in interface FuncTestRpcHandler
  - getAnonyimizedClusterNodeIdentifier
```
public String getAnonyimizedClusterNodeIdentifier(String token)
```
    Specified by:
    
    getAnonyimizedClusterNodeIdentifier in interface FuncTestRpcHandler
  - moveBlogPost
```
public boolean moveBlogPost(String token,
                            String blogPostId,
                            String targetSpaceKey)
```
    Specified by:
    
    moveBlogPost in interface FuncTestRpcHandler
  - assertThatIndexQueueEntryHasBeenProcessed
```
public boolean assertThatIndexQueueEntryHasBeenProcessed(String token,
                                                         String searchableClassname,
                                                         String searchableId)
                                                  throws RemoteException
```
    Specified by:
    
    assertThatIndexQueueEntryHasBeenProcessed in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - increaseHighValue
```
public boolean increaseHighValue(String token)
```
    Description copied from interface: FuncTestRpcHandler
    
    Put a number bigger than 65535 in Hibernate_unique_key table to force generated ids to be greater than max integer.
    
    Specified by:
    
    increaseHighValue in interface FuncTestRpcHandler
    
    Parameters:
    
    token - the rpc authentication token
    
    Returns:
    
    true if successful.
  - getRecordedErrorLogMessages
```
public Vector<String> getRecordedErrorLogMessages(String token)
```
    Specified by:
    
    getRecordedErrorLogMessages in interface FuncTestRpcHandler
  - clearRecordedLogMessages
```
public boolean clearRecordedLogMessages(String token)
```
    Specified by:
    
    clearRecordedLogMessages in interface FuncTestRpcHandler
  - setHibernateConnectionProviderLastExceptionTime
```
public boolean setHibernateConnectionProviderLastExceptionTime(String token,
                                                               String timeStr)
```
    Specified by:
    
    setHibernateConnectionProviderLastExceptionTime in interface FuncTestRpcHandler
  - clearHibernateConnectionProviderLastExceptionTime
```
public boolean clearHibernateConnectionProviderLastExceptionTime(String token)
```
    Specified by:
    
    clearHibernateConnectionProviderLastExceptionTime in interface FuncTestRpcHandler
  - setGlobalLanguage
```
public boolean setGlobalLanguage(String token,
                                 String language)
                          throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Changes to the default site language
    
    Specified by:
    
    setGlobalLanguage in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException
  - setIndexingLanguage
```
public boolean setIndexingLanguage(String token,
                                   String language)
                            throws RemoteException
```
    Description copied from interface: FuncTestRpcHandler
    
    Changes the indexing language
    
    Specified by:
    
    setIndexingLanguage in interface FuncTestRpcHandler
    
    Throws:
    
    RemoteException

Class FuncTestRpcDelegator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FuncTestRpcDelegator

Method Detail

logMessage

changeLoggerLevel

removeTestData

removeTestDataAfterExternalUserManagement

removeAllSpaces

createTemplate

createTemplateWithStorageFormat

disconnectUser

disconnectGroup

isCurrentApplicationSet

removeAllTrustedApplications

massCreateAttachments

getGlobalConfiguredTheme

isPluginModuleEnabled

getConfiguredThemeForSpace

setGlobalTheme

setThemeForSpace

clearCustomHtml

uninstallPlugin

disablePlugin

disablePluginWithoutPersisting

enablePlugin

enablePluginModule

disablePluginModule

isSpringComponentPresent

isPluginUpgradeTasksComplete

waitForEvent

waitForEventQueue

shutdownScheduler

removeBandanaKey

setBandanaStringSet

setBandanaStringList

setBandanaKey

setBandanaKeyBoolean

setBandanaKeyInteger

getBandanaValue

getContentPropertyKeys

getContentProperty

getContentTextProperty

getContentStringProperty

getContentPropertiesString

getContentPropertiesStringForSpace

setContentTextProperty

setContentStringProperty

setContentPropertiesString

setContentPropertiesStringForSpace

getPersonalInformationId

removePersonalInformation

getLocaleForUser

setLocaleForUser

setUserDetails

setUserDetailProperty

putStringMappingInCache

getCacheStatistics

getCacheMaximumNumberOfElements

setCacheMaximumNumberOfElements

getCacheStatisticsCapabilities

flushAllCaches

enableWebSudo

setWebSudoTimeout

enableElevatedSecurityCheck

enablePublicSignUp

startActivity

stopActivity

setKeyboardShortcutPref

setWatchOwnContentPref

setWatchSpaces

setWatchSpace

getUsersForActivity

registerEventListener

unregisterEventListener

clearEventListeners

removeMailServer