com.atlassian.confluence.test.rpc
Interface FuncTestRpcHandler

All Known Implementing Classes:
FuncTestRpcDelegator, FuncTestRpcHandlerImpl

public interface FuncTestRpcHandler


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

Method Detail

logMessage

@Deprecated
boolean logMessage(String token,
                              String destination,
                              String message)
                   throws RemoteException
Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.

Log a message to the server's console.

Only administrators can log messages.

The destination of the message has the following valid values:

Parameters:
token - The token idenfitying the user.
destination - The destination of the message to be logged
message - The text message to be logged to the console
Returns:
boolean True if the message is logged (ie destination is a valid level)
Throws:
RemoteException

changeLoggerLevel

@Deprecated
String changeLoggerLevel(String token,
                                    String loggerName,
                                    String level)
                         throws RemoteException
Deprecated. since 5.6. Use a FuncTestAdminLoggingResource REST call.

Change the level of the specified logger.

The level parameter can be one of -


removeTestData

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

Parameters:
token - the token identifying the user.
usersToKeep - users like admin and sysadmin that should not be removed
groupsToKeep - groups like admins and users that should not be removed
userGroupMemberships - a map where the keys are group names and the values are lists of usernames in the group
Throws:
NotPermittedException
RemoteException

removeTestDataAfterExternalUserManagement

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

Throws:
Exception

removeAllSpaces

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

Throws:
RemoteException

createTemplate

String createTemplate(String token,
                      String templateName,
                      String content,
                      String spaceKey)
                      throws RemoteException,
                             XhtmlException
Create a new template. If spaceKey is not defined, a global template will be created.

Returns:
template id
Throws:
RemoteException
XhtmlException

createTemplateWithStorageFormat

String createTemplateWithStorageFormat(String token,
                                       String templateName,
                                       String storageFormat,
                                       String spaceKey)
                                       throws RemoteException,
                                              XhtmlException
Create a new template from storage format code. If spaceKey is not defined, a global template will be created.

Returns:
template id
Throws:
RemoteException
XhtmlException

getGlobalPermissionsForGroup

String[] getGlobalPermissionsForGroup(String token,
                                      String groupName)
                                      throws RemoteException
Gets the global permissions that the given group has.

Throws:
RemoteException

disconnectUser

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

Throws:
RemoteException

disconnectGroup

boolean disconnectGroup(String token,
                        String groupName)
                        throws RemoteException
Disconnect a group from Confluence. Removes all its permissions.

Throws:
RemoteException

isCurrentApplicationSet

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

Throws:
NotPermittedException

removeAllTrustedApplications

boolean removeAllTrustedApplications(String token)
                                     throws Exception
Removes all trusted applications from the database.

Throws:
Exception

massCreateAttachments

boolean massCreateAttachments(String token,
                              String pageId,
                              String prefix,
                              String numAttachments)
                              throws Exception
Create a whole series of attachments on a single page.

Throws:
Exception

getGlobalConfiguredTheme

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

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

Throws:
Exception

getConfiguredThemeForSpace

@Deprecated
String getConfiguredThemeForSpace(String token,
                                             String spaceKey)
                                  throws Exception
Deprecated. since 5.6. Use FuncTestAdminThemeResource.

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

Throws:
Exception

setGlobalTheme

@Deprecated
boolean setGlobalTheme(String token,
                                  String themeKey)
                       throws Exception
Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Sets the global theme

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

setThemeForSpace

@Deprecated
boolean setThemeForSpace(String token,
                                    String spaceKey,
                                    String themeKey)
                         throws Exception
Deprecated. since 5.6. Use FuncTestAdminThemeResource.

Sets the theme for the specified space

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

clearCustomHtml

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

Returns:
true always.
Throws:
Exception

uninstallPlugin

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

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

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

disablePlugin

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

Disable a plugin.

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

disablePluginWithoutPersisting

boolean disablePluginWithoutPersisting(String token,
                                       String pluginKey)
                                       throws NotPermittedException
