|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FuncTestRpcHandler
Method Summary | |
---|---|
boolean |
addExistingProfilePicture(String token,
String userName,
String fileName)
Attempts to add a existing profile picture to a user's profile. |
boolean |
addGroupAnyCase(String token,
String groupname)
Allows addition of a group without enforcing that the name be all lower case. |
boolean |
addMailServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port)
Deprecated. since 5.0. Use addSmtpServer instead. |
boolean |
addMailServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port,
String fromName)
Deprecated. since 5.0. Use addSmtpServer instead. |
boolean |
addPopMailServer(String token,
String serverName,
String hostname,
int port,
String username,
String password,
String toAddress)
Add a POP server to poll for emails in a particular account. |
boolean |
addSmtpServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port)
Add an SMTP mail server. |
boolean |
addSmtpServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port,
String fromName)
|
boolean |
addUserAnyCase(String token,
String username,
String email,
String fullname,
String password)
Allows addition of a user without enforcing that the username be all lower case. |
boolean |
buildDidYouMeanIndex(String token)
Start a task to build the DidYouMean Index. |
boolean |
changeAttachmentCreatedDate(String token,
String contentId,
String attachmentFileName,
Date createdDate)
Change the created date of an attachment |
boolean |
changeBlogPostModificationDate(String token,
String blogId,
Date modificationDate)
Change the modification date of a blog post |
boolean |
changeCommentCreatedDate(String token,
String commentId,
Date createdDate)
Change the created date of a comment |
String |
changeLoggerLevel(String token,
String loggerName,
String level)
Change the level of the specified logger. |
boolean |
changePageCreatedDate(String token,
String pageId,
Date createdDate)
Change the created date of a page |
boolean |
changePageModificationDate(String token,
String pageId,
Date modificationDate)
Change the modification date of a page |
boolean |
changeSpaceCreatedDate(String token,
String spaceKey,
Date createdDate)
Change the created date of a space |
boolean |
clearCustomHtml(String token)
Clears the global custom html. |
boolean |
clearEventListeners(String token)
Removes all temporary event listeners, regardless of their state. |
boolean |
clearIndex(String token)
Blows away the main Confluence search index. |
boolean |
clearQueue(String token,
String queueName)
Removes all items from the specified queue |
Boolean |
clearSystemProperty(String token,
String name)
Unset a system property. |
String |
convertMarkupToXhtml(String token,
String wikiMarkup,
String pageId)
Render a page as XHTML. |
String |
convertXhtmlToMarkup(String token,
String xhtml,
String pageId)
Convert XHTML to WikiMarkup. |
Hashtable |
createDraft(String token,
Hashtable draft)
Creates a draft for the draft owner and draft type with the specified title and content. |
boolean |
createJohnsonEvent(String token,
String message)
Creates a Johnson event inside Confluence. |
Vector<Hashtable> |
createPagesFromPrototype(String token,
Hashtable pageStruct,
int count)
Creates a series of pages based on a prototype. |
Vector<String> |
createSpaces(String token,
int count)
Creates a bunch of spaces. |
int |
createTestUsers(String token,
int count)
Create test users with usernames "testuser0", "testuser1", etc. |
boolean |
createUserMacro(String token,
String name,
boolean hasBody,
String bodyType,
String outputType,
String template,
String title,
String description,
String category,
String iconUrl,
String documentationUrl,
boolean hidden)
Create a User Macro |
boolean |
disablePlugin(String token,
String pluginKey)
Disable a plugin. |
boolean |
disablePluginModule(String tokdis,
String pluginKey,
String moduleKey)
Disable plugin module |
boolean |
disableSiteFeature(String token,
String featureKey)
Disables a given dark feature for the entire site. |
boolean |
disableUserFeature(String token,
String featureKey)
Disables a given dark feature for the logged in user. |
boolean |
disconnectGroup(String token,
String groupName)
Disconnect a group from Confluence. |
boolean |
disconnectUser(String token,
String username)
Disconnect a user from Confluence. |
boolean |
doesDraftExist(String token,
String contentId,
String owner,
String draftType,
String spaceKey)
Determines if a draft of the specified type and belonging to the specified owner exists. |
boolean |
enableCaptcha(String token,
boolean enable)
Sets the captcha mode |
boolean |
enableCaptchaDebugMode(String token,
boolean enable)
Sets the captcha mode into debug mode. |
boolean |
enableDailyReportNotification(String token,
String userName,
boolean dailyReportEnabled)
Sets the Daily Report email for a user to enabled or disabled. |
boolean |
enablePlugin(String token,
String pluginKey)
Enable a plugin. |
boolean |
enablePluginModule(String token,
String pluginKey,
String moduleKey)
Enable plugin module |
boolean |
enablePublicSignUp(String token,
boolean enabled)
Sets the public sign up enabled status |
boolean |
enableSiteFeature(String token,
String featureKey)
Enables a given dark feature for the entire site. |
boolean |
enableUserFeature(String token,
String featureKey)
Enables a given dark feature for the logged in user. |
boolean |
enableWebSudo(String token,
boolean enabled)
Sets the web sudo enabled status |
boolean |
flushAllCaches(String token)
Flushes all the caches. |
boolean |
followUser(String token,
String userName,
boolean followUser)
Follows or stops following a user. |
Object |
getApplicationConfigProperty(String token,
String propertyKey)
Returns a property of the global ApplicationConfiguration instance. |
Hashtable |
getCacheStatistics(String token,
String cacheName)
Returns the cache statistics for a particular named cache. |
String |
getConfiguredThemeForSpace(String token,
String spaceKey)
Get the key of the configured theme for a space, whether or not that theme exists. |
Vector |
getContentPropertyKeys(String token,
String entityId)
Get the content property keys for a content entity given its id |
String |
getGlobalConfiguredTheme(String token)
Get the key of the configured global theme, whether or not that theme exists. |
String[] |
getGlobalPermissionsForGroup(String token,
String groupName)
Gets the global permissions that the given group has. |
String |
getIdOfPagePermission(String token,
String contentId,
String permissionType,
String username)
|
boolean |
getIgnoreBaseURLWarning(String token)
Whether the warning message for an un-advisable value for the Base URL is ignored or not. |
String |
getLeastRecentTestAppenderLogMessage(String token,
String className)
|
String |
getLocaleForUser(String token,
String username)
Gets the locale preference for the user. |
String |
getLocalisedText(String token,
String messageKey)
Get the localised string for given the message key in the logged-in user's locale. |
int |
getNumberOfIndexTasksInQueue(String token)
Returns the size of the index queue. |
String |
getPersonalInformationId(String token,
String username)
Gets the personal information id for a given username |
int |
getQueueSize(String token,
String queueName)
Returns the size of the task queue with the specified name. |
Hashtable<String,String> |
getSystemProperty(String token,
String name)
Retrieve the value of a system property. |
Vector |
getUsersForActivity(String key)
Call getUsersForActivity on the heartbeatManager bean |
int |
getVersionForPage(String token,
String pageId)
Get the version number for the page with pageId |
boolean |
isCurrentApplicationSet(String token)
Check whether or not the trustedApplicationManager has its currentApplication set. |
boolean |
isPluginModuleEnabled(String token,
String pluginKey,
String moduleKey)
Find out if a plugin module is enabled or not. |
boolean |
isSpringComponentPresent(String token,
String name)
Returns true if a Spring component with the given name exists in the application context. |
boolean |
logMessage(String token,
String destination,
String message)
Log a message to the server's console. |
boolean |
logTestMessageForClass(String token,
String className,
String message,
String level)
|
boolean |
massCreateAttachments(String token,
String pageId,
String prefix,
String numAttachments)
Create a whole series of attachments on a single page. |
boolean |
pauseAllJobs(String token)
Pauses the quartz scheduler. |
boolean |
pauseJob(String token,
String jobName)
Pauses the named job in the quartz scheduler |
boolean |
pauseJobGroup(String token,
String jobGroupName)
Pauses the named job group in the quartz scheduler. |
boolean |
putStringMappingInCache(String token,
String cacheName,
String key,
String value)
Map a key to a value for a given cache. |
boolean |
registerEventListener(String token,
String eventClassName)
Registers a temporary event listener on the server to listen for the specified event. |
boolean |
registerTestAppenderForClass(String token,
String className)
|
boolean |
removeAllJohnsonEvents(String token)
Removes all Johnson events from Confluence |
boolean |
removeAllSpaces(String token)
Kill all the spaces and flush all the queues and caches. |
boolean |
removeAllTrustedApplications(String token)
Removes all trusted applications from the database. |
boolean |
removeBandanaKey(String token,
String space,
String key)
Remove a key from Bandana |
boolean |
removeDrafts(String token,
String username)
Removes all drafts owned by the specified User. |
boolean |
removeGroupUncleanly(String token,
String groupname)
Remove a Group without removing the things that refer to that group. |
boolean |
removeMailServer(String token,
String serverName)
Remove the named mail server. |
boolean |
removePersonalInformation(String token,
String username)
PersonalInformation gets created automatically by the standard create user methods. |
boolean |
removeTestData(String token,
Vector<String> usersToKeep,
Vector<String> groupsToKeep,
Hashtable<String,Vector<String>> userGroupMemberships)
Big Kahuna remove method. |
boolean |
removeTestDataAfterExternalUserManagement(String token)
Called at the start of tests for which User management is handled by an external server such as LDAP or Crowd. |
int |
removeTestUsers(String token,
int count)
Removes test users with usernames "testuser0", "testuser1", etc. |
boolean |
removeUserMacro(String token,
String name)
Remove a User Macro with the given name if it exists. |
boolean |
removeUserUncleanly(String token,
String username)
Remove a User without removing the things that refer to that user. |
boolean |
resetWelcomeMessage(String token)
|
boolean |
restoreAbstractPage(String token,
String abstractPageId)
Restores an abstract page from the trash. |
boolean |
resumeJob(String token,
String jobName)
Resumes the named job in the quartz scheduler |
boolean |
saveDateFormat(String token,
String dateFormat)
|
boolean |
saveDateTimeFormat(String token,
String dateTimeFormat)
|
boolean |
setApplicationConfigProperty(String token,
String propertyKey,
String propertyValue)
Sets a property on the global ApplicationConfiguration instance. |
boolean |
setBandanaKey(String token,
String space,
String key,
String value)
Sets a key in Bandana |
boolean |
setBandanaKeyBoolean(String token,
String space,
String key,
boolean value)
Sets a key in Bandana |
boolean |
setBandanaKeyInteger(String token,
String space,
String key,
int value)
Sets a key in Bandana |
boolean |
setBandanaStringList(String token,
String space,
String key,
Vector<String> value)
Sets a key in Bandana with a List of Strings as value |
boolean |
setBandanaStringSet(String token,
String space,
String key,
Vector<String> value)
Sets a key in Bandana with a Set of Strings as value |
boolean |
setBooleanUserPreference(String token,
String userName,
String preferenceKey,
String value)
Sets a boolean user preference. |
boolean |
setContentTextProperty(String token,
String entityId,
String key,
String value)
Sets a text content property for a content entity given its id |
boolean |
setDirectoryPasswordEncoder(String token,
String directoryName,
String encoder)
Changes the password encoder for the given directory |
boolean |
setDraftSaveInterval(String token,
int seconds)
Sets the given draft save interval. |
boolean |
setGlobalTheme(String token,
String themeKey)
Sets the global theme |
boolean |
setIgnoreBaseURLWarning(String token,
boolean value)
Affects whether the warning message for an un-advisable value for the Base URL is ignored or not. |
boolean |
setKeyboardShortcutPref(String token,
String username,
String enabled)
Enables/Disables keyboard shortcuts for the given uesr |
boolean |
setLocaleForUser(String token,
String username,
String locale)
Sets the locale preference for the user to the given named locale. |
boolean |
setNetworkNotificationForUser(String token,
String userName,
boolean watchNetwork)
Sets Network watch emails for a user to enabled or disabled. |
boolean |
setSharedMode(String token,
boolean set)
Deprecated. since 5.0. Shared-mode not supported since 3.0. |
boolean |
setSiteBlogNotificationForUser(String token,
String userName,
boolean globalBlogWatchForUser)
Sets Site Blog watch emails for a user to enabled or disabled. |
boolean |
setSmtpServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port)
Remove all existing SMTP servers and add the given server. |
boolean |
setSmtpServer(String token,
String name,
String from,
String subjectPrefix,
String hostname,
int port,
String fromName)
Remove all existing SMTP servers and add the given server. |
boolean |
setStringUserPreference(String token,
String userName,
String preferenceKey,
String value)
Sets a string user preference. |
Boolean |
setSystemProperty(String token,
String name,
String value)
Set a system property on the server to the supplied value. |
boolean |
setThemeForSpace(String token,
String spaceKey,
String themeKey)
Sets the theme for the specified space |
boolean |
setUserDetailProperty(String token,
String username,
String propertyKey,
String propertyValue)
Sets a single UserDetails property through the UserDetailsManager. |
boolean |
setUserDetails(String token,
String username,
String fullName,
String email)
Sets the fullname and email address of a user with a given username. |
String |
setUserStatus(String token,
String wikiStatus)
Set the current user's status. |
boolean |
setWatchOwnContentPref(String token,
String username,
String enabled)
Enables/Disables autowatching for the given uesr |
boolean |
setWatchSpace(String token,
String username,
String spaceKey,
String contentType,
String enabled)
Enables/Disables watching a space for the given user and content type. |
boolean |
setWebSudoTimeout(String token,
int timeout)
Sets the web sudo timeout in minutes |
boolean |
setWelcomeMessage(String token,
String welcomeMessage)
|
boolean |
shutdownQuartz(String token)
Shutdown the quartz scheduler to ensure single threadedness for testing |
boolean |
startActivity(String key,
String user)
Call startActivity on the heartbeatManager bean |
Hashtable |
storeXhtmlPage(String token,
Hashtable pageStruct)
The Confluence remote API store page performs wiki to XHTML conversion on the page content. |
boolean |
synchroniseUserDirectories(String token)
Synchronizes all remote user directories with the local database cache |
boolean |
triggerJob(String token,
String jobName,
boolean pauseBackgroundJobs)
Triggers the named job in the quartz scheduler synchronously. |
boolean |
uninstallPlugin(String token,
String pluginKey)
Uninstall a plugin. |
boolean |
unregisterEventListener(String token,
String eventClassName)
Unregisters the temporary listener registered for the specified event. |
boolean |
unregisterTestAppenderForClass(String token,
String className)
|
Hashtable |
updateDraft(String token,
Hashtable draft)
Updates a draft located using the draft owner and draft type. |
boolean |
updateGlobalSettingBoolean(String token,
String name,
boolean value)
Update a Settings boolean field. |
String |
updateGlobalSettingString(String token,
String name,
String value)
Update a Settings String field. |
boolean |
waitForEvent(String token,
String eventClassName,
String timeout,
String timeUnit)
Waits for an event to occur and returns when it has finished. |
Method Detail |
---|
boolean logMessage(String token, String destination, String message) throws RemoteException
Only administrators can log messages.
The destination of the message has the following valid values:
token
- The token idenfitying the user.destination
- The destination of the message to be loggedmessage
- The text message to be logged to the console
RemoteException
String changeLoggerLevel(String token, String loggerName, String level) throws RemoteException
Change the level of the specified logger.
The level parameter can be one of -
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
RemoteException
boolean removeTestData(String token, Vector<String> usersToKeep, Vector<String> groupsToKeep, Hashtable<String,Vector<String>> userGroupMemberships) throws RemoteException
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 removeduserGroupMemberships
- a map where the keys are group names and the values are lists of usernames in the group
NotPermittedException
RemoteException
boolean removeTestDataAfterExternalUserManagement(String token) throws Exception
Exception
boolean removeAllSpaces(String token) throws RemoteException
RemoteException
String[] getGlobalPermissionsForGroup(String token, String groupName) throws RemoteException
RemoteException
boolean disconnectUser(String token, String username) throws RemoteException
RemoteException
boolean disconnectGroup(String token, String groupName) throws RemoteException
RemoteException
boolean isCurrentApplicationSet(String token) throws NotPermittedException
NotPermittedException
boolean removeAllTrustedApplications(String token) throws Exception
Exception
boolean massCreateAttachments(String token, String pageId, String prefix, String numAttachments) throws Exception
Exception
String getGlobalConfiguredTheme(String token) throws Exception
Exception
String getConfiguredThemeForSpace(String token, String spaceKey) throws Exception
Exception
boolean setGlobalTheme(String token, String themeKey) throws Exception
themeKey
- - the complete theme key
Exception
boolean setThemeForSpace(String token, String spaceKey, String themeKey) throws Exception
spaceKey
- - the key of the space to changethemeKey
- - the complete theme key
Exception
boolean clearCustomHtml(String token) throws Exception
Exception
boolean uninstallPlugin(String token, String pluginKey) throws NotPermittedException
NotPermittedException
boolean disablePlugin(String token, String pluginKey) throws NotPermittedException
NotPermittedException
boolean enablePlugin(String token, String pluginKey) throws NotPermittedException
NotPermittedException
boolean enablePluginModule(String token, String pluginKey, String moduleKey) throws NotPermittedException
pluginKey
- the key of the pluginmoduleKey
- the key of the module
NotPermittedException
boolean disablePluginModule(String tokdis, String pluginKey, String moduleKey) throws NotPermittedException
pluginKey
- the key of the pluginmoduleKey
- the key of the module
NotPermittedException
boolean isPluginModuleEnabled(String token, String pluginKey, String moduleKey) throws NotPermittedException
pluginKey
- the key of the pluginmoduleKey
- the key of the module excluding the plugin key
NotPermittedException
boolean isSpringComponentPresent(String token, String name)
boolean pauseAllJobs(String token) throws Exception
Exception
boolean pauseJobGroup(String token, String jobGroupName) throws Exception
Exception
boolean pauseJob(String token, String jobName) throws Exception
Exception
boolean resumeJob(String token, String jobName) throws Exception
Exception
boolean triggerJob(String token, String jobName, boolean pauseBackgroundJobs) throws Exception
Exception
boolean waitForEvent(String token, String eventClassName, String timeout, String timeUnit) throws Exception
eventClassName
- the fully qualified classname of the event to wait for.timeout
- number of milliseconds to wait for the event before giving up completely.timeUnit
- See TimeUnit.name
Exception
boolean shutdownQuartz(String token) throws Exception
Exception
boolean removeBandanaKey(String token, String space, String key)
boolean setBandanaStringSet(String token, String space, String key, Vector<String> value)
boolean setBandanaStringList(String token, String space, String key, Vector<String> value)
boolean setBandanaKey(String token, String space, String key, String value)
boolean setBandanaKeyBoolean(String token, String space, String key, boolean value)
boolean setBandanaKeyInteger(String token, String space, String key, int value)
Vector getContentPropertyKeys(String token, String entityId)
boolean setContentTextProperty(String token, String entityId, String key, String value)
String getPersonalInformationId(String token, String username)
boolean removePersonalInformation(String token, String username) throws NotPermittedException
username
- user whose personalInformation will be removed
NotPermittedException
String getLocaleForUser(String token, String username)
boolean setLocaleForUser(String token, String username, String locale) throws RemoteException
RemoteException
boolean setKeyboardShortcutPref(String token, String username, String enabled) throws RemoteException
RemoteException
boolean setWatchOwnContentPref(String token, String username, String enabled) throws RemoteException
RemoteException
boolean setWatchSpace(String token, String username, String spaceKey, String contentType, String enabled) throws RemoteException
RemoteException
boolean setUserDetails(String token, String username, String fullName, String email) throws RemoteException
RemoteException
- if the user was not found.boolean setUserDetailProperty(String token, String username, String propertyKey, String propertyValue)
RemoteException
- if the user was not found.boolean putStringMappingInCache(String token, String cacheName, String key, String value) throws Exception
Exception
Hashtable getCacheStatistics(String token, String cacheName) throws Exception
cacheName
- the key of the cache, rather than the "niceName"
Exception
boolean flushAllCaches(String token) throws Exception
Exception
boolean enableWebSudo(String token, boolean enabled) throws Exception
Exception
boolean setWebSudoTimeout(String token, int timeout) throws Exception
Exception
boolean enablePublicSignUp(String token, boolean enabled) throws Exception
Exception
boolean startActivity(String key, String user) throws Exception
Exception
Vector getUsersForActivity(String key) throws Exception
Exception
@Deprecated boolean setSharedMode(String token, boolean set) throws Exception
Exception
boolean removeUserUncleanly(String token, String username) throws Exception
Exception
boolean removeGroupUncleanly(String token, String groupname) throws Exception
Exception
boolean doesDraftExist(String token, String contentId, String owner, String draftType, String spaceKey)
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
Hashtable createDraft(String token, Hashtable draft)
token
- rpc authentication tokendraft
- the draft object to create
Required:
"owner"
- the username of owner/author of the draft. Set to null for anonymous users.
"draftType"
- type of content the draft is for i.e. BlogPost.getType()
or Page.getType()
.
"title"
- title of the draft.
"content"
- content of the draft as a String
in Confluence XML storage format.
Optional:
"pageId"
- page that the draft is associated with.
"spaceKey"
- if no there is no page, the space that the draft is written in.
id
.Hashtable updateDraft(String token, Hashtable draft)
token
- rpc authentication tokendraft
- the draft object to create see #createDraft(java.lang.String, java.util.Hashtable)
boolean removeDrafts(String token, String username)
token
- rpc authentication tokenusername
- user to remove drafts for
boolean setDraftSaveInterval(String token, int seconds)
token
- rpc authentication tokenseconds
- number of seconds for which the draft save interval should be
boolean clearQueue(String token, String queueName)
int getQueueSize(String token, String queueName)
int getNumberOfIndexTasksInQueue(String token)
token
-
boolean removeMailServer(String token, String serverName) throws Exception
token
- the rpc authentication tokenserverName
- the name of the server to be removed.
Exception
String getLeastRecentTestAppenderLogMessage(String token, String className)
boolean registerTestAppenderForClass(String token, String className)
boolean unregisterTestAppenderForClass(String token, String className)
boolean logTestMessageForClass(String token, String className, String message, String level)
String getLocalisedText(String token, String messageKey)
token
- the rpc authentication tokenmessageKey
- the i18n message key
boolean addUserAnyCase(String token, String username, String email, String fullname, String password) throws RemoteException
NotPermittedException
- if you do not have permissions to add the user.
RemoteException
boolean addGroupAnyCase(String token, String groupname) throws RemoteException
groupname
- the name of the group to add
RemoteException
boolean changeSpaceCreatedDate(String token, String spaceKey, Date createdDate) throws RemoteException
spaceKey
- the space key of the space to change the created date
RemoteException
boolean changeCommentCreatedDate(String token, String commentId, Date createdDate) throws RemoteException
RemoteException
boolean changePageCreatedDate(String token, String pageId, Date createdDate) throws RemoteException
pageId
- the page id of the page to change the created date
RemoteException
boolean changeAttachmentCreatedDate(String token, String contentId, String attachmentFileName, Date createdDate) throws RemoteException
contentId
- the id of the page or blogpost the attachment is attached toattachmentFileName
- the attachment file name of the attachment to change the created date
RemoteException
boolean changeBlogPostModificationDate(String token, String blogId, Date modificationDate) throws RemoteException
blogId
- the id of the blog to modifymodificationDate
- the last modification date to be set.
RemoteException
boolean changePageModificationDate(String token, String pageId, Date modificationDate) throws RemoteException
pageId
- the page id of the page to change the modification datemodificationDate
- the last modification date to be set.
RemoteException
int getVersionForPage(String token, String pageId) throws RemoteException
RemoteException
boolean saveDateFormat(String token, String dateFormat)
boolean saveDateTimeFormat(String token, String dateTimeFormat)
@Deprecated boolean addMailServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)
@Deprecated boolean addMailServer(String token, String name, String from, String subjectPrefix, String hostname, int port)
boolean addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)
boolean addSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)
boolean setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port)
boolean setSmtpServer(String token, String name, String from, String subjectPrefix, String hostname, int port, String fromName)
boolean addPopMailServer(String token, String serverName, String hostname, int port, String username, String password, String toAddress)
String convertMarkupToXhtml(String token, String wikiMarkup, String pageId)
String convertXhtmlToMarkup(String token, String xhtml, String pageId)
boolean createJohnsonEvent(String token, String message)
ConfluenceJohnsonFilter
.
message
- the description of the event to createboolean removeAllJohnsonEvents(String token)
boolean enableCaptcha(String token, boolean enable)
boolean enableCaptchaDebugMode(String token, boolean enable)
CaptchaManager.setDebugMode(boolean)
.
Hashtable<String,String> getSystemProperty(String token, String name)
name
- the name of the property
Boolean setSystemProperty(String token, String name, String value)
name
- the name of the propertyvalue
- the value of the property
Boolean clearSystemProperty(String token, String name)
name
- the name of the property
boolean clearIndex(String token)
boolean buildDidYouMeanIndex(String token)
IndexBuildCompleteEvent
will be published when the index is complete.
boolean restoreAbstractPage(String token, String abstractPageId)
String getIdOfPagePermission(String token, String contentId, String permissionType, String username)
int createTestUsers(String token, int count)
int removeTestUsers(String token, int count)
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
bodyType
- how the body should be treated. "raw"
, "escapehtml"
, or "rendered"
. May
be null only if hasBody
is false.outputType
- whether the macro is expected to return html or wiki markup. "html"
or "wiki"
.template
- the velocity rendered by the 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
RuntimeException
- if the macro already exists
NotPermittedException
boolean removeUserMacro(String token, String name) throws NotPermittedException
NotPermittedException
boolean registerEventListener(String token, String eventClassName) throws Exception
unregisterEventListener(String, String)
in a finally clause to
ensure the temporary listener is cleaned up.
Once the listener is registered, clients can use waitForEvent(String, String, String, String)
to block until the event
is published.
Exception
boolean unregisterEventListener(String token, String eventClassName) throws Exception
Exception
boolean clearEventListeners(String token) throws Exception
Exception
boolean setApplicationConfigProperty(String token, String propertyKey, String propertyValue)
ApplicationConfiguration
instance.
Object getApplicationConfigProperty(String token, String propertyKey)
ApplicationConfiguration
instance.
propertyKey
-
propertyKey
boolean followUser(String token, String userName, boolean followUser) throws RemoteException
followUser
- true to follow a user, false to stop following
RemoteException
String setUserStatus(String token, String wikiStatus) throws Exception
wikiStatus
- the status string in wiki markup.
Exception
Hashtable storeXhtmlPage(String token, Hashtable pageStruct) throws RemoteException
token
- pageStruct
-
RemoteException
boolean synchroniseUserDirectories(String token) throws Exception
Exception
boolean setDirectoryPasswordEncoder(String token, String directoryName, String encoder) throws Exception
Exception
boolean addExistingProfilePicture(String token, String userName, String fileName) throws Exception
userName
- the user name of the profilefileName
- file name of the picture
Exception
boolean setBooleanUserPreference(String token, String userName, String preferenceKey, String value) throws RemoteException
userName
- 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
RemoteException
boolean setStringUserPreference(String token, String userName, String preferenceKey, String value) throws RemoteException
userName
- the user name to set the preference forpreferenceKey
- the key of the preference to setvalue
- a string to set as the preference
RemoteException
boolean enableDailyReportNotification(String token, String userName, boolean dailyReportEnabled)
userName
- the user name to set the report state fordailyReportEnabled
- true if the daily report should be sent, false if notboolean setNetworkNotificationForUser(String token, String userName, boolean watchNetwork)
userName
- the user name to set the watch state forwatchNetwork
- true if the user should watch their network, false if notboolean setSiteBlogNotificationForUser(String token, String userName, boolean globalBlogWatchForUser)
userName
- the user name to set the watch state forglobalBlogWatchForUser
- true if the user should watch all blogs on the site network, false if notboolean getIgnoreBaseURLWarning(String token)
boolean setIgnoreBaseURLWarning(String token, boolean value) throws RemoteException
value
- set to true to ignore the warning.
RemoteException
boolean enableUserFeature(String token, String featureKey)
featureKey
- - the key of the feature to enableboolean disableUserFeature(String token, String featureKey)
featureKey
- - the key of the feature to disableboolean enableSiteFeature(String token, String featureKey)
featureKey
- - the key of the feature to enableboolean disableSiteFeature(String token, String featureKey)
featureKey
- - the key of the feature to disableboolean setWelcomeMessage(String token, String welcomeMessage)
boolean resetWelcomeMessage(String token)
Vector<Hashtable> createPagesFromPrototype(String token, Hashtable pageStruct, int count) throws RemoteException
pageStruct
- a template page to create multiple pages fromcount
- the number of pages to create - pages created are 1-indexed
RemoteException
boolean updateGlobalSettingBoolean(String token, String name, boolean value) throws RemoteException
Settings
boolean field.
token
- name
- name of the field used to store the setting (see field names inside Settings
.value
-
RemoteException
String updateGlobalSettingString(String token, String name, String value) throws RemoteException
Settings
String field.
name
- name of the field used to store the setting (see field names inside Settings
.value
- the String
value the field should take
RemoteException
Vector<String> createSpaces(String token, int count) throws RemoteException
count
- the number to create
RemoteException
- if you are not awesome enough to use this method
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |