Class FuncTestRpcHandlerImpl
- java.lang.Object
-
- com.atlassian.confluence.test.rpc.FuncTestRpcHandlerImpl
-
- All Implemented Interfaces:
FuncTestRpcHandler
public class FuncTestRpcHandlerImpl extends Object implements FuncTestRpcHandler
-
-
Constructor Summary
Constructors Constructor Description FuncTestRpcHandlerImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanaddExistingProfilePicture(String token, String userName, String fileName)Attempts to add a existing profile picture to a user's profile.booleanaddGroupAnyCase(String token, String groupname)Allows addition of a group without enforcing that the name be all lower case.intaddLabelToLabelable(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.booleanaddMailServer(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.booleanaddSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)Add an SMTP mail server.booleanaddSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)booleanaddUserAnyCase(String token, String username, String email, String fullname, String password)Allows addition of a user without enforcing that the username be all lower case.booleanassertThatIndexQueueEntryHasBeenProcessed(String unusedToken, String searchableClassname, String searchableId)booleanchangeAttachmentCreatedDate(String token, String contentId, String attachmentFileName, Date createdDate)Change the created date of an attachmentbooleanchangeBlogPostModificationDate(String token, String blogId, Date modificationDate)Change the modification date of a blog postbooleanchangeCommentCreatedDate(String token, String commentId, Date createdDate)Change the created date of a commentStringchangeLoggerLevel(String token, String loggerName, String level)Deprecated.since 5.6.booleanchangePageCreatedDate(String token, String pageId, Date createdDate)Change the created date of a pagebooleanchangePageModificationDate(String token, String pageId, Date modificationDate)Change the modification date of a pagebooleanchangeSpaceCreatedDate(String token, String spaceKey, Date createdDate)Change the created date of a spacebooleanclearCustomHtml(String token)Clears the global custom html.booleanclearEventListeners(String token)Removes all temporary event listeners, regardless of their state.booleanclearHibernateConnectionProviderLastExceptionTime(String token)booleanclearIndex(String token)Blows away the main Confluence search index.booleanclearQueue(String token, String queueName)Removes all items from the specified queuebooleanclearRecordedLogMessages(String token)BooleanclearSystemProperty(String token, String name)Unset a system property.StringconvertMarkupToXhtml(String token, String wikiMarkup, String pageId)Render a page as XHTML.StringconvertXhtmlToMarkup(String token, String xhtml, String pageId)Convert XHTML to WikiMarkup.intcountDrafts(String token, String owner)HashtablecreateDraft(String token, Hashtable draftStruct)Creates a draft for the draft owner and draft type with the specified title and content.booleancreateJohnsonEvent(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.StringcreateTemplate(String token, String templateName, String content, String spaceKey)Create a new template.StringcreateTemplateWithStorageFormat(String token, String templateName, String storageFormat, String spaceKey)Create a new template from storage format code.intcreateTestUsers(String token, int count)Create test users with usernames "testuser0", "testuser1", etc.booleancreateUserMacro(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 MacrobooleandisablePlugin(String token, String pluginKey)Deprecated.since 5.6.booleandisablePluginModule(String token, String pluginKey, String moduleKey)Deprecated.since 5.6.booleandisablePluginWithoutPersisting(String token, String pluginKey)Deprecated.since 5.6.booleandisableSiteFeature(String token, String featureKey)Deprecated.since 5.6.booleandisableUserFeature(String token, String featureKey)Deprecated.since 5.6.booleandisconnectGroup(String token, String groupName)Disconnect a group from Confluence.booleandisconnectUser(String token, String userName)Disconnect a user from Confluence.booleandoesDraftExist(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.booleanenableCaptcha(String token, boolean enable)Sets the captcha modebooleanenableCaptchaDebugMode(String token, boolean enable)Sets the captcha mode into debug mode.booleanenableDailyReportNotification(String token, String userName, boolean dailyReportEnabled)Sets the Daily Report email for a user to enabled or disabled.booleanenableElevatedSecurityCheck(String token, boolean enabled)booleanenablePlugin(String token, String pluginKey)Deprecated.since 5.6.booleanenablePluginModule(String token, String pluginKey, String moduleKey)Deprecated.since 5.6.booleanenablePublicSignUp(String token, boolean enabled)Sets the public sign up enabled statusbooleanenableSiteFeature(String token, String featureKey)Deprecated.since 5.6.booleanenableUserFeature(String token, String featureKey)Deprecated.since 5.6.booleanenableWebSudo(String token, boolean enabled)Sets the web sudo enabled statusVector<String>finishLoggingRequests(String token)Finish logging http request and return any requests made.booleanflushAllCaches(String token)Deprecated.since 5.6.booleanfollowUser(String token, String userName, boolean follow)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.StringgetAnonyimizedClusterNodeIdentifier(String unusedToken)ObjectgetApplicationConfigProperty(String token, String propertyKey)Returns a property of the globalApplicationConfigurationinstance.ObjectgetBandanaValue(String token, String space, String key)Deprecated.since 5.6.IntegergetCacheMaximumNumberOfElements(String token, String cacheName)Deprecated.since 5.6.HashtablegetCacheStatistics(String token, String cacheName)Deprecated.since 5.6.Vector<String>getCacheStatisticsCapabilities(String token)Deprecated.since 5.6.StringgetConfiguredThemeForSpace(String token, String spaceKey)Deprecated.since 5.6.Hashtable<String,Object>getContentForAllLabels(String token, int offset, int maxResults, String labelsString)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.StringgetContentPropertiesString(String token, String entityId, String key)Get the string value of aContentPropertyassociated with a content entity given its id and the property nameStringgetContentPropertiesStringForSpace(String token, String spaceKey, String key)Get the string value of aContentPropertyassociated with theSpaceDescriptionof the spaceStringgetContentProperty(String token, String entityId, String key)Get the content property value for a content entity given its id and the property keyVectorgetContentPropertyKeys(String token, String entityId)Get the content property keys for a content entity given its idStringgetContentStringProperty(String token, String entityId, String key)Get the content property string value (in OS_PROPERTYENTRY) for a content entity given its id and property keyStringgetContentTextProperty(String token, String entityId, String key)Get the content property text value (in OS_PROPERTYENTRY) for a content entity given its id and property keyStringgetDatabaseStatistics(String token)Return database statistics.StringgetDateTimeFormat(String token)Get current DateTime formatStringgetExportBuildNumber(String token)Returns the backward-compatibility of an exportHashtable<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.StringgetGlobalConfiguredTheme(String token)Deprecated.since 5.6.String[]getGlobalPermissionsForGroup(String token, String groupName)Gets the global permissions that the given group has.StringgetIdOfPagePermission(String token, String contentId, String permissionType, String username)booleangetIgnoreBaseURLWarning(String token)Whether the warning message for an un-advisable value for the Base URL is ignored or not.StringgetLeastRecentTestAppenderLogMessage(String token, String className)StringgetLocaleForUser(String token, String username)Gets the locale preference for the user.StringgetLocalisedText(String token, String messageKey)Get the localised string for given the message key in the logged-in user's locale.Iterable<String>getNames(Iterable<? extends com.atlassian.user.User> iterable)intgetNumberOfActiveUsers(String token)Returns the number of active users, i.e.intgetNumberOfIndexTasksInQueue(String token)Returns the size of the index queue.StringgetOldestSpaceImportAllowed(String token)Returns the backwards-compatibility of a space importStringgetPersonalInformationId(String token, String username)Gets the personal information id for a given usernameStringgetPluginExportCompatibility(String token, String pluginKey)Returns the plugin compatibility matrix for exportsintgetQueueSize(String token, String queueName)Returns the size of the task queue with the specified name.Vector<String>getRecordedErrorLogMessages(String token)StringgetStackDump(String token, String threadNameRegex)Hashtable<String,String>getSystemProperty(String token, String name)Retrieve the value of a system property.VectorgetUsersForActivity(String key)Call getUsersForActivity on the heartbeatManager beanintgetVersionForPage(String token, String pageId)Get the version number for the page with pageIdbooleanincreaseHighValue(String token)Put a number bigger than 65535 in Hibernate_unique_key table to force generated ids to be greater than max integer.booleanisCurrentApplicationSet(String token)Check whether or not the trustedApplicationManager has its currentApplication set.booleanisImportTaskRunning(String token)booleanisPluginModuleEnabled(String token, String pluginKey, String moduleKey)Deprecated.since 5.6.booleanisPluginUpgradeTasksComplete(String token)Returns true if the plugin dependent upgrade tasksbooleanisSpringComponentPresent(String token, String name)Returns true if a Spring component with the given name exists in the application context.booleanisUnlimitedUserLicense(String token)booleanlogMessage(String token, String destination, String message)Deprecated.since 5.6.booleanlogTestMessageForClass(String token, String className, String message, String level)booleanmassCreateAttachments(String token, String pageId, String prefix, String numAttachments)Create a whole series of attachments on a single page.booleanmoveBlogPost(String token, String blogPostId, String targetSpaceKey)booleanputStringMappingInCache(String token, String cacheName, String key, String value)Deprecated.since 5.6.booleanregisterEventListener(String token, String eventClassName)Registers a temporary event listener on the server to listen for the specified event.booleanregisterTestAppenderForClass(String token, String className)booleanremoveAllJohnsonEvents(String token)Removes all Johnson events from ConfluencebooleanremoveAllSpaces(String token)Kill all the spaces and flush all the queues and caches.booleanremoveAllTrustedApplications(String token)Removes all trusted applications from the database.booleanremoveAttachmentUncleanly(String token, String contentId, String attachmentFileName)Removes an attachment without cleaning up associated attachment infobooleanremoveBandanaKey(String token, String space, String key)Deprecated.since 5.6.booleanremoveDrafts(String token, String username)Removes all drafts owned by the specified User.booleanremoveGroupUncleanly(String token, String groupname)Remove a Group without removing the things that refer to that group.booleanremoveMailServer(String token, String serverName)Remove the named mail server.booleanremovePersonalInformation(String token, String username)PersonalInformation gets created automatically by the standard create user methods.booleanremoveTestData(String token, Vector<String> usersToKeep, Vector<String> groupsToKeep, Hashtable<String,Vector<String>> userGroupMembershipsToKeep)Big Kahuna remove method.booleanremoveTestDataAfterExternalUserManagement(String token)Remove the dependencies of all users and groups, except the default dependencies of the default groups, the listed extra groups, the current user, and the listed extra users.intremoveTestUsers(String token, int count)Removes test users with usernames "testuser0", "testuser1", etc.booleanremoveUserDirectory(String token, String directoryId)Removes user directorybooleanremoveUserMacro(String token, String name)Remove a User Macro with the given name if it exists.booleanremoveUserUncleanly(String token, String username)Remove a User without removing the things that refer to that user.booleanresetDatabaseStatistics(String token)Reset database statistics.booleanresetWelcomeMessage(String token)booleanrestoreAbstractPage(String token, String abstractPageId)Restores an abstract page from the trash.booleanrunGarbageCollection(String token)booleansaveDateFormat(String token, String dateFormat)booleansaveDateTimeFormat(String token, String dateTimeFormat)voidsetAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)voidsetAnyTypeDao(EntityRemover entityRemover)voidsetApplicationConfig(com.atlassian.config.ApplicationConfiguration applicationConfiguration)booleansetApplicationConfigProperty(String token, String propertyKey, String propertyValue)Sets a property on the globalApplicationConfigurationinstance.voidsetAttachmentManager(AttachmentManager attachmentManager)booleansetBandanaKey(String token, String space, String key, String value)Deprecated.since 5.6.booleansetBandanaKeyBoolean(String token, String space, String key, boolean value)Deprecated.since 5.6.booleansetBandanaKeyInteger(String token, String space, String key, int value)Deprecated.since 5.6.voidsetBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)booleansetBandanaStringList(String token, String space, String key, Vector<String> value)Deprecated.since 5.6.booleansetBandanaStringSet(String token, String space, String key, Vector<String> value)Deprecated.since 5.6.booleansetBooleanUserPreference(String token, String userName, String preferenceKey, String value)Sets a boolean user preference.voidsetCacheConfigManager(CacheConfigManager cacheConfigManager)voidsetCacheManager(com.atlassian.cache.CacheManager cacheManager)booleansetCacheMaximumNumberOfElements(String token, String cacheName, int maxNumElements)Deprecated.since 5.6.voidsetCacheStatisticsManager(CacheStatisticsManager cacheStatisticsManager)voidsetCaptchaManager(CaptchaManager captchaManager)voidsetChangeSearchIndexAccessor(SearchIndexAccessor changeSearchIndexAccessor)voidsetClusterManager(ClusterManager clusterManager)voidsetCommentManager(CommentManager commentManager)voidsetConfluenceUserDao(ConfluenceUserDao confluenceUserDao)voidsetConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)voidsetConnectionProviderMonitor(ExceptionMonitor connectionProviderMonitor)voidsetContentEntityManager(ContentEntityManager contentEntityManager)voidsetContentPermissionManager(ContentPermissionManager contentPermissionManager)booleansetContentPropertiesString(String token, String entityId, String key, String value)Sets the string value of aContentPropertyassociated with a content entity given its id and the property namebooleansetContentPropertiesStringForSpace(String token, String spaceKey, String key, String value)Sets the string value of aContentPropertyassociated with theSpaceDescriptionof the spacevoidsetContentPropertyManager(ContentPropertyManager contentPropertyManager)voidsetContentSearchIndexAccessor(SearchIndexAccessor contentSearchIndexAccessor)booleansetContentStringProperty(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 valuebooleansetContentTextProperty(String token, String entityId, String key, String value)Sets a text content property for a content entity given its idvoidsetCrowdDirectoryService(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService)voidsetCustomContentManager(CustomContentManager customContentManager)voidsetDarkFeaturesManager(DarkFeaturesManager darkFeaturesManager)voidsetDbStatCollector(DbStatCollector dbStatCollector)booleansetDirectoryPasswordEncoder(String token, String directoryName, String encoder)Changes the password encoder for the given directoryvoidsetDraftManager(DraftManager draftManager)booleansetDraftSaveInterval(String token, int seconds)Sets the given draft save interval.booleansetEnableAnonymousRpc(String token, String value)Toggle the setting to allow/deny anonymous RPC calls.voidsetEntityRemover(EntityRemover entityRemover)voidsetEventLatchManager(EventLatchManager eventLatchManager)voidsetEventManager(com.atlassian.event.EventManager eventManager)voidsetEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)voidsetEventQueueFettlerBean(EventQueueFettler eventQueueFettler)voidsetFollowManager(FollowManager followManager)voidsetFormatConverter(FormatConverter formatConverter)booleansetGlobalLanguage(String token, String language)Changes to the default site languagebooleansetGlobalTheme(String token, String themeKey)Deprecated.since 5.6.voidsetGroupManager(com.atlassian.user.GroupManager groupManager)voidsetHeartbeatManager(HeartbeatManager heartbeatManager)voidsetHibernateConfig(com.atlassian.config.db.HibernateConfig hibernateConfig)booleansetHibernateConnectionProviderLastExceptionTime(String token, String timeStr)booleansetIgnoreBaseURLWarning(String token, boolean ignored)Affects whether the warning message for an un-advisable value for the Base URL is ignored or not.booleansetIndexingLanguage(String token, String language)Changes the indexing languagevoidsetIndexManager(IndexManager indexManager)voidsetJournalDao(JournalDao journalDao)voidsetJournalManager(JournalManagerBackdoor journalManagerBackdoor)voidsetJournalStateStore(JournalStateStore journalStateStore)booleansetKeyboardShortcutPref(String token, String username, String enabled)Enables/Disables keyboard shortcuts for the given uesrvoidsetLabelManager(LabelManager labelManager)booleansetLocaleForUser(String token, String username, String locale)Sets the locale preference for the user to the given named locale.voidsetLogMessageRecordingAppender(LogMessageRecordingAppender logMessageRecordingAppender)voidsetMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)booleansetNetworkNotificationForUser(String token, String userName, boolean watchNetwork)Sets Network watch emails for a user to enabled or disabled.voidsetNotificationManager(NotificationManager notificationManager)voidsetPageManager(PageManager pageManager)voidsetPageTemplateManager(PageTemplateManager pageTemplateManager)voidsetPermissionManager(PermissionManager permissionManager)voidsetPersonalInformationManager(PersonalInformationManager personalInformationManager)voidsetPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)voidsetPluginController(com.atlassian.plugin.PluginController pluginController)voidsetRequestLogger(RequestLogger requestLogger)voidsetSchedulerService(com.atlassian.scheduler.core.LifecycleAwareSchedulerService schedulerService)voidsetSessionFactory5(org.hibernate.SessionFactory sessionFactory5)voidsetSettingsManager(SettingsManager settingsManager)booleansetSiteBlogNotificationForUser(String token, String userName, boolean globalBlogWatchForUser)Sets Site Blog watch emails for a user to enabled or disabled.booleansetSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)Remove all existing SMTP servers and add the given server.booleansetSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)Remove all existing SMTP servers and add the given server.voidsetSpaceManager(SpaceManager spaceManager)voidsetSpacePermissionDefaultsStoreFactory(SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory)voidsetSpacePermissionManager(SpacePermissionManager spacePermissionManager)booleansetStringUserPreference(String token, String userName, String preferenceKey, String value)Sets a string user preference.BooleansetSystemProperty(String token, String name, String value)Set a system property on the server to the supplied value.voidsetTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)booleansetThemeForSpace(String token, String spaceKey, String themeKey)Deprecated.since 5.6.voidsetThemeManager(ThemeManager themeManager)voidsetTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)voidsetTrustedApplicationsManager(TrustedApplicationsManager trustedApplicationsManager)voidsetUpgradeGate(UpgradeGate upgradeGate)voidsetUpgradeManager(UpgradeManager upgradeManager)voidsetUserAccessor(UserAccessor userAccessor)voidsetUserChecker(UserChecker userChecker)booleansetUserDetailProperty(String token, String username, String propertyKey, String propertyValue)Sets a single UserDetails property through the UserDetailsManager.booleansetUserDetails(String token, String username, String fullName, String email)Sets the fullname and email address of a user with a given username.voidsetUserDetailsManager(UserDetailsManager userDetailsManager)booleansetUserFollows(String token, String followingUsername, Hashtable followUsers)Change the follow or unfollow state between a follower user and s a set of folowees usersvoidsetUserIndexingManager(UserIndexingManagerInternal userIndexingManager)voidsetUserMacroLibrary(UserMacroLibrary userMacroLibrary)voidsetUserManager(com.atlassian.user.UserManager userManager)booleansetWatchOwnContentPref(String token, String username, String enabled)Enables/Disables autowatching for the given uesrbooleansetWatchSpace(String token, String username, String spaceKey, String contentTypeStr, String enabled)Enables/Disables watching a space for the given user and content type.booleansetWatchSpaces(String token, String username, String contentTypeStr, Hashtable spaces)Enables/Disables watching spaces for the given user and content type.booleansetWebSudoTimeout(String token, int timeoutMinutes)Sets the web sudo timeout in minutesbooleansetWelcomeMessage(String token, String welcomeMessage)voidsetWelcomeMessageService(WelcomeMessageService welcomeMessageService)voidsetXhtmlRpcHandler(ConfluenceXmlRpcHandler confluenceXmlRpcHandler)booleanshutdownScheduler(String token)Deprecated.since 5.6.booleanstartActivity(String token, String key, String user)Call startActivity on the heartbeat manager beanbooleanstartLoggingRequests(String token)Start logging http request urls.booleanstopActivity(String token, String key, String user)Call stopActivity on the heartbeatManager beanHashtablestoreXhtmlPage(String token, Hashtable pageStruct)The Confluence remote API store page performs wiki to XHTML conversion on the page content.booleansynchroniseUserDirectories(String token)Synchronizes all remote user directories with the local database cachebooleanuninstallPlugin(String token, String pluginKey)Deprecated.since 5.6.booleanunregisterEventListener(String token, String eventClassName)Unregisters the temporary listener registered for the specified event.booleanunregisterTestAppenderForClass(String token, String className)HashtableupdateDraft(String token, Hashtable draftStruct)Updates a draft located using the draft owner and draft type.booleanupdateGlobalSettingBoolean(String token, String name, boolean value)Update aSettingsboolean field.StringupdateGlobalSettingString(String token, String name, String value)Update aSettingsString field.booleanwaitForEvent(String token, String eventClassName, String timeoutStr, String timeUnitStr)Waits for an event to occur and returns when it has finished.booleanwaitForEventQueue(String token, String timeoutStr, String timeUnitStr)Waits for all events in queue to be processed.
-
-
-
Method Detail
-
logMessage
@Deprecated public boolean logMessage(String token, String destination, String message)
Deprecated.since 5.6. Use a FuncTestAdminLoggingResource REST call.Description copied from interface:FuncTestRpcHandlerLog 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:
logMessagein interfaceFuncTestRpcHandler- Parameters:
token- The token idenfitying the user.destination- The destination of the message to be loggedmessage- The text message to be logged to the console- Returns:
- boolean True if the message is logged (ie destination is a valid level)
-
changeLoggerLevel
@Deprecated public String changeLoggerLevel(String token, String loggerName, String level) throws RemoteException
Deprecated.since 5.6. Use a FuncTestAdminLoggingResource REST call.Description copied from interface:FuncTestRpcHandlerChange the level of the specified logger.The level parameter can be one of:
- DEBUG
- INFO
- WARN
- ERROR
- FATAL
- Specified by:
changeLoggerLevelin interfaceFuncTestRpcHandler- Parameters:
token- the token identifying the user.loggerName- the full name of the logger e.g. com.atlassian.confluence.test.rpc.FuncTestRpcHandlerlevel- the level to change the logger to- Returns:
- the original level of the logger before changing.
- Throws:
RemoteException
-
createTemplate
public String createTemplate(String token, String templateName, String content, String spaceKey) throws RemoteException, XhtmlException
Description copied from interface:FuncTestRpcHandlerCreate a new template. If spaceKey is not defined, a global template will be created.- Specified by:
createTemplatein interfaceFuncTestRpcHandler- Returns:
- template id
- Throws:
RemoteExceptionXhtmlException
-
createTemplateWithStorageFormat
public String createTemplateWithStorageFormat(String token, String templateName, String storageFormat, String spaceKey) throws RemoteException, XhtmlException
Description copied from interface:FuncTestRpcHandlerCreate a new template from storage format code. If spaceKey is not defined, a global template will be created.- Specified by:
createTemplateWithStorageFormatin interfaceFuncTestRpcHandler- Returns:
- template id
- Throws:
RemoteExceptionXhtmlException
-
removeAllSpaces
public boolean removeAllSpaces(String token) throws RemoteException
Description copied from interface:FuncTestRpcHandlerKill all the spaces and flush all the queues and caches.- Specified by:
removeAllSpacesin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
removeTestData
public boolean removeTestData(String token, Vector<String> usersToKeep, Vector<String> groupsToKeep, Hashtable<String,Vector<String>> userGroupMembershipsToKeep) throws RemoteException
Description copied from interface:FuncTestRpcHandlerBig 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:
removeTestDatain interfaceFuncTestRpcHandler- Parameters:
token- the token identifying the user.usersToKeep- users like admin and sysadmin that should not be removedgroupsToKeep- groups like admins and users that should not be removeduserGroupMembershipsToKeep- a map where the keys are group names and the values are lists of usernames in the group- Throws:
NotPermittedExceptionRemoteException
-
removeTestDataAfterExternalUserManagement
public boolean removeTestDataAfterExternalUserManagement(String token) throws Exception
Remove the dependencies of all users and groups, except the default dependencies of the default groups, the listed extra groups, the current user, and the listed extra users. This also deletes all mail servers, as it is significantly faster to batch up RPC invocations. Note that all memberships of kept users in kept groups will also be kept.- Specified by:
removeTestDataAfterExternalUserManagementin interfaceFuncTestRpcHandler- Throws:
Exception
-
disconnectUser
public boolean disconnectUser(String token, String userName) throws NotPermittedException
Description copied from interface:FuncTestRpcHandlerDisconnect a user from Confluence. Removes all their permissions, group memberships, their profile information and their personal space.- Specified by:
disconnectUserin interfaceFuncTestRpcHandler- Throws:
NotPermittedException
-
disconnectGroup
public boolean disconnectGroup(String token, String groupName) throws NotPermittedException
Description copied from interface:FuncTestRpcHandlerDisconnect a group from Confluence. Removes all its permissions.- Specified by:
disconnectGroupin interfaceFuncTestRpcHandler- Throws:
NotPermittedException
-
getGlobalPermissionsForGroup
public String[] getGlobalPermissionsForGroup(String token, String groupName) throws RemoteException
Description copied from interface:FuncTestRpcHandlerGets the global permissions that the given group has.- Specified by:
getGlobalPermissionsForGroupin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
isCurrentApplicationSet
public boolean isCurrentApplicationSet(String token) throws NotPermittedException
Description copied from interface:FuncTestRpcHandlerCheck whether or not the trustedApplicationManager has its currentApplication set.- Specified by:
isCurrentApplicationSetin interfaceFuncTestRpcHandler- Throws:
NotPermittedException
-
removeAllTrustedApplications
public boolean removeAllTrustedApplications(String token)
Description copied from interface:FuncTestRpcHandlerRemoves all trusted applications from the database.- Specified by:
removeAllTrustedApplicationsin interfaceFuncTestRpcHandler
-
massCreateAttachments
public boolean massCreateAttachments(String token, String pageId, String prefix, String numAttachments) throws Exception
Description copied from interface:FuncTestRpcHandlerCreate a whole series of attachments on a single page.- Specified by:
massCreateAttachmentsin interfaceFuncTestRpcHandler- Throws:
Exception
-
getGlobalConfiguredTheme
@Deprecated public String getGlobalConfiguredTheme(String token) throws Exception
Deprecated.since 5.6. Use FuncTestAdminThemeResource.Description copied from interface:FuncTestRpcHandlerGet the key of the configured global theme, whether or not that theme exists.- Specified by:
getGlobalConfiguredThemein interfaceFuncTestRpcHandler- Throws:
Exception
-
getConfiguredThemeForSpace
@Deprecated public String getConfiguredThemeForSpace(String token, String spaceKey) throws Exception
Deprecated.since 5.6. Use FuncTestAdminThemeResource.Description copied from interface:FuncTestRpcHandlerGet the key of the configured theme for a space, whether or not that theme exists.- Specified by:
getConfiguredThemeForSpacein interfaceFuncTestRpcHandler- Throws:
Exception
-
setGlobalTheme
@Deprecated public boolean setGlobalTheme(String token, String themeKey) throws Exception
Deprecated.since 5.6. Use FuncTestAdminThemeResource.Description copied from interface:FuncTestRpcHandlerSets the global theme- Specified by:
setGlobalThemein interfaceFuncTestRpcHandlerthemeKey- - the complete theme key- Throws:
Exception
-
setThemeForSpace
@Deprecated public boolean setThemeForSpace(String token, String spaceKey, String themeKey) throws Exception
Deprecated.since 5.6. Use FuncTestAdminThemeResource.Description copied from interface:FuncTestRpcHandlerSets the theme for the specified space- Specified by:
setThemeForSpacein interfaceFuncTestRpcHandlerspaceKey- - the key of the space to changethemeKey- - the complete theme key- Throws:
Exception
-
clearCustomHtml
public boolean clearCustomHtml(String token) throws Exception
Description copied from interface:FuncTestRpcHandlerClears the global custom html.- Specified by:
clearCustomHtmlin interfaceFuncTestRpcHandler- Returns:
- true always.
- Throws:
Exception
-
uninstallPlugin
@Deprecated public boolean uninstallPlugin(String token, String pluginKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerUninstall a plugin. (There's an install method in the standard rpc plugin)- Specified by:
uninstallPluginin interfaceFuncTestRpcHandler- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
disablePlugin
@Deprecated public boolean disablePlugin(String token, String pluginKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerDisable a plugin.- Specified by:
disablePluginin interfaceFuncTestRpcHandler- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
disablePluginWithoutPersisting
@Deprecated public boolean disablePluginWithoutPersisting(String token, String pluginKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerDisable a plugin without persisting.- Specified by:
disablePluginWithoutPersistingin interfaceFuncTestRpcHandler- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
enablePlugin
@Deprecated public boolean enablePlugin(String token, String pluginKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerEnable a plugin.- Specified by:
enablePluginin interfaceFuncTestRpcHandler- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
enablePluginModule
@Deprecated public boolean enablePluginModule(String token, String pluginKey, String moduleKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerEnable plugin module- Specified by:
enablePluginModulein interfaceFuncTestRpcHandlerpluginKey- the key of the pluginmoduleKey- the key of the module- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
disablePluginModule
@Deprecated public boolean disablePluginModule(String token, String pluginKey, String moduleKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerDisable plugin module- Specified by:
disablePluginModulein interfaceFuncTestRpcHandlerpluginKey- the key of the pluginmoduleKey- the key of the module- Returns:
- true because a return type is required by XMLRPC
- Throws:
NotPermittedException
-
isPluginModuleEnabled
@Deprecated public boolean isPluginModuleEnabled(String token, String pluginKey, String moduleKey) throws NotPermittedException
Deprecated.since 5.6. Use PluginsRpc in test client code.Description copied from interface:FuncTestRpcHandlerFind 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:
isPluginModuleEnabledin interfaceFuncTestRpcHandlerpluginKey- the key of the pluginmoduleKey- the key of the module excluding the plugin key- Returns:
- true if the plugin module exists and is enabled, false otherwise
- Throws:
NotPermittedException
-
isSpringComponentPresent
public boolean isSpringComponentPresent(String token, String name)
Description copied from interface:FuncTestRpcHandlerReturns true if a Spring component with the given name exists in the application context.- Specified by:
isSpringComponentPresentin interfaceFuncTestRpcHandler
-
isPluginUpgradeTasksComplete
public boolean isPluginUpgradeTasksComplete(String token)
Description copied from interface:FuncTestRpcHandlerReturns true if the plugin dependent upgrade tasks- Specified by:
isPluginUpgradeTasksCompletein interfaceFuncTestRpcHandler
-
registerEventListener
public boolean registerEventListener(String token, String eventClassName) throws Exception
Description copied from interface:FuncTestRpcHandlerRegisters a temporary event listener on the server to listen for the specified event. It is recommended that clients also unregister the event listener usingFuncTestRpcHandler.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:
registerEventListenerin interfaceFuncTestRpcHandler- Throws:
Exception
-
unregisterEventListener
public boolean unregisterEventListener(String token, String eventClassName) throws Exception
Description copied from interface:FuncTestRpcHandlerUnregisters the temporary listener registered for the specified event.- Specified by:
unregisterEventListenerin interfaceFuncTestRpcHandler- Throws:
Exception
-
clearEventListeners
public boolean clearEventListeners(String token) throws Exception
Description copied from interface:FuncTestRpcHandlerRemoves all temporary event listeners, regardless of their state.- Specified by:
clearEventListenersin interfaceFuncTestRpcHandler- Returns:
- true because some result is required.
- Throws:
Exception
-
waitForEvent
public boolean waitForEvent(String token, String eventClassName, String timeoutStr, String timeUnitStr) throws Exception
Description copied from interface:FuncTestRpcHandlerWaits for an event to occur and returns when it has finished.- Specified by:
waitForEventin interfaceFuncTestRpcHandlereventClassName- the fully qualified classname of the event to wait for.timeoutStr- number of milliseconds to wait for the event before giving up completely.timeUnitStr- SeeTimeUnit.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:FuncTestRpcHandlerWaits for all events in queue to be processed.- Specified by:
waitForEventQueuein interfaceFuncTestRpcHandler- Returns:
- true if queue was exhausted, false on timeout or any error.
- Throws:
Exception
-
shutdownScheduler
@Deprecated public boolean shutdownScheduler(String token) throws com.atlassian.scheduler.SchedulerServiceException
Deprecated.since 5.6. Use FuncTestAdminSchedulerResource.Description copied from interface:FuncTestRpcHandlerShutdown the scheduler to ensure single threadedness for testing- Specified by:
shutdownSchedulerin interfaceFuncTestRpcHandler- Throws:
com.atlassian.scheduler.SchedulerServiceException
-
removeBandanaKey
@Deprecated public boolean removeBandanaKey(String token, String space, String key)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerRemove a key from Bandana- Specified by:
removeBandanaKeyin interfaceFuncTestRpcHandler
-
setBandanaStringSet
@Deprecated public boolean setBandanaStringSet(String token, String space, String key, Vector<String> value)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerSets a key in Bandana with a Set of Strings as value- Specified by:
setBandanaStringSetin interfaceFuncTestRpcHandler
-
setBandanaStringList
@Deprecated public boolean setBandanaStringList(String token, String space, String key, Vector<String> value)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerSets a key in Bandana with a List of Strings as value- Specified by:
setBandanaStringListin interfaceFuncTestRpcHandler
-
setBandanaKey
@Deprecated public boolean setBandanaKey(String token, String space, String key, String value)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerSets a key in Bandana- Specified by:
setBandanaKeyin interfaceFuncTestRpcHandler
-
setBandanaKeyBoolean
@Deprecated public boolean setBandanaKeyBoolean(String token, String space, String key, boolean value)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerSets a key in Bandana- Specified by:
setBandanaKeyBooleanin interfaceFuncTestRpcHandler
-
setBandanaKeyInteger
@Deprecated public boolean setBandanaKeyInteger(String token, String space, String key, int value)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerSets a key in Bandana- Specified by:
setBandanaKeyIntegerin interfaceFuncTestRpcHandler
-
getBandanaValue
@Deprecated public Object getBandanaValue(String token, String space, String key)
Deprecated.since 5.6. Use FuncTestAdminBandanaResource.Description copied from interface:FuncTestRpcHandlerGets a value from Bandana- Specified by:
getBandanaValuein interfaceFuncTestRpcHandler
-
getContentPropertyKeys
public Vector getContentPropertyKeys(String token, String entityId)
Description copied from interface:FuncTestRpcHandlerGet the content property keys for a content entity given its id- Specified by:
getContentPropertyKeysin interfaceFuncTestRpcHandler
-
getContentProperty
public String getContentProperty(String token, String entityId, String key)
Description copied from interface:FuncTestRpcHandlerGet the content property value for a content entity given its id and the property key- Specified by:
getContentPropertyin interfaceFuncTestRpcHandler
-
getContentTextProperty
public String getContentTextProperty(String token, String entityId, String key)
Description copied from interface:FuncTestRpcHandlerGet the content property text value (in OS_PROPERTYENTRY) for a content entity given its id and property key- Specified by:
getContentTextPropertyin interfaceFuncTestRpcHandlerentityId- the ID of the content object this property is stored againstkey- 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:FuncTestRpcHandlerGet the content property string value (in OS_PROPERTYENTRY) for a content entity given its id and property key- Specified by:
getContentStringPropertyin interfaceFuncTestRpcHandlerentityId- the ID of the content object this property is stored againstkey- 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:FuncTestRpcHandlerGet the string value of aContentPropertyassociated with a content entity given its id and the property name- Specified by:
getContentPropertiesStringin interfaceFuncTestRpcHandler
-
getContentPropertiesStringForSpace
public String getContentPropertiesStringForSpace(String token, String spaceKey, String key)
Description copied from interface:FuncTestRpcHandlerGet the string value of aContentPropertyassociated with theSpaceDescriptionof the space- Specified by:
getContentPropertiesStringForSpacein interfaceFuncTestRpcHandler
-
setContentTextProperty
public boolean setContentTextProperty(String token, String entityId, String key, String value)
Description copied from interface:FuncTestRpcHandlerSets a text content property for a content entity given its id- Specified by:
setContentTextPropertyin interfaceFuncTestRpcHandler
-
setContentStringProperty
public boolean setContentStringProperty(String token, String entityId, String key, String value)
Description copied from interface:FuncTestRpcHandlerSet the content property string value (in OS_PROPERTYENTRY) for a content entity given its id, property key and value- Specified by:
setContentStringPropertyin interfaceFuncTestRpcHandlerentityId- the ID of the content object this property is stored againstkey- the entity key of the property being storedvalue- the string value of the property to set
-
setContentPropertiesString
public boolean setContentPropertiesString(String token, String entityId, String key, String value)
Description copied from interface:FuncTestRpcHandlerSets the string value of aContentPropertyassociated with a content entity given its id and the property name- Specified by:
setContentPropertiesStringin interfaceFuncTestRpcHandler
-
setContentPropertiesStringForSpace
public boolean setContentPropertiesStringForSpace(String token, String spaceKey, String key, String value)
Description copied from interface:FuncTestRpcHandlerSets the string value of aContentPropertyassociated with theSpaceDescriptionof the space- Specified by:
setContentPropertiesStringForSpacein interfaceFuncTestRpcHandler
-
getPersonalInformationId
public String getPersonalInformationId(String token, String username)
Description copied from interface:FuncTestRpcHandlerGets the personal information id for a given username- Specified by:
getPersonalInformationIdin interfaceFuncTestRpcHandler
-
removePersonalInformation
public boolean removePersonalInformation(String token, String username) throws NotPermittedException
Description copied from interface:FuncTestRpcHandlerPersonalInformation 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:
removePersonalInformationin interfaceFuncTestRpcHandlerusername- 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:FuncTestRpcHandlerGets the locale preference for the user.- Specified by:
getLocaleForUserin interfaceFuncTestRpcHandler
-
setLocaleForUser
public boolean setLocaleForUser(String token, String username, String locale) throws RemoteException
Description copied from interface:FuncTestRpcHandlerSets the locale preference for the user to the given named locale.- Specified by:
setLocaleForUserin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setGlobalLanguage
public boolean setGlobalLanguage(String token, String language) throws RemoteException
Description copied from interface:FuncTestRpcHandlerChanges to the default site language- Specified by:
setGlobalLanguagein interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setIndexingLanguage
public boolean setIndexingLanguage(String token, String language)
Description copied from interface:FuncTestRpcHandlerChanges the indexing language- Specified by:
setIndexingLanguagein interfaceFuncTestRpcHandler
-
setKeyboardShortcutPref
public boolean setKeyboardShortcutPref(String token, String username, String enabled) throws RemoteException
Description copied from interface:FuncTestRpcHandlerEnables/Disables keyboard shortcuts for the given uesr- Specified by:
setKeyboardShortcutPrefin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setWatchOwnContentPref
public boolean setWatchOwnContentPref(String token, String username, String enabled) throws RemoteException
Description copied from interface:FuncTestRpcHandlerEnables/Disables autowatching for the given uesr- Specified by:
setWatchOwnContentPrefin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setWatchSpaces
public boolean setWatchSpaces(String token, String username, String contentTypeStr, Hashtable spaces) throws RemoteException
Description copied from interface:FuncTestRpcHandlerEnables/Disables watching spaces for the given user and content type.- Specified by:
setWatchSpacesin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setWatchSpace
public boolean setWatchSpace(String token, String username, String spaceKey, String contentTypeStr, String enabled) throws RemoteException
Description copied from interface:FuncTestRpcHandlerEnables/Disables watching a space for the given user and content type.- Specified by:
setWatchSpacein interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setUserDetails
public boolean setUserDetails(String token, String username, String fullName, String email) throws NotPermittedException
Description copied from interface:FuncTestRpcHandlerSets the fullname and email address of a user with a given username.- Specified by:
setUserDetailsin interfaceFuncTestRpcHandler- Returns:
- true because XMLRPC methods have to return something
- Throws:
NotPermittedException
-
setUserDetailProperty
public boolean setUserDetailProperty(String token, String username, String propertyKey, String propertyValue)
Description copied from interface:FuncTestRpcHandlerSets a single UserDetails property through the UserDetailsManager.- Specified by:
setUserDetailPropertyin interfaceFuncTestRpcHandler- Returns:
- true because XMLRPC methods have to return something
-
putStringMappingInCache
@Deprecated public boolean putStringMappingInCache(String token, String cacheName, String key, String value) throws NotPermittedException
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandlerMap 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:
putStringMappingInCachein interfaceFuncTestRpcHandler- Returns:
- true because void is not allowed.
- Throws:
NotPermittedException
-
getCacheStatistics
@Deprecated public Hashtable getCacheStatistics(String token, String cacheName) throws NotPermittedException
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandlerReturns the cache statistics for a particular named cache.- Specified by:
getCacheStatisticsin interfaceFuncTestRpcHandlercacheName- the key of the cache, rather than the "niceName"- Returns:
- A hashtable representing the cache statistics
- Throws:
NotPermittedException
-
getCacheStatisticsCapabilities
@Deprecated public Vector<String> getCacheStatisticsCapabilities(String token) throws NotPermittedException
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandlerReturns the capabiltiies exposed by the cache statics service.- Specified by:
getCacheStatisticsCapabilitiesin interfaceFuncTestRpcHandler- Throws:
NotPermittedException
-
getCacheMaximumNumberOfElements
@Deprecated public Integer getCacheMaximumNumberOfElements(String token, String cacheName) throws Exception
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandlerReturns the configured maximum number of elements in the given cache- Specified by:
getCacheMaximumNumberOfElementsin interfaceFuncTestRpcHandlercacheName- the key of the cache, rather than the "niceName"- Throws:
Exception
-
setCacheMaximumNumberOfElements
@Deprecated public boolean setCacheMaximumNumberOfElements(String token, String cacheName, int maxNumElements) throws Exception
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandler(Re)configures the maximum number of elements in the given cache- Specified by:
setCacheMaximumNumberOfElementsin interfaceFuncTestRpcHandlercacheName- the key of the cache, rather than the "niceName"- Throws:
Exception
-
flushAllCaches
@Deprecated public boolean flushAllCaches(String token) throws NotPermittedException
Deprecated.since 5.6. Use FuncTestAdminCacheResource.Description copied from interface:FuncTestRpcHandlerFlushes all the caches.- Specified by:
flushAllCachesin interfaceFuncTestRpcHandler- Returns:
- true because void isn't allowed.
- Throws:
NotPermittedException
-
enableWebSudo
public boolean enableWebSudo(String token, boolean enabled) throws Exception
Description copied from interface:FuncTestRpcHandlerSets the web sudo enabled status- Specified by:
enableWebSudoin interfaceFuncTestRpcHandler- Returns:
- true because void isn't allowed.
- Throws:
Exception
-
setWebSudoTimeout
public boolean setWebSudoTimeout(String token, int timeoutMinutes) throws Exception
Description copied from interface:FuncTestRpcHandlerSets the web sudo timeout in minutes- Specified by:
setWebSudoTimeoutin interfaceFuncTestRpcHandler- Returns:
- true because void isn't allowed.
- Throws:
Exception
-
enableElevatedSecurityCheck
public boolean enableElevatedSecurityCheck(String token, boolean enabled) throws Exception
- Specified by:
enableElevatedSecurityCheckin interfaceFuncTestRpcHandler- Throws:
Exception
-
enablePublicSignUp
public boolean enablePublicSignUp(String token, boolean enabled) throws Exception
Description copied from interface:FuncTestRpcHandlerSets the public sign up enabled status- Specified by:
enablePublicSignUpin interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerCall startActivity on the heartbeat manager bean- Specified by:
startActivityin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokenkey- the activity key to startuser- 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:FuncTestRpcHandlerCall stopActivity on the heartbeatManager bean- Specified by:
stopActivityin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokenkey- the activity key to stopuser- the username of the user stopping the activity- Throws:
Exception
-
getUsersForActivity
public Vector getUsersForActivity(String key) throws Exception
Description copied from interface:FuncTestRpcHandlerCall getUsersForActivity on the heartbeatManager bean- Specified by:
getUsersForActivityin interfaceFuncTestRpcHandler- Throws:
Exception
-
removeUserUncleanly
public boolean removeUserUncleanly(String token, String username) throws com.atlassian.user.EntityException
Description copied from interface:FuncTestRpcHandlerRemove a User without removing the things that refer to that user.- Specified by:
removeUserUncleanlyin interfaceFuncTestRpcHandler- Throws:
com.atlassian.user.EntityException
-
removeGroupUncleanly
public boolean removeGroupUncleanly(String token, String groupname) throws com.atlassian.user.EntityException
Description copied from interface:FuncTestRpcHandlerRemove a Group without removing the things that refer to that group.- Specified by:
removeGroupUncleanlyin interfaceFuncTestRpcHandler- Throws:
com.atlassian.user.EntityException
-
doesDraftExist
public boolean doesDraftExist(String token, String contentId, String owner, String draftType, String spaceKey)
Description copied from interface:FuncTestRpcHandlerDetermines if a draft of the specified type and belonging to the specified owner exists.- Specified by:
doesDraftExistin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokencontentId- id of the content this draft is for ('0' for new content)owner- owner/author of the draftdraftType- type of content this draft is forspaceKey- 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:
countDraftsin interfaceFuncTestRpcHandler
-
createDraft
public Hashtable createDraft(String token, Hashtable draftStruct)
Description copied from interface:FuncTestRpcHandlerCreates 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:
createDraftin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokendraftStruct- 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()orPage.getType()."title"- title of the draft."content"- content of the draft as aStringin 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 draftStruct)
Description copied from interface:FuncTestRpcHandlerUpdates a draft located using the draft owner and draft type. Draft is then updated with the specified title and content- Specified by:
updateDraftin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokendraftStruct- 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:FuncTestRpcHandlerRemoves all drafts owned by the specified User.- Specified by:
removeDraftsin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokenusername- 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:FuncTestRpcHandlerSets the given draft save interval.- Specified by:
setDraftSaveIntervalin interfaceFuncTestRpcHandler- Parameters:
token- rpc authentication tokenseconds- 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:FuncTestRpcHandlerRemoves all items from the specified queue- Specified by:
clearQueuein interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerReturns the size of the task queue with the specified name.- Specified by:
getQueueSizein interfaceFuncTestRpcHandler- Returns:
- the size of the task queue with the specified name.
- Throws:
IllegalArgumentException- if no queue could be found with the specified queueName.
-
getNumberOfIndexTasksInQueue
public int getNumberOfIndexTasksInQueue(String token)
Description copied from interface:FuncTestRpcHandlerReturns the size of the index queue.- Specified by:
getNumberOfIndexTasksInQueuein interfaceFuncTestRpcHandler- Returns:
-
removeMailServer
public boolean removeMailServer(String token, String serverName) throws Exception
Description copied from interface:FuncTestRpcHandlerRemove the named mail server.- Specified by:
removeMailServerin interfaceFuncTestRpcHandler- Parameters:
token- the rpc authentication tokenserverName- 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
-
addUserAnyCase
public boolean addUserAnyCase(String token, String username, String email, String fullname, String password) throws RemoteException
Description copied from interface:FuncTestRpcHandlerAllows 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:
addUserAnyCasein interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerAllows 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:
addGroupAnyCasein interfaceFuncTestRpcHandlergroupname- 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:FuncTestRpcHandlerChange the created date of a space- Specified by:
changeSpaceCreatedDatein interfaceFuncTestRpcHandlerspaceKey- 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:FuncTestRpcHandlerChange the created date of a comment- Specified by:
changeCommentCreatedDatein interfaceFuncTestRpcHandler- Throws:
RemoteException
-
changePageCreatedDate
public boolean changePageCreatedDate(String token, String pageId, Date createdDate) throws RemoteException
Description copied from interface:FuncTestRpcHandlerChange the created date of a page- Specified by:
changePageCreatedDatein interfaceFuncTestRpcHandlerpageId- 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:FuncTestRpcHandlerRemoves an attachment without cleaning up associated attachment info- Specified by:
removeAttachmentUncleanlyin interfaceFuncTestRpcHandler- Parameters:
token- the authenticationcontentId- the content that the attachment is attached toattachmentFileName- the attachment- Returns:
- true
- Throws:
RemoteException
-
changeAttachmentCreatedDate
public boolean changeAttachmentCreatedDate(String token, String contentId, String attachmentFileName, Date createdDate) throws RemoteException
Description copied from interface:FuncTestRpcHandlerChange the created date of an attachment- Specified by:
changeAttachmentCreatedDatein interfaceFuncTestRpcHandlercontentId- the id of the page or blogpost the attachment is attached toattachmentFileName- 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:FuncTestRpcHandlerChange the modification date of a blog post- Specified by:
changeBlogPostModificationDatein interfaceFuncTestRpcHandlerblogId- the id of the blog to modifymodificationDate- 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:FuncTestRpcHandlerChange the modification date of a page- Specified by:
changePageModificationDatein interfaceFuncTestRpcHandlerpageId- the page id of the page to change the modification datemodificationDate- the last modification date to be set.- Throws:
RemoteException
-
getVersionForPage
public int getVersionForPage(String token, String pageId) throws RemoteException
Description copied from interface:FuncTestRpcHandlerGet the version number for the page with pageId- Specified by:
getVersionForPagein interfaceFuncTestRpcHandler- Throws:
RemoteException
-
getLeastRecentTestAppenderLogMessage
public String getLeastRecentTestAppenderLogMessage(String token, String className)
- Specified by:
getLeastRecentTestAppenderLogMessagein interfaceFuncTestRpcHandler
-
registerTestAppenderForClass
public boolean registerTestAppenderForClass(String token, String className)
- Specified by:
registerTestAppenderForClassin interfaceFuncTestRpcHandler
-
unregisterTestAppenderForClass
public boolean unregisterTestAppenderForClass(String token, String className)
- Specified by:
unregisterTestAppenderForClassin interfaceFuncTestRpcHandler
-
logTestMessageForClass
public boolean logTestMessageForClass(String token, String className, String message, String level)
- Specified by:
logTestMessageForClassin interfaceFuncTestRpcHandler
-
setUserFollows
public boolean setUserFollows(String token, String followingUsername, Hashtable followUsers) throws RemoteException
Description copied from interface:FuncTestRpcHandlerChange the follow or unfollow state between a follower user and s a set of folowees users- Specified by:
setUserFollowsin interfaceFuncTestRpcHandlerfollowingUsername- The username of the user that is doing the followingfollowUsers- 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 follow) throws RemoteException
Description copied from interface:FuncTestRpcHandlerFollows or stops following a user. Can be done by any user, not just admins.- Specified by:
followUserin interfaceFuncTestRpcHandlerfollow- true to follow a user, false to stop following- Throws:
RemoteException
-
synchroniseUserDirectories
public boolean synchroniseUserDirectories(String token) throws Exception
Description copied from interface:FuncTestRpcHandlerSynchronizes all remote user directories with the local database cache- Specified by:
synchroniseUserDirectoriesin interfaceFuncTestRpcHandler- Returns:
- true
- Throws:
Exception
-
setDirectoryPasswordEncoder
public boolean setDirectoryPasswordEncoder(String token, String directoryName, String encoder) throws Exception
Description copied from interface:FuncTestRpcHandlerChanges the password encoder for the given directory- Specified by:
setDirectoryPasswordEncoderin interfaceFuncTestRpcHandler- Returns:
- true
- Throws:
Exception
-
removeUserDirectory
public boolean removeUserDirectory(String token, String directoryId) throws Exception
Description copied from interface:FuncTestRpcHandlerRemoves user directory- Specified by:
removeUserDirectoryin interfaceFuncTestRpcHandlerdirectoryId- the id of the directory- Returns:
- true if the directory existed and was removed
- Throws:
Exception
-
convertMarkupToXhtml
public String convertMarkupToXhtml(String token, String wikiMarkup, String pageId)
Description copied from interface:FuncTestRpcHandlerRender a page as XHTML.- Specified by:
convertMarkupToXhtmlin interfaceFuncTestRpcHandler
-
convertXhtmlToMarkup
public String convertXhtmlToMarkup(String token, String xhtml, String pageId)
Description copied from interface:FuncTestRpcHandlerConvert XHTML to WikiMarkup.- Specified by:
convertXhtmlToMarkupin interfaceFuncTestRpcHandler
-
getLocalisedText
public String getLocalisedText(String token, String messageKey)
Description copied from interface:FuncTestRpcHandlerGet the localised string for given the message key in the logged-in user's locale.- Specified by:
getLocalisedTextin interfaceFuncTestRpcHandler- Parameters:
token- the rpc authentication tokenmessageKey- 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.
-
setIndexManager
public void setIndexManager(IndexManager indexManager)
-
setJournalManager
public void setJournalManager(JournalManagerBackdoor journalManagerBackdoor)
-
setJournalDao
public void setJournalDao(JournalDao journalDao)
-
setJournalStateStore
public void setJournalStateStore(JournalStateStore journalStateStore)
-
setSpaceManager
public void setSpaceManager(SpaceManager spaceManager)
-
setPermissionManager
public void setPermissionManager(PermissionManager permissionManager)
-
setUserAccessor
public void setUserAccessor(UserAccessor userAccessor)
-
setConfluenceUserDao
public void setConfluenceUserDao(ConfluenceUserDao confluenceUserDao)
-
setAttachmentManager
public void setAttachmentManager(AttachmentManager attachmentManager)
-
setLogMessageRecordingAppender
public void setLogMessageRecordingAppender(LogMessageRecordingAppender logMessageRecordingAppender)
-
setClusterManager
public void setClusterManager(ClusterManager clusterManager)
-
setPageManager
public void setPageManager(PageManager pageManager)
-
setThemeManager
public void setThemeManager(ThemeManager themeManager)
-
setCaptchaManager
public void setCaptchaManager(CaptchaManager captchaManager)
-
setSchedulerService
public void setSchedulerService(com.atlassian.scheduler.core.LifecycleAwareSchedulerService schedulerService)
-
setBandanaManager
public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
-
setContentPropertyManager
public void setContentPropertyManager(ContentPropertyManager contentPropertyManager)
-
setContentEntityManager
public void setContentEntityManager(ContentEntityManager contentEntityManager)
-
setCustomContentManager
public void setCustomContentManager(CustomContentManager customContentManager)
-
setPersonalInformationManager
public void setPersonalInformationManager(PersonalInformationManager personalInformationManager)
-
setUserIndexingManager
public void setUserIndexingManager(UserIndexingManagerInternal userIndexingManager)
-
setCacheManager
public void setCacheManager(com.atlassian.cache.CacheManager cacheManager)
-
setCacheConfigManager
public void setCacheConfigManager(CacheConfigManager cacheConfigManager)
-
setConnectionProviderMonitor
public void setConnectionProviderMonitor(ExceptionMonitor connectionProviderMonitor)
-
setCacheStatisticsManager
public void setCacheStatisticsManager(CacheStatisticsManager cacheStatisticsManager)
-
setHeartbeatManager
public void setHeartbeatManager(HeartbeatManager heartbeatManager)
-
setSettingsManager
public void setSettingsManager(SettingsManager settingsManager)
-
setUserManager
public void setUserManager(com.atlassian.user.UserManager userManager)
-
setGroupManager
public void setGroupManager(com.atlassian.user.GroupManager groupManager)
-
setDraftManager
public void setDraftManager(DraftManager draftManager)
-
setTaskManager
public void setTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)
-
setMailServerManager
public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
-
setEventManager
public void setEventManager(com.atlassian.event.EventManager eventManager)
-
setEventPublisher
public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
-
setEventQueueFettlerBean
public void setEventQueueFettlerBean(EventQueueFettler eventQueueFettler)
-
setCrowdDirectoryService
public void setCrowdDirectoryService(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService)
-
setFollowManager
public void setFollowManager(FollowManager followManager)
-
setNotificationManager
public void setNotificationManager(NotificationManager notificationManager)
-
setSpacePermissionManager
public void setSpacePermissionManager(SpacePermissionManager spacePermissionManager)
-
setSpacePermissionDefaultsStoreFactory
public void setSpacePermissionDefaultsStoreFactory(SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory)
-
setUserDetailsManager
public void setUserDetailsManager(UserDetailsManager userDetailsManager)
-
setTrustedApplicationsManager
public void setTrustedApplicationsManager(TrustedApplicationsManager trustedApplicationsManager)
-
setCommentManager
public void setCommentManager(CommentManager commentManager)
-
setConfluenceWysiwygConverter
public void setConfluenceWysiwygConverter(ConfluenceWysiwygConverter wysiwygConverter)
-
setContentPermissionManager
public void setContentPermissionManager(ContentPermissionManager contentPermissionManager)
-
setAnonymousUserPermissionsService
public void setAnonymousUserPermissionsService(AnonymousUserPermissionsService anonymousUserPermissionsService)
-
setUpgradeManager
public void setUpgradeManager(UpgradeManager upgradeManager)
-
setLabelManager
public void setLabelManager(LabelManager labelManager)
-
setRequestLogger
public void setRequestLogger(RequestLogger requestLogger)
-
setDbStatCollector
public void setDbStatCollector(DbStatCollector dbStatCollector)
-
setSessionFactory5
public void setSessionFactory5(org.hibernate.SessionFactory sessionFactory5)
-
saveDateFormat
public boolean saveDateFormat(String token, String dateFormat)
- Specified by:
saveDateFormatin interfaceFuncTestRpcHandler
-
saveDateTimeFormat
public boolean saveDateTimeFormat(String token, String dateTimeFormat)
- Specified by:
saveDateTimeFormatin interfaceFuncTestRpcHandler
-
getDateTimeFormat
public String getDateTimeFormat(String token)
Description copied from interface:FuncTestRpcHandlerGet current DateTime format- Specified by:
getDateTimeFormatin interfaceFuncTestRpcHandler
-
addSmtpServer
public boolean addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)
Description copied from interface:FuncTestRpcHandlerAdd an SMTP mail server.- Specified by:
addSmtpServerin interfaceFuncTestRpcHandler
-
addSmtpServer
public boolean addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)
- Specified by:
addSmtpServerin interfaceFuncTestRpcHandler
-
setSmtpServer
public boolean setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)
Description copied from interface:FuncTestRpcHandlerRemove all existing SMTP servers and add the given server.- Specified by:
setSmtpServerin interfaceFuncTestRpcHandler
-
setSmtpServer
public boolean setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)
Description copied from interface:FuncTestRpcHandlerRemove all existing SMTP servers and add the given server.- Specified by:
setSmtpServerin interfaceFuncTestRpcHandler
-
addMailServer
public boolean addMailServer(String token, String serverName, String protocol, String hostname, int port, String username, String password, String toAddress)
Description copied from interface:FuncTestRpcHandlerAdd a POP server to poll for emails in a particular account. The account's associated email address must also be passed.- Specified by:
addMailServerin interfaceFuncTestRpcHandler
-
removeAllJohnsonEvents
public boolean removeAllJohnsonEvents(String token)
Description copied from interface:FuncTestRpcHandlerRemoves all Johnson events from Confluence- Specified by:
removeAllJohnsonEventsin interfaceFuncTestRpcHandler
-
createJohnsonEvent
public boolean createJohnsonEvent(String token, String message)
Description copied from interface:FuncTestRpcHandlerCreates a Johnson event inside Confluence. This method is used to test theConfluenceJohnsonFilter.- Specified by:
createJohnsonEventin interfaceFuncTestRpcHandlermessage- the description of the event to create
-
enableCaptcha
public boolean enableCaptcha(String token, boolean enable)
Description copied from interface:FuncTestRpcHandlerSets the captcha mode- Specified by:
enableCaptchain interfaceFuncTestRpcHandler
-
enableCaptchaDebugMode
public boolean enableCaptchaDebugMode(String token, boolean enable)
Description copied from interface:FuncTestRpcHandlerSets the captcha mode into debug mode. SeeCaptchaManager.setDebugMode(boolean).- Specified by:
enableCaptchaDebugModein interfaceFuncTestRpcHandler
-
getSystemProperty
public Hashtable<String,String> getSystemProperty(String token, String name)
Description copied from interface:FuncTestRpcHandlerRetrieve 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:
getSystemPropertyin interfaceFuncTestRpcHandlername- 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:FuncTestRpcHandlerSet a system property on the server to the supplied value.- Specified by:
setSystemPropertyin interfaceFuncTestRpcHandlername- the name of the propertyvalue- 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:FuncTestRpcHandlerUnset a system property.- Specified by:
clearSystemPropertyin interfaceFuncTestRpcHandlername- 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:FuncTestRpcHandlerBlows away the main Confluence search index.- Specified by:
clearIndexin interfaceFuncTestRpcHandler
-
restoreAbstractPage
public boolean restoreAbstractPage(String token, String abstractPageId)
Description copied from interface:FuncTestRpcHandlerRestores an abstract page from the trash.- Specified by:
restoreAbstractPagein interfaceFuncTestRpcHandler
-
setContentSearchIndexAccessor
public void setContentSearchIndexAccessor(SearchIndexAccessor contentSearchIndexAccessor)
-
setChangeSearchIndexAccessor
public void setChangeSearchIndexAccessor(SearchIndexAccessor changeSearchIndexAccessor)
-
getIdOfPagePermission
public String getIdOfPagePermission(String token, String contentId, String permissionType, String username)
- Specified by:
getIdOfPagePermissionin interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerCreate test users with usernames "testuser0", "testuser1", etc. Each user's password is the same as their username.- Specified by:
createTestUsersin interfaceFuncTestRpcHandler- Returns:
- the number of users created
-
removeTestUsers
public int removeTestUsers(String token, int count)
Description copied from interface:FuncTestRpcHandlerRemoves test users with usernames "testuser0", "testuser1", etc. Logs a warning if a user cannot be removed.- Specified by:
removeTestUsersin interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerCreate a User Macro- Specified by:
createUserMacroin interfaceFuncTestRpcHandlerbodyType- how the body should be treated."raw","escapehtml", or"rendered". May be null only ifhasBodyis false.outputType- whether the macro is expected to return html or wiki markup."html"or"wiki".template- the velocity rendered by the macrotitle- the title of the macro that appears in the Macro Browserdescription- the description of the macro that appears in the Macro Browsercategory- the category the macro should be listed under in the Macro BrowsericonUrl- the URL of the macro icon that appears in the Macro BrowserdocumentationUrl- the URL of the macro documentationhidden- 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:FuncTestRpcHandlerRemove a User Macro with the given name if it exists.- Specified by:
removeUserMacroin interfaceFuncTestRpcHandler- 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:FuncTestRpcHandlerSets a property on the globalApplicationConfigurationinstance.- Specified by:
setApplicationConfigPropertyin interfaceFuncTestRpcHandler- Returns:
- the previous value of the property
-
storeXhtmlPage
public Hashtable storeXhtmlPage(String token, Hashtable pageStruct) throws RemoteException
Description copied from interface:FuncTestRpcHandlerThe 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:
storeXhtmlPagein interfaceFuncTestRpcHandler- Returns:
- the created page
- Throws:
RemoteException
-
getApplicationConfigProperty
public Object getApplicationConfigProperty(String token, String propertyKey)
Description copied from interface:FuncTestRpcHandlerReturns a property of the globalApplicationConfigurationinstance.- Specified by:
getApplicationConfigPropertyin interfaceFuncTestRpcHandler- Returns:
- the property mapped to
propertyKey
-
setBooleanUserPreference
public boolean setBooleanUserPreference(String token, String userName, String preferenceKey, String value) throws RemoteException
Description copied from interface:FuncTestRpcHandlerSets a boolean user preference.- Specified by:
setBooleanUserPreferencein interfaceFuncTestRpcHandleruserName- the user name to set the preference forpreferenceKey- the key of the preference to setvalue- 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:FuncTestRpcHandlerSets a string user preference.- Specified by:
setStringUserPreferencein interfaceFuncTestRpcHandleruserName- the user name to set the preference forpreferenceKey- the key of the preference to setvalue- a string to set as the preference- Throws:
RemoteException
-
enableDailyReportNotification
public boolean enableDailyReportNotification(String token, String userName, boolean dailyReportEnabled)
Description copied from interface:FuncTestRpcHandlerSets the Daily Report email for a user to enabled or disabled.- Specified by:
enableDailyReportNotificationin interfaceFuncTestRpcHandleruserName- the user name to set the report state fordailyReportEnabled- 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:FuncTestRpcHandlerSets Network watch emails for a user to enabled or disabled.- Specified by:
setNetworkNotificationForUserin interfaceFuncTestRpcHandleruserName- the user name to set the watch state forwatchNetwork- 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:FuncTestRpcHandlerSets Site Blog watch emails for a user to enabled or disabled.- Specified by:
setSiteBlogNotificationForUserin interfaceFuncTestRpcHandleruserName- the user name to set the watch state forglobalBlogWatchForUser- 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:FuncTestRpcHandlerWhether the warning message for an un-advisable value for the Base URL is ignored or not.- Specified by:
getIgnoreBaseURLWarningin interfaceFuncTestRpcHandler- Returns:
- true if the warning message is ignored.
-
setIgnoreBaseURLWarning
public boolean setIgnoreBaseURLWarning(String token, boolean ignored) throws RemoteException
Description copied from interface:FuncTestRpcHandlerAffects 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:
setIgnoreBaseURLWarningin interfaceFuncTestRpcHandlerignored- set to true to ignore the warning.- Throws:
RemoteException
-
enableUserFeature
@Deprecated public boolean enableUserFeature(String token, String featureKey) throws RemoteException
Deprecated.since 5.6. Use the REST resource.Description copied from interface:FuncTestRpcHandlerEnables a given dark feature for the logged in user.- Specified by:
enableUserFeaturein interfaceFuncTestRpcHandlerfeatureKey- - the key of the feature to enable- Throws:
RemoteException
-
disableUserFeature
@Deprecated public boolean disableUserFeature(String token, String featureKey) throws RemoteException
Deprecated.since 5.6. Use the REST resource.Description copied from interface:FuncTestRpcHandlerDisables a given dark feature for the logged in user.- Specified by:
disableUserFeaturein interfaceFuncTestRpcHandlerfeatureKey- - the key of the feature to disable- Throws:
RemoteException
-
enableSiteFeature
@Deprecated public boolean enableSiteFeature(String token, String featureKey) throws RemoteException
Deprecated.since 5.6. Use the REST resource.Description copied from interface:FuncTestRpcHandlerEnables a given dark feature for the entire site.- Specified by:
enableSiteFeaturein interfaceFuncTestRpcHandlerfeatureKey- - the key of the feature to enable- Throws:
RemoteException
-
disableSiteFeature
@Deprecated public boolean disableSiteFeature(String token, String featureKey) throws RemoteException
Deprecated.since 5.6. Use the REST resource.Description copied from interface:FuncTestRpcHandlerDisables a given dark feature for the entire site.- Specified by:
disableSiteFeaturein interfaceFuncTestRpcHandlerfeatureKey- - the key of the feature to disable- Throws:
RemoteException
-
setWelcomeMessage
public boolean setWelcomeMessage(String token, String welcomeMessage)
- Specified by:
setWelcomeMessagein interfaceFuncTestRpcHandler
-
resetWelcomeMessage
public boolean resetWelcomeMessage(String token)
- Specified by:
resetWelcomeMessagein interfaceFuncTestRpcHandler
-
getExportBuildNumber
public String getExportBuildNumber(String token)
Description copied from interface:FuncTestRpcHandlerReturns the backward-compatibility of an export- Specified by:
getExportBuildNumberin interfaceFuncTestRpcHandler- Parameters:
token- the authentication- Returns:
- the build number
-
getOldestSpaceImportAllowed
public String getOldestSpaceImportAllowed(String token)
Description copied from interface:FuncTestRpcHandlerReturns the backwards-compatibility of a space import- Specified by:
getOldestSpaceImportAllowedin interfaceFuncTestRpcHandler- Parameters:
token- the authentication- Returns:
- the oldest build number allowed
-
getPluginExportCompatibility
public String getPluginExportCompatibility(String token, String pluginKey)
Description copied from interface:FuncTestRpcHandlerReturns the plugin compatibility matrix for exports- Specified by:
getPluginExportCompatibilityin interfaceFuncTestRpcHandler- Parameters:
token- the authenticationpluginKey- 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:FuncTestRpcHandlerCreates 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:
createPagesFromPrototypein interfaceFuncTestRpcHandlerpageStruct- a template page to create multiple pages fromcount- 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:FuncTestRpcHandlerUpdate aSettingsboolean field.- Specified by:
updateGlobalSettingBooleanin interfaceFuncTestRpcHandlername- name of the field used to store the setting (see field names insideSettings.- Returns:
- the old value
- Throws:
RemoteException
-
updateGlobalSettingString
public String updateGlobalSettingString(String token, String name, String value) throws RemoteException
Description copied from interface:FuncTestRpcHandlerUpdate aSettingsString field.- Specified by:
updateGlobalSettingStringin interfaceFuncTestRpcHandlername- name of the field used to store the setting (see field names insideSettings.value- theStringvalue 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:FuncTestRpcHandlerCreates a bunch of spaces.- Specified by:
createSpacesin interfaceFuncTestRpcHandlercount- 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:FuncTestRpcHandlerReturns the number of active users, i.e. the number of users used for license purposes.- Specified by:
getNumberOfActiveUsersin interfaceFuncTestRpcHandler- Returns:
- the number of active users
- Throws:
RemoteException
-
isUnlimitedUserLicense
public boolean isUnlimitedUserLicense(String token) throws RemoteException
- Specified by:
isUnlimitedUserLicensein interfaceFuncTestRpcHandler- Returns:
- true if the current licence has no user limit, false otherwise
- Throws:
RemoteException
-
setPluginController
public void setPluginController(com.atlassian.plugin.PluginController pluginController)
-
setPluginAccessor
public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
-
setUserMacroLibrary
public void setUserMacroLibrary(UserMacroLibrary userMacroLibrary)
-
setEventLatchManager
public void setEventLatchManager(EventLatchManager eventLatchManager)
-
setApplicationConfig
public void setApplicationConfig(com.atlassian.config.ApplicationConfiguration applicationConfiguration)
-
setDarkFeaturesManager
public void setDarkFeaturesManager(DarkFeaturesManager darkFeaturesManager)
-
addExistingProfilePicture
public boolean addExistingProfilePicture(String token, String userName, String fileName)
Description copied from interface:FuncTestRpcHandlerAttempts to add a existing profile picture to a user's profile.- Specified by:
addExistingProfilePicturein interfaceFuncTestRpcHandleruserName- the user name of the profilefileName- file name of the picture- Returns:
- true if the picture is successfully added
-
setXhtmlRpcHandler
public void setXhtmlRpcHandler(ConfluenceXmlRpcHandler confluenceXmlRpcHandler)
-
setPageTemplateManager
public void setPageTemplateManager(PageTemplateManager pageTemplateManager)
-
setHibernateConfig
public void setHibernateConfig(com.atlassian.config.db.HibernateConfig hibernateConfig)
-
setEntityRemover
public void setEntityRemover(EntityRemover entityRemover)
-
setAnyTypeDao
public void setAnyTypeDao(EntityRemover entityRemover)
-
setUpgradeGate
public void setUpgradeGate(UpgradeGate upgradeGate)
-
setUserChecker
public void setUserChecker(UserChecker userChecker)
-
setWelcomeMessageService
public void setWelcomeMessageService(WelcomeMessageService welcomeMessageService)
-
setFormatConverter
public void setFormatConverter(FormatConverter formatConverter)
-
getAliveThreads
public Vector<Hashtable> getAliveThreads(String token) throws RemoteException
- Specified by:
getAliveThreadsin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
getStackDump
public String getStackDump(String token, String threadNameRegex) throws RemoteException
- Specified by:
getStackDumpin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
setEnableAnonymousRpc
public boolean setEnableAnonymousRpc(String token, String value) throws RemoteException
Description copied from interface:FuncTestRpcHandlerToggle 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:
setEnableAnonymousRpcin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
getContentForAllLabels
public Hashtable<String,Object> getContentForAllLabels(String token, int offset, int maxResults, String labelsString)
Description copied from interface:FuncTestRpcHandlerReturns CEOs having all of the labels supplied in the string. Labels are space-separated.- Specified by:
getContentForAllLabelsin interfaceFuncTestRpcHandler
-
getContentInSpacesForAllLabels
public Hashtable<String,Object> getContentInSpacesForAllLabels(String token, int offset, int maxResults, String spaceKeysString, String labelsString)
Description copied from interface:FuncTestRpcHandlerReturns CEOs in the given spaces having all of the labels supplied in the string. Labels and space keys are space-separated.- Specified by:
getContentInSpacesForAllLabelsin interfaceFuncTestRpcHandler
-
getAllContentForAllLabels
public Hashtable<String,Object> getAllContentForAllLabels(String token, int offset, int maxResults, String labelsString)
Description copied from interface:FuncTestRpcHandlerReturns current and trashed CEOs having all of the labels supplied in the string. Labels are space-separated.- Specified by:
getAllContentForAllLabelsin interfaceFuncTestRpcHandler
-
getForLabels
public Hashtable<String,Object> getForLabels(String token, String labelableType, int offset, int maxResults, String labelsString)
Description copied from interface:FuncTestRpcHandlerReturns any kind of Labelable entities having all of the labels supplied in the string. Labels are space-separated.- Specified by:
getForLabelsin interfaceFuncTestRpcHandler
-
addLabelToLabelable
public int addLabelToLabelable(String token, String labelName, String labelableId, String labelableType)
Description copied from interface:FuncTestRpcHandlerAdds 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:
addLabelToLabelablein interfaceFuncTestRpcHandler
-
startLoggingRequests
public boolean startLoggingRequests(String token)
Description copied from interface:FuncTestRpcHandlerStart logging http request urls.Call
FuncTestRpcHandler.finishLoggingRequests(String)to stop logging and to retrieve results.- Specified by:
startLoggingRequestsin interfaceFuncTestRpcHandler- Returns:
- true
-
finishLoggingRequests
public Vector<String> finishLoggingRequests(String token)
Description copied from interface:FuncTestRpcHandlerFinish logging http request and return any requests made.Logging must have been previously started using
FuncTestRpcHandler.startLoggingRequests(String).- Specified by:
finishLoggingRequestsin interfaceFuncTestRpcHandler- Returns:
- url of each request made
-
resetDatabaseStatistics
public boolean resetDatabaseStatistics(String token)
Description copied from interface:FuncTestRpcHandlerReset database statistics.Call
FuncTestRpcHandler.getDatabaseStatistics(String)to get results since the last reset.- Specified by:
resetDatabaseStatisticsin interfaceFuncTestRpcHandler- Returns:
- true
-
getDatabaseStatistics
public String getDatabaseStatistics(String token)
Description copied from interface:FuncTestRpcHandlerReturn database statistics.Statistics since the last call to
FuncTestRpcHandler.resetDatabaseStatistics(String)are returned.- Specified by:
getDatabaseStatisticsin interfaceFuncTestRpcHandler- Returns:
- stabase statistics
-
runGarbageCollection
public boolean runGarbageCollection(String token)
- Specified by:
runGarbageCollectionin interfaceFuncTestRpcHandler
-
isImportTaskRunning
public boolean isImportTaskRunning(String token)
- Specified by:
isImportTaskRunningin interfaceFuncTestRpcHandler
-
getAnonyimizedClusterNodeIdentifier
public String getAnonyimizedClusterNodeIdentifier(String unusedToken)
- Specified by:
getAnonyimizedClusterNodeIdentifierin interfaceFuncTestRpcHandler
-
moveBlogPost
public boolean moveBlogPost(String token, String blogPostId, String targetSpaceKey)
- Specified by:
moveBlogPostin interfaceFuncTestRpcHandler
-
assertThatIndexQueueEntryHasBeenProcessed
public boolean assertThatIndexQueueEntryHasBeenProcessed(String unusedToken, String searchableClassname, String searchableId) throws RemoteException
- Specified by:
assertThatIndexQueueEntryHasBeenProcessedin interfaceFuncTestRpcHandler- Throws:
RemoteException
-
increaseHighValue
public boolean increaseHighValue(String token)
Description copied from interface:FuncTestRpcHandlerPut a number bigger than 65535 in Hibernate_unique_key table to force generated ids to be greater than max integer.- Specified by:
increaseHighValuein interfaceFuncTestRpcHandler- Parameters:
token- the rpc authentication token- Returns:
- true if successful.
-
getRecordedErrorLogMessages
public Vector<String> getRecordedErrorLogMessages(String token)
- Specified by:
getRecordedErrorLogMessagesin interfaceFuncTestRpcHandler
-
clearRecordedLogMessages
public boolean clearRecordedLogMessages(String token)
- Specified by:
clearRecordedLogMessagesin interfaceFuncTestRpcHandler
-
setTransactionManager
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
-
setHibernateConnectionProviderLastExceptionTime
public boolean setHibernateConnectionProviderLastExceptionTime(String token, String timeStr)
- Specified by:
setHibernateConnectionProviderLastExceptionTimein interfaceFuncTestRpcHandler
-
clearHibernateConnectionProviderLastExceptionTime
public boolean clearHibernateConnectionProviderLastExceptionTime(String token)
- Specified by:
clearHibernateConnectionProviderLastExceptionTimein interfaceFuncTestRpcHandler
-
-