Disable a plugin without persisting.

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

enablePlugin

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

Enable a plugin.

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

enablePluginModule

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

Enable plugin module

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

disablePluginModule

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

Disable plugin module

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

isPluginModuleEnabled

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

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

Parameters:
pluginKey - the key of the plugin
moduleKey - the key of the module excluding the plugin key
Returns:
true if the plugin module exists and is enabled, false otherwise
Throws:
NotPermittedException

isSpringComponentPresent

boolean isSpringComponentPresent(String token,
                                 String name)
Returns true if a Spring component with the given name exists in the application context.


isPluginUpgradeTasksComplete

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


pauseAllJobs

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

Pauses the quartz scheduler.

Throws:
Exception

resumeAllJobs

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

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

Throws:
Exception

pauseJobGroup

@Deprecated
boolean pauseJobGroup(String token,
                                 String jobGroupName)
                      throws Exception
Deprecated. since 5.6. Use FuncTestAdminSchedulerResource.

Pauses the named job group in the quartz scheduler.

Throws:
Exception

pauseJob

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

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

Throws:
Exception

resumeJob

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

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

Throws:
Exception

triggerJob

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

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

Throws:
Exception

waitForEvent

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

Parameters:
eventClassName - the fully qualified classname of the event to wait for.
timeout - number of milliseconds to wait for the event before giving up completely.
timeUnit - See TimeUnit.name
Returns:
true if the event occurs within the timeout.
Throws:
Exception

waitForEventQueue

boolean waitForEventQueue(String token,
                          String timeoutStr,
                          String timeUnitStr)
                          throws Exception
Waits for all events in queue to be processed.

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

shutdownQuartz

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

Shutdown the quartz scheduler to ensure single threadedness for testing

Throws:
Exception

removeBandanaKey

@Deprecated
boolean removeBandanaKey(String token,
                                    String space,
                                    String key)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Remove a key from Bandana


setBandanaStringSet

@Deprecated
boolean setBandanaStringSet(String token,
                                       String space,
                                       String key,
                                       Vector<String> value)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Sets a key in Bandana with a Set of Strings as value


setBandanaStringList

@Deprecated
boolean setBandanaStringList(String token,
                                        String space,
                                        String key,
                                        Vector<String> value)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Sets a key in Bandana with a List of Strings as value


setBandanaKey

@Deprecated
boolean setBandanaKey(String token,
                                 String space,
                                 String key,
                                 String value)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Sets a key in Bandana


setBandanaKeyBoolean

@Deprecated
boolean setBandanaKeyBoolean(String token,
                                        String space,
                                        String key,
                                        boolean value)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Sets a key in Bandana


setBandanaKeyInteger

@Deprecated
boolean setBandanaKeyInteger(String token,
                                        String space,
                                        String key,
                                        int value)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Sets a key in Bandana


getBandanaValue

@Deprecated
Object getBandanaValue(String token,
                                  String space,
                                  String key)
Deprecated. since 5.6. Use FuncTestAdminBandanaResource.

Gets a value from Bandana


getContentPropertyKeys

Vector getContentPropertyKeys(String token,
                              String entityId)
Get the content property keys for a content entity given its id


getContentProperty

String getContentProperty(String token,
                          String entityId,
                          String key)
Get the content property value for a content entity given its id and the property key


getContentPropertiesString

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


getContentPropertiesStringForSpace

String getContentPropertiesStringForSpace(String token,
                                          String spaceKey,
                                          String key)
Get the string value of a ContentProperty associated with the SpaceDescription of the space


setContentTextProperty

boolean setContentTextProperty(String token,
                               String entityId,
                               String key,
                               String value)
Sets a text content property for a content entity given its id


setContentPropertiesString

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


setContentPropertiesStringForSpace

boolean setContentPropertiesStringForSpace(String token,
                                           String spaceKey,
                                           String key,
                                           String value)
Sets the string value of a ContentProperty associated with the SpaceDescription of the space


getPersonalInformationId

String getPersonalInformationId(String token,
                                String username)
Gets the personal information id for a given username


removePersonalInformation

boolean removePersonalInformation(String token,
                                  String username)
                                  throws NotPermittedException
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).

Parameters:
username - user whose personalInformation will be removed
Returns:
true because it has to return something
Throws:
NotPermittedException

getLocaleForUser

String getLocaleForUser(String token,
                        String username)
Gets the locale preference for the user.


setLocaleForUser

boolean setLocaleForUser(String token,
                         String username,
                         String locale)
                         throws RemoteException
Sets the locale preference for the user to the given named locale.

Throws:
RemoteException

setGlobalLanguage

boolean setGlobalLanguage(String token,
                          String language)
                          throws RemoteException
Changes to the default site language

Throws:
RemoteException

setKeyboardShortcutPref

boolean setKeyboardShortcutPref(String token,
                                String username,
                                String enabled)
                                throws RemoteException
Enables/Disables keyboard shortcuts for the given uesr

Throws:
RemoteException

setWatchOwnContentPref

boolean setWatchOwnContentPref(String token,
                               String username,
                               String enabled)
                               throws RemoteException
Enables/Disables autowatching for the given uesr

Throws:
RemoteException

setWatchSpaces

boolean setWatchSpaces(String token,
                       String username,
                       String contentTypeStr,
                       Hashtable spaces)
                       throws RemoteException
Enables/Disables watching spaces for the given user and content type.

Throws:
RemoteException

setWatchSpace

boolean setWatchSpace(String token,
                      String username,
                      String spaceKey,
                      String contentType,
                      String enabled)
                      throws RemoteException
Enables/Disables watching a space for the given user and content type.

Throws:
RemoteException

setUserDetails

boolean setUserDetails(String token,
                       String username,
                       String fullName,
                       String email)
                       throws RemoteException
Sets the fullname and email address of a user with a given username.

Returns:
true because XMLRPC methods have to return something
Throws:
RemoteException - if the user was not found.

setUserDetailProperty

boolean setUserDetailProperty(String token,
                              String username,
                              String propertyKey,
                              String propertyValue)
Sets a single UserDetails property through the UserDetailsManager.

Returns:
true because XMLRPC methods have to return something
Throws:
RemoteException - if the user was not found.

putStringMappingInCache

@Deprecated
boolean putStringMappingInCache(String token,
                                           String cacheName,
                                           String key,
                                           String value)
                                throws Exception
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

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.

Returns:
true because void is not allowed.
Throws:
Exception

getCacheStatistics

@Deprecated
Hashtable getCacheStatistics(String token,
                                        String cacheName)
                             throws Exception
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

Returns the cache statistics for a particular named cache.

Parameters:
cacheName - the key of the cache, rather than the "niceName"
Returns:
A hashtable representing the cache statistics
Throws:
Exception

getCacheMaximumNumberOfElements

@Deprecated
Integer getCacheMaximumNumberOfElements(String token,
                                                   String cacheName)
                                        throws Exception
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

Returns the configured maximum number of elements in the given cache

Parameters:
cacheName - the key of the cache, rather than the "niceName"
Throws:
Exception

setCacheMaximumNumberOfElements

@Deprecated
boolean setCacheMaximumNumberOfElements(String token,
                                                   String cacheName,
                                                   int maxNumElements)
                                        throws Exception
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

(Re)configures the maximum number of elements in the given cache

Parameters:
cacheName - the key of the cache, rather than the "niceName"
Throws:
Exception

getCacheStatisticsCapabilities

@Deprecated
Vector<String> getCacheStatisticsCapabilities(String token)
                                              throws NotPermittedException
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

Returns the capabiltiies exposed by the cache statics service.

Throws:
NotPermittedException

flushAllCaches

@Deprecated
boolean flushAllCaches(String token)
                       throws Exception
Deprecated. since 5.6. Use FuncTestAdminCacheResource.

Flushes all the caches.

Returns:
true because void isn't allowed.
Throws:
Exception

enableWebSudo

boolean enableWebSudo(String token,
                      boolean enabled)
                      throws Exception
Sets the web sudo enabled status

Returns:
true because void isn't allowed.
Throws:
Exception

setWebSudoTimeout

boolean setWebSudoTimeout(String token,
                          int timeout)
                          throws Exception
Sets the web sudo timeout in minutes

Returns:
true because void isn't allowed.
Throws:
Exception

enableElevatedSecurityCheck

boolean enableElevatedSecurityCheck(String token,
                                    boolean enabled)
                                    throws Exception
Throws:
Exception

enablePublicSignUp

boolean enablePublicSignUp(String token,
                           boolean enabled)
                           throws Exception
Sets the public sign up enabled status

Returns:
true because void isn't allowed.
Throws:
Exception

startActivity

boolean startActivity(String key,
                      String user)
                      throws Exception
Call startActivity on the heartbeatManager bean

Throws:
Exception

getUsersForActivity

Vector getUsersForActivity(String key)
                           throws Exception
Call getUsersForActivity on the heartbeatManager bean

Throws:
Exception

removeUserUncleanly

boolean removeUserUncleanly(String token,
                            String username)
                            throws Exception
Remove a User without removing the things that refer to that user.

Throws:
Exception

removeGroupUncleanly

boolean removeGroupUncleanly(String token,
                             String groupname)
                             throws Exception
Remove a Group without removing the things that refer to that group.

Throws:
Exception

doesDraftExist

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.

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

int countDrafts(String token,
                String owner)

createDraft

Hashtable createDraft(String token,
                      Hashtable draft)
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.

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

Hashtable updateDraft(String token,
                      Hashtable draft)
Updates a draft located using the draft owner and draft type. Draft is then updated with the specified title and content

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

boolean removeDrafts(String token,
                     String username)
Removes all drafts owned by the specified User.

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

boolean setDraftSaveInterval(String token,
                             int seconds)
Sets the given draft save interval.

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

boolean clearQueue(String token,
                   String queueName)
Removes all items from the specified queue

Returns:
true if this is successful, false if no queue with this name exists

getQueueSize

int getQueueSize(String token,
                 String queueName)
Returns the size of the task queue with the specified name.

Returns:
the size of the task queue with the specified name.

getNumberOfIndexTasksInQueue

int getNumberOfIndexTasksInQueue(String token)
Returns the size of the index queue.

Parameters:
token -
Returns:

removeMailServer

boolean removeMailServer(String token,
                         String serverName)
                         throws Exception
Remove the named mail server.

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

String getLeastRecentTestAppenderLogMessage(String token,
                                            String className)

registerTestAppenderForClass

boolean registerTestAppenderForClass(String token,
                                     String className)

unregisterTestAppenderForClass

boolean unregisterTestAppenderForClass(String token,
                                       String className)

logTestMessageForClass

boolean logTestMessageForClass(String token,
                               String className,
                               String message,
                               String level)

getLocalisedText

String getLocalisedText(String token,
                        String messageKey)
Get the localised string for given the message key in the logged-in user's locale.

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.

addUserAnyCase

boolean addUserAnyCase(String token,
                       String username,
                       String email,
                       String fullname,
                       String password)
                       throws RemoteException
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.

Throws:
NotPermittedException - if you do not have permissions to add the user.
RemoteException

addGroupAnyCase

boolean addGroupAnyCase(String token,
                        String groupname)
                        throws RemoteException
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.

Parameters:
groupname - the name of the group to add
Returns:
true if successfully added, otherwise false
Throws:
RemoteException

changeSpaceCreatedDate

boolean changeSpaceCreatedDate(String token,
                               String spaceKey,
                               Date createdDate)
                               throws RemoteException
Change the created date of a space

Parameters:
spaceKey - the space key of the space to change the created date
Throws:
RemoteException

changeCommentCreatedDate

boolean changeCommentCreatedDate(String token,
                                 String commentId,
                                 Date createdDate)
                                 throws RemoteException
Change the created date of a comment

Throws:
RemoteException

changePageCreatedDate

boolean changePageCreatedDate(String token,
                              String pageId,
                              Date createdDate)
                              throws RemoteException
Change the created date of a page

Parameters:
pageId - the page id of the page to change the created date
Throws:
RemoteException

removeAttachmentUncleanly

boolean removeAttachmentUncleanly(String token,
                                  String contentId,
                                  String attachmentFileName)
                                  throws RemoteException
Removes an attachment without cleaning up associated attachment info

Parameters:
token - the authentication
contentId - the content that the attachment is attached to
attachmentFileName - the attachment
Returns:
true
Throws:
RemoteException

changeAttachmentCreatedDate

boolean changeAttachmentCreatedDate(String token,
                                    String contentId,
                                    String attachmentFileName,
                                    Date createdDate)
                                    throws RemoteException
Change the created date of an attachment

Parameters:
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

boolean changeBlogPostModificationDate(String token,
                                       String blogId,
                                       Date modificationDate)
                                       throws RemoteException
Change the modification date of a blog post

Parameters:
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

boolean changePageModificationDate(String token,
                                   String pageId,
                                   Date modificationDate)
                                   throws RemoteException
Change the modification date of a page

Parameters:
pageId - the page id of the page to change the modification date
modificationDate - the last modification date to be set.
Throws:
RemoteException

getVersionForPage

int getVersionForPage(String token,
                      String pageId)
                      throws RemoteException
Get the version number for the page with pageId

Throws:
RemoteException

saveDateFormat

boolean saveDateFormat(String token,
                       String dateFormat)

saveDateTimeFormat

boolean saveDateTimeFormat(String token,
                           String dateTimeFormat)

addMailServer

@Deprecated
boolean addMailServer(String token,
                                 String name,
                                 String from,
                                 String subjectPrefix,
                                 String hostname,
                                 int port,
                                 String fromName)
Deprecated. since 5.0. Use addSmtpServer instead.


addMailServer

@Deprecated
boolean addMailServer(String token,
                                 String name,
                                 String from,
                                 String subjectPrefix,
                                 String hostname,
                                 int port)
Deprecated. since 5.0. Use addSmtpServer instead.


addSmtpServer

boolean addSmtpServer(String token,
                      String name,
                      String from,
                      String subjectPrefix,
                      String hostname,
                      int port,
                      String fromName)

addSmtpServer

boolean addSmtpServer(String token,
                      String name,
                      String from,
                      String subjectPrefix,
                      String hostname,
                      int port)
Add an SMTP mail server.


setSmtpServer

boolean setSmtpServer(String token,
                      String name,
                      String from,
                      String subjectPrefix,
                      String hostname,
                      int port)
Remove all existing SMTP servers and add the given server.


setSmtpServer

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.


addMailServer

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. The account's associated email address must also be passed.


convertMarkupToXhtml

String convertMarkupToXhtml(String token,
                            String wikiMarkup,
                            String pageId)
Render a page as XHTML.


convertXhtmlToMarkup

String convertXhtmlToMarkup(String token,
                            String xhtml,
                            String pageId)
Convert XHTML to WikiMarkup.


createJohnsonEvent

boolean createJohnsonEvent(String token,
                           String message)
Creates a Johnson event inside Confluence. This method is used to test the ConfluenceJohnsonFilter.

Parameters:
message - the description of the event to create

removeAllJohnsonEvents

boolean removeAllJohnsonEvents(String token)
Removes all Johnson events from Confluence


enableCaptcha

boolean enableCaptcha(String token,
                      boolean enable)
Sets the captcha mode


enableCaptchaDebugMode

boolean enableCaptchaDebugMode(String token,
                               boolean enable)
Sets the captcha mode into debug mode. See CaptchaManager.setDebugMode(boolean).


getSystemProperty

Hashtable<String,String> getSystemProperty(String token,
                                           String name)
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.

Parameters:
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

Boolean setSystemProperty(String token,
                          String name,
                          String value)
Set a system property on the server to the supplied value.

Parameters:
name - the name of the property
value - the value of the property
Returns:
always true since XML RPC can't handle void

clearSystemProperty

Boolean clearSystemProperty(String token,
                            String name)
Unset a system property.

Parameters:
name - the name of the property
Returns:
always true since XML RPC can't handle void

clearIndex

boolean clearIndex(String token)
Blows away the main Confluence search index.


restoreAbstractPage

boolean restoreAbstractPage(String token,
                            String abstractPageId)
Restores an abstract page from the trash.


getIdOfPagePermission

String getIdOfPagePermission(String token,
                             String contentId,
                             String permissionType,
                             String username)
Returns:
the id of the identified content permission or 0 if there is no match found.

createTestUsers

int createTestUsers(String token,
                    int count)
Create test users with usernames "testuser0", "testuser1", etc. Each user's password is the same as their username.

Returns:
the number of users created

removeTestUsers

int removeTestUsers(String token,
                    int count)
Removes test users with usernames "testuser0", "testuser1", etc. Logs a warning if a user cannot be removed.

Returns:
the number of users removed

createUserMacro

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
Create a User Macro

Parameters:
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:
RuntimeException - if the macro already exists
NotPermittedException

removeUserMacro

boolean removeUserMacro(String token,
                        String name)
                        throws NotPermittedException
Remove a User Macro with the given name if it exists.

Returns:
true all the time because XMLRPC methods need a non-void return type.
Throws:
NotPermittedException

registerEventListener

boolean registerEventListener(String token,
                              String eventClassName)
                              throws Exception
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 unregisterEventListener(String, String) in a finally clause to ensure the temporary listener is cleaned up.

Once the listener is registered, clients can use waitForEvent(String, String, String, String) to block until the event is published.

Throws:
Exception

unregisterEventListener

boolean unregisterEventListener(String token,
                                String eventClassName)
                                throws Exception
Unregisters the temporary listener registered for the specified event.

Throws:
Exception

clearEventListeners

boolean clearEventListeners(String token)
                            throws Exception
Removes all temporary event listeners, regardless of their state.

Returns:
true because some result is required.
Throws:
Exception

setApplicationConfigProperty

boolean setApplicationConfigProperty(String token,
                                     String propertyKey,
                                     String propertyValue)
Sets a property on the global ApplicationConfiguration instance.

Returns:
the previous value of the property

getApplicationConfigProperty

Object getApplicationConfigProperty(String token,
                                    String propertyKey)
Returns a property of the global ApplicationConfiguration instance.

Parameters:
propertyKey -
Returns:
the property mapped to propertyKey

setUserFollows

boolean setUserFollows(String token,
                       String followingUsername,
                       Hashtable followUsers)
                       throws RemoteException
Change the follow or unfollow state between a follower user and s a set of folowees users

Parameters:
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

boolean followUser(String token,
                   String userName,
                   boolean followUser)
                   throws RemoteException
Follows or stops following a user. Can be done by any user, not just admins.

Parameters:
followUser - true to follow a user, false to stop following
Throws:
RemoteException

setUserStatus

String setUserStatus(String token,
                     String wikiStatus)
                     throws Exception
Set the current user's status. Can be done by any user, not just admins.

Parameters:
wikiStatus - the status string in wiki markup.
Returns:
the id of the new status, converted to a String
Throws:
Exception

storeXhtmlPage

Hashtable storeXhtmlPage(String token,
                         Hashtable pageStruct)
                         throws RemoteException
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.

Parameters:
token -
pageStruct -
Returns:
the created page
Throws:
RemoteException

synchroniseUserDirectories

boolean synchroniseUserDirectories(String token)
                                   throws Exception
Synchronizes all remote user directories with the local database cache

Returns:
true
Throws:
Exception

setDirectoryPasswordEncoder

boolean setDirectoryPasswordEncoder(String token,
                                    String directoryName,
                                    String encoder)
                                    throws Exception
Changes the password encoder for the given directory

Returns:
true
Throws:
Exception

removeUserDirectory

boolean removeUserDirectory(String token,
                            String directoryId)
                            throws Exception
Removes user directory

Parameters:
directoryId - the id of the directory
Returns:
true if the directory existed and was removed
Throws:
Exception

addExistingProfilePicture

boolean addExistingProfilePicture(String token,
                                  String userName,
                                  String fileName)
                                  throws Exception
Attempts to add a existing profile picture to a user's profile.

Parameters:
userName - the user name of the profile
fileName - file name of the picture
Returns:
true if the picture is successfully added
Throws:
Exception

setBooleanUserPreference

boolean setBooleanUserPreference(String token,
                                 String userName,
                                 String preferenceKey,
                                 String value)
                                 throws RemoteException
Sets a boolean user preference.

Parameters:
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

boolean setStringUserPreference(String token,
                                String userName,
                                String preferenceKey,
                                String value)
                                throws RemoteException
Sets a string user preference.

Parameters:
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

boolean enableDailyReportNotification(String token,
                                      String userName,
                                      boolean dailyReportEnabled)
Sets the Daily Report email for a user to enabled or disabled.

Parameters:
userName - the user name to set the report state for
dailyReportEnabled - true if the daily report should be sent, false if not

setNetworkNotificationForUser

boolean setNetworkNotificationForUser(String token,
                                      String userName,
                                      boolean watchNetwork)
Sets Network watch emails for a user to enabled or disabled.

Parameters:
userName - the user name to set the watch state for
watchNetwork - true if the user should watch their network, false if not

setSiteBlogNotificationForUser

boolean setSiteBlogNotificationForUser(String token,
                                       String userName,
                                       boolean globalBlogWatchForUser)
Sets Site Blog watch emails for a user to enabled or disabled.

Parameters:
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

boolean getIgnoreBaseURLWarning(String token)
Whether the warning message for an un-advisable value for the Base URL is ignored or not.

Returns:
true if the warning message is ignored.

setIgnoreBaseURLWarning

boolean setIgnoreBaseURLWarning(String token,
                                boolean value)
                                throws RemoteException
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.

Parameters:
value - set to true to ignore the warning.
Throws:
RemoteException

enableUserFeature

@Deprecated
boolean enableUserFeature(String token,
                                     String featureKey)
                          throws RemoteException
Deprecated. since 5.6. Use the REST resource.

Enables a given dark feature for the logged in user.

Parameters:
featureKey - - the key of the feature to enable
Throws:
RemoteException

disableUserFeature

@Deprecated
boolean disableUserFeature(String token,
                                      String featureKey)
                           throws RemoteException
Deprecated. since 5.6. Use the REST resource.

Disables a given dark feature for the logged in user.

Parameters:
featureKey - - the key of the feature to disable
Throws:
RemoteException

enableSiteFeature

@Deprecated
boolean enableSiteFeature(String token,
                                     String featureKey)
                          throws RemoteException
Deprecated. since 5.6. Use the REST resource.

Enables a given dark feature for the entire site.

Parameters:
featureKey - - the key of the feature to enable
Throws:
RemoteException

disableSiteFeature

@Deprecated
boolean disableSiteFeature(String token,
                                      String featureKey)
                           throws RemoteException
Deprecated. since 5.6. Use the REST resource.

Disables a given dark feature for the entire site.

Parameters:
featureKey - - the key of the feature to disable
Throws:
RemoteException

setWelcomeMessage

boolean setWelcomeMessage(String token,
                          String welcomeMessage)

resetWelcomeMessage

boolean resetWelcomeMessage(String token)

createPagesFromPrototype

Vector<Hashtable> createPagesFromPrototype(String token,
                                           Hashtable pageStruct,
                                           int count)
                                           throws RemoteException
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.

Parameters:
pageStruct - a template page to create multiple pages from
count - the number of pages to create - pages created are 1-indexed
Throws:
RemoteException

updateGlobalSettingBoolean

boolean updateGlobalSettingBoolean(String token,
                                   String name,
                                   boolean value)
                                   throws RemoteException
Update a Settings boolean field.

Parameters:
token -
name - name of the field used to store the setting (see field names inside Settings.
value -
Returns:
the old value
Throws:
RemoteException

updateGlobalSettingString

String updateGlobalSettingString(String token,
                                 String name,
                                 String value)
                                 throws RemoteException
Update a Settings String field.

Parameters:
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

Vector<String> createSpaces(String token,
                            int count)
                            throws RemoteException
Creates a bunch of spaces.

Parameters:
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

int getNumberOfActiveUsers(String token)
                           throws RemoteException
Returns the number of active users, i.e. the number of users used for license purposes.

Returns:
the number of active users
Throws:
RemoteException

getExportBuildNumber

String getExportBuildNumber(String token)
Returns the backward-compatibility of an export

Parameters:
token - the authentication
Returns:
the build number

getOldestSpaceImportAllowed

String getOldestSpaceImportAllowed(String token)
Returns the backwards-compatibility of a space import

Parameters:
token - the authentication
Returns:
the oldest build number allowed

getPluginExportCompatibility

String getPluginExportCompatibility(String token,
                                    String pluginKey)
Returns the plugin compatibility matrix for exports

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

isUnlimitedUserLicense

boolean isUnlimitedUserLicense(String token)
                               throws RemoteException
Returns:
true if the current licence has no user limit, false otherwise
Throws:
RemoteException

getAliveThreads

Vector<Hashtable> getAliveThreads(String token)
                                  throws RemoteException
Throws:
RemoteException

setEnableAnonymousRpc

boolean setEnableAnonymousRpc(String token,
                              String value)
                              throws RemoteException
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.

Throws:
RemoteException

getContentForAllLabels

Hashtable<String,Object> getContentForAllLabels(String token,
                                                int offset,
                                                int maxResults,
                                                String labels)
Returns CEOs having all of the labels supplied in the string. Labels are space-separated.


getContentInSpacesForAllLabels

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. Labels and space keys are space-separated.


getAllContentForAllLabels

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. Labels are space-separated.


getForLabels

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. Labels are space-separated.


addLabelToLabelable

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. Feel free to turn it all into REST to make the pain go away.


startLoggingRequests

boolean startLoggingRequests(String token)
Start logging http request urls.

Call finishLoggingRequests(String) to stop logging and to retrieve results.

Returns:
true

finishLoggingRequests

Vector<String> finishLoggingRequests(String token)
Finish logging http request and return any requests made.

Logging must have been previously started using startLoggingRequests(String).

Returns:
url of each request made

resetDatabaseStatistics

boolean resetDatabaseStatistics(String token)
Reset database statistics.

Call getDatabaseStatistics(String) to get results since the last reset.

Returns:
true

getDatabaseStatistics

String getDatabaseStatistics(String token)
Return database statistics.

Statistics since the last call to resetDatabaseStatistics(String) are returned.

Returns:
stabase statistics

runGarbageCollection

boolean runGarbageCollection(String token)

isImportTaskRunning

boolean isImportTaskRunning(String token)

getAnonyimizedClusterNodeIdentifier

String getAnonyimizedClusterNodeIdentifier(String token)

moveBlogPost

boolean moveBlogPost(String token,
                     String blogPostId,
                     String targetSpaceKey)

assertThatIndexQueueEntryHasBeenProcessed

boolean assertThatIndexQueueEntryHasBeenProcessed(String token,
                                                  String searchableClassname,
                                                  String searchableId)
                                                  throws RemoteException
Throws:
RemoteException


Copyright © 2003–2015 Atlassian. All rights reserved.