com.atlassian.confluence.test.rpc
Class FuncTestRpcDelegator

java.lang.Object
  extended by com.atlassian.confluence.test.rpc.FuncTestRpcDelegator
All Implemented Interfaces:
FuncTestRpcHandler

public class FuncTestRpcDelegator
extends java.lang.Object
implements FuncTestRpcHandler


Constructor Summary
FuncTestRpcDelegator()
           
 
Method Summary
 boolean addGroupAnyCase(java.lang.String token, java.lang.String groupname)
          Allows addition of a group without enforcing that the name be all lower case.
 boolean addMailServer(java.lang.String token, java.lang.String name, java.lang.String from, java.lang.String subjectPrefix, java.lang.String hostname, int port)
           
 boolean addUserAnyCase(java.lang.String token, java.lang.String username, java.lang.String email, java.lang.String fullname, java.lang.String password)
          Allows addition of a user without enforcing that the username be all lower case.
 boolean changeAttachmentCreatedDate(java.lang.String token, java.lang.String contentId, java.lang.String attachmentFileName, java.util.Date createdDate)
          Change the created date of an attachment
 boolean changeBlogPostModifiedDate(java.lang.String token, java.lang.String blogId, java.util.Date modifiedDate)
          Change the modified date of a blog post
 boolean changeCommentCreatedDate(java.lang.String token, java.lang.String commentId, java.util.Date createdDate)
          Change the created date of a comment
 java.lang.String changeLoggerLevel(java.lang.String token, java.lang.String loggerName, java.lang.String level)
           Change the level of the specified logger.
 boolean changePageCreatedDate(java.lang.String token, java.lang.String pageId, java.util.Date createdDate)
          Change the created date of a page
 boolean changePageModificationDate(java.lang.String token, java.lang.String pageId, java.util.Date modificationDate)
          Change the modification date of a page
 boolean changeSpaceCreatedDate(java.lang.String token, java.lang.String spaceKey, java.util.Date createdDate)
          Change the created date of a space
 boolean clearIndex(java.lang.String token)
          Blows away the main Confluence search index.
 boolean clearQueue(java.lang.String token, java.lang.String queueName)
          Removes all items from the specified queue
 java.lang.String convertMarkupToXhtml(java.lang.String token, java.lang.String wikiMarkup, java.lang.String pageId)
          Render a page as XHTML.
 java.lang.String convertXhtmlToMarkup(java.lang.String token, java.lang.String xhtml, java.lang.String pageId)
          Convert XHTML to WikiMarkup.
 java.util.Hashtable createDraft(java.lang.String token, java.util.Hashtable draft)
          Creates a draft for the draft owner and draft type with the specified title and content.
 boolean createJohnsonEvent(java.lang.String token, java.lang.String message)
          Creates a Johnson event inside Confluence.
 boolean createUserMacro(java.lang.String token, java.lang.String name, boolean hasBody, java.lang.String bodyType, java.lang.String outputType, java.lang.String template)
          Create a User Macro
 boolean disablePlugin(java.lang.String token, java.lang.String pluginKey)
          Disable a plugin.
 boolean disablePluginModule(java.lang.String token, java.lang.String pluginKey, java.lang.String moduleKey)
          Disable plugin module
 boolean disconnectGroup(java.lang.String token, java.lang.String groupname)
          Disconnect a group from Confluence.
 boolean disconnectUser(java.lang.String token, java.lang.String username)
          Disconnect a user from Confluence.
 boolean doesDraftExist(java.lang.String token, java.lang.String contentId, java.lang.String owner, java.lang.String draftType)
          Determines if a draft of the specified type and belonging to the specified owner exists.
 boolean enablePlugin(java.lang.String token, java.lang.String pluginKey)
          Enable a plugin.
 boolean enablePluginModule(java.lang.String token, java.lang.String pluginKey, java.lang.String moduleKey)
          Enable plugin module
 boolean flushAllCaches(java.lang.String token)
          Flushes all the caches.
 java.lang.String getConfiguredThemeForSpace(java.lang.String token, java.lang.String spaceKey)
          Get the key of the configured theme for a space, whether or not that theme exists.
 java.util.Vector getContentPropertyKeys(java.lang.String token, java.lang.String entityId)
          Get the content property keys for a content entity given its id
 java.lang.String getGlobalConfiguredTheme(java.lang.String token)
          Get the key of the configured global theme, whether or not that theme exists.
 java.lang.String getIdOfPagePermission(java.lang.String token, java.lang.String contentId, java.lang.String permissionType, java.lang.String username)
           
 java.lang.String getLeastRecentTestAppenderLogMessage(java.lang.String token, java.lang.String className)
           
 java.lang.String getLocaleForUser(java.lang.String token, java.lang.String username)
          Gets the locale preference for the user.
 java.lang.String getLocalisedText(java.lang.String token, java.lang.String messageKey)
          Get the localised string for given the message key in the logged-in user's locale.
 java.lang.String getPersonalInformationId(java.lang.String token, java.lang.String username)
          Gets the personal information id for a given username
 int getQueueSize(java.lang.String token, java.lang.String queueName)
          Returns the size of the task queue with the specified name.
 java.util.Vector getRecentEvents(java.lang.String token)
          Returns a vector of class names from the last 10 events fired.
 java.util.Vector getUsersForActivity(java.lang.String key)
          Call getUsersForActivity on the heartbeatManager bean
 int getVersionForPage(java.lang.String token, java.lang.String pageId)
          Get the version number for the page with pageId
 boolean isCurrentApplicationSet(java.lang.String token)
          Check whether or not the trustedApplicationManager has its currentApplication set.
 boolean isPluginInstalled(java.lang.String token, java.lang.String pluginKey)
          Check whether a plugin is installed or not.
 boolean isSpringComponentPresent(java.lang.String token, java.lang.String name)
          Returns true if a Spring component with the given name exists in the application context.
 boolean logMessage(java.lang.String token, java.lang.String destination, java.lang.String message)
          Log a message to the server's console.
 boolean logTestMessageForClass(java.lang.String token, java.lang.String className, java.lang.String message, java.lang.String level)
           
 boolean massCreateAttachments(java.lang.String token, java.lang.String pageId, java.lang.String prefix, java.lang.String numAttachments)
          Create a whole series of attachments on a single page.
 boolean nukeSpacesAndFlushEverything(java.lang.String token)
          Kill all the spaces and flush all the queues and caches.
 boolean nukeUserAndGroupDependentObjects(java.lang.String token)
          Remove the dependencies of all users and groups, except the default dependencies of the default groups and the current user.
 boolean pauseJob(java.lang.String token, java.lang.String jobName)
          Pauses a named job in the quartz scheduler
 boolean putStringMappingInCache(java.lang.String token, java.lang.String cacheName, java.lang.String key, java.lang.String value)
          Map a key to a value for a given cache.
 boolean registerEventListener(java.lang.String token, java.lang.String eventClassName)
          Registers a temporary event listener on the server to listen for the specified event.
 boolean registerTestAppenderForClass(java.lang.String token, java.lang.String className)
           
 boolean removeAllGroupsExceptDefaults(java.lang.String token)
          Remove all groups aside from the default Confluence groups
 boolean removeAllJohnsonEvents(java.lang.String token)
          Removes all Johnson events from Confluence
 boolean removeAllOtherUsers(java.lang.String token)
          Remove all users except the current user.
 boolean removeBandanaKey(java.lang.String token, java.lang.String space, java.lang.String key)
          Remove a key from Bandana
 boolean removeDrafts(java.lang.String token, java.lang.String username)
          Removes all drafts owned by the specified User.
 boolean removeMailServer(java.lang.String token, java.lang.String serverName)
          Remove the named mail server.
 boolean removePersonalInformation(java.lang.String token, java.lang.String username)
          PersonalInformation gets created automatically by the standard create user methods.
 boolean removeUserMacro(java.lang.String token, java.lang.String name)
          Remove a User Macro with the given name if it exists.
 boolean removeUserUncleanly(java.lang.String token, java.lang.String username)
          Remove a User without removing the things that refer to that user.
 boolean resetTheme(java.lang.String token)
          Reset the global theme to the default theme.
 boolean restoreAbstractPage(java.lang.String token, java.lang.String abstractPageId)
          Restores an abstract page from the trash.
 boolean resumeJob(java.lang.String token, java.lang.String jobName)
          Resumes a named job in the quartz scheduler
 boolean saveDateFormat(java.lang.String token, java.lang.String dateFormat)
           
 boolean saveDateTimeFormat(java.lang.String token, java.lang.String dateTimeFormat)
           
 boolean setCaptchaDebugMode(java.lang.String token, boolean enable)
          Sets the captcha mode into debug mode.
 boolean setCaptchaMode(java.lang.String token, boolean enable)
          Sets the captcha mode
 boolean setContentTextProperty(java.lang.String token, java.lang.String entityId, java.lang.String key, java.lang.String value)
          Sets a text content property for a content entity given its id
 boolean setEnableJavascriptTop(java.lang.String token, boolean set)
          Set the config for serving javascripts in the header.
 void setFuncTestRpcImpl(FuncTestRpcHandler funcTestRpcImpl)
           
 boolean setGlobalTheme(java.lang.String token, java.lang.String themeKey)
          Sets the global theme
 boolean setLocaleForUser(java.lang.String token, java.lang.String username, java.lang.String locale)
          Sets the locale preference for the user to the given named locale.
 boolean setSharedMode(java.lang.String token, boolean set)
           
 java.lang.Boolean setSystemProperty(java.lang.String token, java.lang.String name, java.lang.String value)
          Set a system property on the server to the supplied value.
 boolean setThemeForSpace(java.lang.String token, java.lang.String spaceKey, java.lang.String themeKey)
          Sets the theme for the specifiec space
 void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
           
 boolean setUserDetails(java.lang.String token, java.lang.String username, java.lang.String fullName, java.lang.String email)
          Sets the fullname and email address of a user with a given username.
 boolean shutdownQuartz(java.lang.String token)
          Shutdown the quartz scheduler to ensure single threadedness for testing
 boolean startActivity(java.lang.String key, java.lang.String user)
          Call startActivity on the heartbeatManager bean
 boolean triggerJob(java.lang.String token, java.lang.String jobName)
          Triggers a named job in the quartz scheduler synchronously.
 boolean uninstallPlugin(java.lang.String token, java.lang.String pluginKey)
          Uninstall a plugin.
 boolean unregisterEventListener(java.lang.String token, java.lang.String eventClassName)
          Unregisters the temporary listener registered for the specified event.
 boolean unregisterTestAppenderForClass(java.lang.String token, java.lang.String className)
           
 java.util.Hashtable updateDraft(java.lang.String token, java.util.Hashtable draft)
          Updates a draft located using the draft owner and draft type.
 boolean waitForEvent(java.lang.String token, java.lang.String eventClassName, int timeout)
          Waits for an event to occur and returns when it has finished.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FuncTestRpcDelegator

public FuncTestRpcDelegator()
Method Detail

logMessage

public boolean logMessage(java.lang.String token,
                          java.lang.String destination,
                          java.lang.String message)
                   throws RemoteException
Description copied from interface: FuncTestRpcHandler
Log a message to the server's console.

Only administrators can log messages.

The destination of the message has the following valid values:

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

changeLoggerLevel

public java.lang.String changeLoggerLevel(java.lang.String token,
                                          java.lang.String loggerName,
                                          java.lang.String level)
                                   throws RemoteException
Description copied from interface: FuncTestRpcHandler

Change the level of the specified logger.

The level parameter can be one of -


nukeSpacesAndFlushEverything

public boolean nukeSpacesAndFlushEverything(java.lang.String token)
                                     throws RemoteException
Description copied from interface: FuncTestRpcHandler
Kill all the spaces and flush all the queues and caches.

Specified by:
nukeSpacesAndFlushEverything in interface FuncTestRpcHandler
Throws:
RemoteException

nukeUserAndGroupDependentObjects

public boolean nukeUserAndGroupDependentObjects(java.lang.String token)
                                         throws RemoteException
Description copied from interface: FuncTestRpcHandler
Remove the dependencies of all users and groups, except the default dependencies of the default groups and the current user. This also deletes all mail servers , as it is significantly faster to batch up RPC invocations.

Specified by:
nukeUserAndGroupDependentObjects in interface FuncTestRpcHandler
Throws:
RemoteException

removeAllOtherUsers

public boolean removeAllOtherUsers(java.lang.String token)
                            throws RemoteException
Description copied from interface: FuncTestRpcHandler
Remove all users except the current user.

Specified by:
removeAllOtherUsers in interface FuncTestRpcHandler
Throws:
RemoteException

removeAllGroupsExceptDefaults

public boolean removeAllGroupsExceptDefaults(java.lang.String token)
                                      throws RemoteException
Description copied from interface: FuncTestRpcHandler
Remove all groups aside from the default Confluence groups

Specified by:
removeAllGroupsExceptDefaults in interface FuncTestRpcHandler
Throws:
RemoteException

disconnectUser

public boolean disconnectUser(java.lang.String token,
                              java.lang.String username)
                       throws RemoteException
Description copied from interface: FuncTestRpcHandler
Disconnect a user from Confluence. Removes all their permissions, group memberships, their profile information and their personal space.

Specified by:
disconnectUser in interface FuncTestRpcHandler
Throws:
RemoteException

disconnectGroup

public boolean disconnectGroup(java.lang.String token,
                               java.lang.String groupname)
                        throws RemoteException
Description copied from interface: FuncTestRpcHandler
Disconnect a group from Confluence. Removes all its permissions.

Specified by:
disconnectGroup in interface FuncTestRpcHandler
Throws:
RemoteException

isCurrentApplicationSet

public boolean isCurrentApplicationSet(java.lang.String token)
                                throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Check whether or not the trustedApplicationManager has its currentApplication set.

Specified by:
isCurrentApplicationSet in interface FuncTestRpcHandler
Throws:
NotPermittedException

massCreateAttachments

public boolean massCreateAttachments(java.lang.String token,
                                     java.lang.String pageId,
                                     java.lang.String prefix,
                                     java.lang.String numAttachments)
                              throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Create a whole series of attachments on a single page.

Specified by:
massCreateAttachments in interface FuncTestRpcHandler
Throws:
java.lang.Exception

resetTheme

public boolean resetTheme(java.lang.String token)
                   throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Reset the global theme to the default theme.

Specified by:
resetTheme in interface FuncTestRpcHandler
Throws:
java.lang.Exception

getGlobalConfiguredTheme

public java.lang.String getGlobalConfiguredTheme(java.lang.String token)
                                          throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Get the key of the configured global theme, whether or not that theme exists.

Specified by:
getGlobalConfiguredTheme in interface FuncTestRpcHandler
Throws:
java.lang.Exception

getConfiguredThemeForSpace

public java.lang.String getConfiguredThemeForSpace(java.lang.String token,
                                                   java.lang.String spaceKey)
                                            throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Get the key of the configured theme for a space, whether or not that theme exists.

Specified by:
getConfiguredThemeForSpace in interface FuncTestRpcHandler
Throws:
java.lang.Exception

setGlobalTheme

public boolean setGlobalTheme(java.lang.String token,
                              java.lang.String themeKey)
                       throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Sets the global theme

Specified by:
setGlobalTheme in interface FuncTestRpcHandler
themeKey - - the complete theme key
Throws:
java.lang.Exception

setThemeForSpace

public boolean setThemeForSpace(java.lang.String token,
                                java.lang.String spaceKey,
                                java.lang.String themeKey)
                         throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Sets the theme for the specifiec space

Specified by:
setThemeForSpace in interface FuncTestRpcHandler
spaceKey - - the key of the space to change
themeKey - - the complete theme key
Throws:
java.lang.Exception

uninstallPlugin

public boolean uninstallPlugin(java.lang.String token,
                               java.lang.String pluginKey)
                        throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Uninstall a plugin. (There's an install method in the standard rpc plugin)

Specified by:
uninstallPlugin in interface FuncTestRpcHandler
Returns:
true because a return type is required by XMLRPC
Throws:
NotPermittedException

isPluginInstalled

public boolean isPluginInstalled(java.lang.String token,
                                 java.lang.String pluginKey)
                          throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Check whether a plugin is installed or not.

Specified by:
isPluginInstalled in interface FuncTestRpcHandler
Returns:
true if the plugin is installed, false otherwise.
Throws:
NotPermittedException

disablePlugin

public boolean disablePlugin(java.lang.String token,
                             java.lang.String pluginKey)
                      throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Disable a plugin.

Specified by:
disablePlugin in interface FuncTestRpcHandler
Returns:
true because a return type is required by XMLRPC
Throws:
NotPermittedException

enablePlugin

public boolean enablePlugin(java.lang.String token,
                            java.lang.String pluginKey)
                     throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Enable a plugin.

Specified by:
enablePlugin in interface FuncTestRpcHandler
Returns:
true because a return type is required by XMLRPC
Throws:
NotPermittedException

enablePluginModule

public boolean enablePluginModule(java.lang.String token,
                                  java.lang.String pluginKey,
                                  java.lang.String moduleKey)
                           throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Enable plugin module

Specified by:
enablePluginModule in interface FuncTestRpcHandler
pluginKey - the key of the plugin
moduleKey - the key of the module
Returns:
true because a return type is required by XMLRPC
Throws:
NotPermittedException

disablePluginModule

public boolean disablePluginModule(java.lang.String token,
                                   java.lang.String pluginKey,
                                   java.lang.String moduleKey)
                            throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Disable plugin module

Specified by:
disablePluginModule in interface FuncTestRpcHandler
pluginKey - the key of the plugin
moduleKey - the key of the module
Returns:
true because a return type is required by XMLRPC
Throws:
NotPermittedException

getRecentEvents

public java.util.Vector getRecentEvents(java.lang.String token)
                                 throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Returns a vector of class names from the last 10 events fired.

Specified by:
getRecentEvents in interface FuncTestRpcHandler
Throws:
java.lang.Exception

isSpringComponentPresent

public boolean isSpringComponentPresent(java.lang.String token,
                                        java.lang.String name)
Description copied from interface: FuncTestRpcHandler
Returns true if a Spring component with the given name exists in the application context.

Specified by:
isSpringComponentPresent in interface FuncTestRpcHandler

pauseJob

public boolean pauseJob(java.lang.String token,
                        java.lang.String jobName)
                 throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Pauses a named job in the quartz scheduler

Specified by:
pauseJob in interface FuncTestRpcHandler
Throws:
java.lang.Exception

resumeJob

public boolean resumeJob(java.lang.String token,
                         java.lang.String jobName)
                  throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Resumes a named job in the quartz scheduler

Specified by:
resumeJob in interface FuncTestRpcHandler
Throws:
java.lang.Exception

triggerJob

public boolean triggerJob(java.lang.String token,
                          java.lang.String jobName)
                   throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Triggers a named job in the quartz scheduler synchronously. Note that Quartz's triggerJob function is asynchronous, but we use a listener internally to provide synchronicity.

Specified by:
triggerJob in interface FuncTestRpcHandler
Throws:
java.lang.Exception

waitForEvent

public boolean waitForEvent(java.lang.String token,
                            java.lang.String eventClassName,
                            int timeout)
                     throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Waits for an event to occur and returns when it has finished.

Specified by:
waitForEvent in interface FuncTestRpcHandler
eventClassName - the fully qualified classname of the event to wait for.
timeout - number of milliseconds to wait for the event before giving up completely.
Returns:
true if the event occurs within the timeout.
Throws:
java.lang.Exception

shutdownQuartz

public boolean shutdownQuartz(java.lang.String token)
                       throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Shutdown the quartz scheduler to ensure single threadedness for testing

Specified by:
shutdownQuartz in interface FuncTestRpcHandler
Throws:
java.lang.Exception

removeBandanaKey

public boolean removeBandanaKey(java.lang.String token,
                                java.lang.String space,
                                java.lang.String key)
Description copied from interface: FuncTestRpcHandler
Remove a key from Bandana

Specified by:
removeBandanaKey in interface FuncTestRpcHandler

getContentPropertyKeys

public java.util.Vector getContentPropertyKeys(java.lang.String token,
                                               java.lang.String entityId)
Description copied from interface: FuncTestRpcHandler
Get the content property keys for a content entity given its id

Specified by:
getContentPropertyKeys in interface FuncTestRpcHandler

setContentTextProperty

public boolean setContentTextProperty(java.lang.String token,
                                      java.lang.String entityId,
                                      java.lang.String key,
                                      java.lang.String value)
Description copied from interface: FuncTestRpcHandler
Sets a text content property for a content entity given its id

Specified by:
setContentTextProperty in interface FuncTestRpcHandler

getPersonalInformationId

public java.lang.String getPersonalInformationId(java.lang.String token,
                                                 java.lang.String username)
Description copied from interface: FuncTestRpcHandler
Gets the personal information id for a given username

Specified by:
getPersonalInformationId in interface FuncTestRpcHandler

removePersonalInformation

public boolean removePersonalInformation(java.lang.String token,
                                         java.lang.String username)
                                  throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
PersonalInformation gets created automatically by the standard create user methods. This method exists to allow testing that the PersonalInformation will get created appropriately when it doesn't exist (eg for LDAP users logging in).

Specified by:
removePersonalInformation in interface FuncTestRpcHandler
username - user whose personalInformation will be removed
Returns:
true because it has to return something
Throws:
NotPermittedException

getLocaleForUser

public java.lang.String getLocaleForUser(java.lang.String token,
                                         java.lang.String username)
Description copied from interface: FuncTestRpcHandler
Gets the locale preference for the user.

Specified by:
getLocaleForUser in interface FuncTestRpcHandler

setLocaleForUser

public boolean setLocaleForUser(java.lang.String token,
                                java.lang.String username,
                                java.lang.String locale)
                         throws RemoteException
Description copied from interface: FuncTestRpcHandler
Sets the locale preference for the user to the given named locale.

Specified by:
setLocaleForUser in interface FuncTestRpcHandler
Throws:
RemoteException

setUserDetails

public boolean setUserDetails(java.lang.String token,
                              java.lang.String username,
                              java.lang.String fullName,
                              java.lang.String email)
                       throws RemoteException
Description copied from interface: FuncTestRpcHandler
Sets the fullname and email address of a user with a given username.

Specified by:
setUserDetails in interface FuncTestRpcHandler
Returns:
true because XMLRPC methods have to return something
Throws:
RemoteException - if the user was not found.

putStringMappingInCache

public boolean putStringMappingInCache(java.lang.String token,
                                       java.lang.String cacheName,
                                       java.lang.String key,
                                       java.lang.String value)
                                throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Map a key to a value for a given cache. Only accepts strings. This allows us to manipulate the number of entries in the cache. This method will create the named cache if it doesn't exist.

Specified by:
putStringMappingInCache in interface FuncTestRpcHandler
Returns:
true because void is not allowed.
Throws:
java.lang.Exception

flushAllCaches

public boolean flushAllCaches(java.lang.String token)
                       throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Flushes all the caches.

Specified by:
flushAllCaches in interface FuncTestRpcHandler
Returns:
true because void isn't allowed.
Throws:
java.lang.Exception

startActivity

public boolean startActivity(java.lang.String key,
                             java.lang.String user)
                      throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Call startActivity on the heartbeatManager bean

Specified by:
startActivity in interface FuncTestRpcHandler
Throws:
java.lang.Exception

getUsersForActivity

public java.util.Vector getUsersForActivity(java.lang.String key)
                                     throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Call getUsersForActivity on the heartbeatManager bean

Specified by:
getUsersForActivity in interface FuncTestRpcHandler
Throws:
java.lang.Exception

setSharedMode

public boolean setSharedMode(java.lang.String token,
                             boolean set)
                      throws java.lang.Exception
Specified by:
setSharedMode in interface FuncTestRpcHandler
Throws:
java.lang.Exception

setEnableJavascriptTop

public boolean setEnableJavascriptTop(java.lang.String token,
                                      boolean set)
Description copied from interface: FuncTestRpcHandler
Set the config for serving javascripts in the header.

Specified by:
setEnableJavascriptTop in interface FuncTestRpcHandler

registerEventListener

public boolean registerEventListener(java.lang.String token,
                                     java.lang.String eventClassName)
                              throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Registers a temporary event listener on the server to listen for the specified event. It is recommended that clients also unregister the event listener using FuncTestRpcHandler.unregisterEventListener(String, String) in a finally clause to ensure the temporary listener is cleaned up.

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

Specified by:
registerEventListener in interface FuncTestRpcHandler
Throws:
java.lang.Exception

unregisterEventListener

public boolean unregisterEventListener(java.lang.String token,
                                       java.lang.String eventClassName)
                                throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Unregisters the temporary listener registered for the specified event.

Specified by:
unregisterEventListener in interface FuncTestRpcHandler
Throws:
java.lang.Exception

removeMailServer

public boolean removeMailServer(java.lang.String token,
                                java.lang.String serverName)
Description copied from interface: FuncTestRpcHandler
Remove the named mail server.

Specified by:
removeMailServer in interface FuncTestRpcHandler
Parameters:
token - the rpc authentication token
serverName - the name of the server to be removed.
Returns:
true if the named server was removed (or there was no server by that name), otherwise false.

getLeastRecentTestAppenderLogMessage

public java.lang.String getLeastRecentTestAppenderLogMessage(java.lang.String token,
                                                             java.lang.String className)
Specified by:
getLeastRecentTestAppenderLogMessage in interface FuncTestRpcHandler

registerTestAppenderForClass

public boolean registerTestAppenderForClass(java.lang.String token,
                                            java.lang.String className)
Specified by:
registerTestAppenderForClass in interface FuncTestRpcHandler

unregisterTestAppenderForClass

public boolean unregisterTestAppenderForClass(java.lang.String token,
                                              java.lang.String className)
Specified by:
unregisterTestAppenderForClass in interface FuncTestRpcHandler

logTestMessageForClass

public boolean logTestMessageForClass(java.lang.String token,
                                      java.lang.String className,
                                      java.lang.String message,
                                      java.lang.String level)
Specified by:
logTestMessageForClass in interface FuncTestRpcHandler

getLocalisedText

public java.lang.String getLocalisedText(java.lang.String token,
                                         java.lang.String messageKey)
Description copied from interface: FuncTestRpcHandler
Get the localised string for given the message key in the logged-in user's locale.

Specified by:
getLocalisedText in interface FuncTestRpcHandler
Parameters:
token - the rpc authentication token
messageKey - the i18n message key
Returns:
the localised version of the message key in the logged-in user's locale, or the message key itself if it does not have a corresponding value.

removeUserUncleanly

public boolean removeUserUncleanly(java.lang.String token,
                                   java.lang.String username)
                            throws java.lang.Exception
Description copied from interface: FuncTestRpcHandler
Remove a User without removing the things that refer to that user.

Specified by:
removeUserUncleanly in interface FuncTestRpcHandler
Throws:
java.lang.Exception

doesDraftExist

public boolean doesDraftExist(java.lang.String token,
                              java.lang.String contentId,
                              java.lang.String owner,
                              java.lang.String draftType)
Description copied from interface: FuncTestRpcHandler
Determines if a draft of the specified type and belonging to the specified owner exists.

Specified by:
doesDraftExist in interface FuncTestRpcHandler
Parameters:
token - rpc authentication token
contentId - id of the content this draft is for ('0' for new content)
owner - owner/author of the draft
draftType - type of content this draft is for
Returns:
true if a draft of the specified type and belonging to the specified owner exists, else false

createDraft

public java.util.Hashtable createDraft(java.lang.String token,
                                       java.util.Hashtable draft)
Description copied from interface: FuncTestRpcHandler
Creates a draft for the draft owner and draft type with the specified title and content. If the draft already exists the current draft is updated.

Specified by:
createDraft in interface FuncTestRpcHandler
Parameters:
token - rpc authentication token
draft - the draft object to create Required: "owner" - the username of owner/author of the draft. Set to null for anonymous users. "draftType" - type of content the draft is for i.e. BlogPost.getType() or Page.getType(). "title" - title of the draft. "content" - content of the draft as a String. 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 java.util.Hashtable updateDraft(java.lang.String token,
                                       java.util.Hashtable draft)
Description copied from interface: FuncTestRpcHandler
Updates a draft located using the draft owner and draft type. Draft is then updated with the specified title and content

Specified by:
updateDraft in interface FuncTestRpcHandler
Parameters:
token - rpc authentication token
draft - the draft object to create see #createDraft(java.lang.String, java.util.Hashtable)
Returns:
the draft updated returns null if the draft does not exist

removeDrafts

public boolean removeDrafts(java.lang.String token,
                            java.lang.String username)
Description copied from interface: FuncTestRpcHandler
Removes all drafts owned by the specified User.

Specified by:
removeDrafts in interface FuncTestRpcHandler
Parameters:
token - rpc authentication token
username - user to remove drafts for
Returns:
true if this is successful, false if no user with this name.

clearQueue

public boolean clearQueue(java.lang.String token,
                          java.lang.String queueName)
Description copied from interface: FuncTestRpcHandler
Removes all items from the specified queue

Specified by:
clearQueue in interface FuncTestRpcHandler
Returns:
true if this is successful, false if no queue with this name exists

getQueueSize

public int getQueueSize(java.lang.String token,
                        java.lang.String queueName)
Description copied from interface: FuncTestRpcHandler
Returns the size of the task queue with the specified name.

Specified by:
getQueueSize in interface FuncTestRpcHandler
Returns:
the size of the task queue with the specified name.

addUserAnyCase

public boolean addUserAnyCase(java.lang.String token,
                              java.lang.String username,
                              java.lang.String email,
                              java.lang.String fullname,
                              java.lang.String password)
                       throws RemoteException
Description copied from interface: FuncTestRpcHandler
Allows addition of a user without enforcing that the username be all lower case. This is for use in tests where you need mixed case user - useful for emulating an external provider such as LDAP.

Specified by:
addUserAnyCase in interface FuncTestRpcHandler
Throws:
NotPermittedException - if you do not have permissions to add the user.
RemoteException

addGroupAnyCase

public boolean addGroupAnyCase(java.lang.String token,
                               java.lang.String groupname)
                        throws RemoteException
Description copied from interface: FuncTestRpcHandler
Allows addition of a group without enforcing that the name be all lower case. This is for use in tests where you need mixed case user - useful for emulating an external provider such as LDAP.

Specified by:
addGroupAnyCase in interface FuncTestRpcHandler
groupname - the name of the group to add
Returns:
true if successfully added, otherwise false
Throws:
RemoteException

changeSpaceCreatedDate

public boolean changeSpaceCreatedDate(java.lang.String token,
                                      java.lang.String spaceKey,
                                      java.util.Date createdDate)
                               throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the created date of a space

Specified by:
changeSpaceCreatedDate in interface FuncTestRpcHandler
spaceKey - the space key of the space to change the created date
Throws:
RemoteException

changeCommentCreatedDate

public boolean changeCommentCreatedDate(java.lang.String token,
                                        java.lang.String commentId,
                                        java.util.Date createdDate)
                                 throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the created date of a comment

Specified by:
changeCommentCreatedDate in interface FuncTestRpcHandler
Throws:
RemoteException

changePageCreatedDate

public boolean changePageCreatedDate(java.lang.String token,
                                     java.lang.String pageId,
                                     java.util.Date createdDate)
                              throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the created date of a page

Specified by:
changePageCreatedDate in interface FuncTestRpcHandler
pageId - the page id of the page to change the created date
Throws:
RemoteException

changeAttachmentCreatedDate

public boolean changeAttachmentCreatedDate(java.lang.String token,
                                           java.lang.String contentId,
                                           java.lang.String attachmentFileName,
                                           java.util.Date createdDate)
                                    throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the created date of an attachment

Specified by:
changeAttachmentCreatedDate in interface FuncTestRpcHandler
contentId - the id of the page or blogpost the attachment is attached to
attachmentFileName - the attachment file name of the attachment to change the created date
Throws:
RemoteException

changeBlogPostModifiedDate

public boolean changeBlogPostModifiedDate(java.lang.String token,
                                          java.lang.String blogId,
                                          java.util.Date modifiedDate)
                                   throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the modified date of a blog post

Specified by:
changeBlogPostModifiedDate in interface FuncTestRpcHandler
blogId - the id of the blog to modify
modifiedDate - the last modification date to be set.
Returns:
true if successful, otherwise false.
Throws:
RemoteException

changePageModificationDate

public boolean changePageModificationDate(java.lang.String token,
                                          java.lang.String pageId,
                                          java.util.Date modificationDate)
                                   throws RemoteException
Description copied from interface: FuncTestRpcHandler
Change the modification date of a page

Specified by:
changePageModificationDate in interface FuncTestRpcHandler
pageId - the page id of the page to change the modification date
modificationDate - the last modification date to be set.
Throws:
RemoteException

getVersionForPage

public int getVersionForPage(java.lang.String token,
                             java.lang.String pageId)
                      throws RemoteException
Description copied from interface: FuncTestRpcHandler
Get the version number for the page with pageId

Specified by:
getVersionForPage in interface FuncTestRpcHandler
Throws:
RemoteException

saveDateFormat

public boolean saveDateFormat(java.lang.String token,
                              java.lang.String dateFormat)
Specified by:
saveDateFormat in interface FuncTestRpcHandler

saveDateTimeFormat

public boolean saveDateTimeFormat(java.lang.String token,
                                  java.lang.String dateTimeFormat)
Specified by:
saveDateTimeFormat in interface FuncTestRpcHandler

addMailServer

public boolean addMailServer(java.lang.String token,
                             java.lang.String name,
                             java.lang.String from,
                             java.lang.String subjectPrefix,
                             java.lang.String hostname,
                             int port)
Specified by:
addMailServer in interface FuncTestRpcHandler

convertMarkupToXhtml

public java.lang.String convertMarkupToXhtml(java.lang.String token,
                                             java.lang.String wikiMarkup,
                                             java.lang.String pageId)
Description copied from interface: FuncTestRpcHandler
Render a page as XHTML.

Specified by:
convertMarkupToXhtml in interface FuncTestRpcHandler

convertXhtmlToMarkup

public java.lang.String convertXhtmlToMarkup(java.lang.String token,
                                             java.lang.String xhtml,
                                             java.lang.String pageId)
Description copied from interface: FuncTestRpcHandler
Convert XHTML to WikiMarkup.

Specified by:
convertXhtmlToMarkup in interface FuncTestRpcHandler

setFuncTestRpcImpl

public void setFuncTestRpcImpl(FuncTestRpcHandler funcTestRpcImpl)

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

removeAllJohnsonEvents

public boolean removeAllJohnsonEvents(java.lang.String token)
Description copied from interface: FuncTestRpcHandler
Removes all Johnson events from Confluence

Specified by:
removeAllJohnsonEvents in interface FuncTestRpcHandler

setCaptchaMode

public boolean setCaptchaMode(java.lang.String token,
                              boolean enable)
Description copied from interface: FuncTestRpcHandler
Sets the captcha mode

Specified by:
setCaptchaMode in interface FuncTestRpcHandler

setCaptchaDebugMode

public boolean setCaptchaDebugMode(java.lang.String token,
                                   boolean enable)
Description copied from interface: FuncTestRpcHandler
Sets the captcha mode into debug mode. See CaptchaManager.setDebugMode(boolean).

Specified by:
setCaptchaDebugMode in interface FuncTestRpcHandler

createJohnsonEvent

public boolean createJohnsonEvent(java.lang.String token,
                                  java.lang.String message)
Description copied from interface: FuncTestRpcHandler
Creates a Johnson event inside Confluence. This method is used to test the ConfluenceJohnsonFilter.

Specified by:
createJohnsonEvent in interface FuncTestRpcHandler
message - the description of the event to create

setSystemProperty

public java.lang.Boolean setSystemProperty(java.lang.String token,
                                           java.lang.String name,
                                           java.lang.String value)
Description copied from interface: FuncTestRpcHandler
Set a system property on the server to the supplied value.

Specified by:
setSystemProperty in interface FuncTestRpcHandler
name - the name of the property
value - the value of the property
Returns:
always true since XML RPC can't handle void

clearIndex

public boolean clearIndex(java.lang.String token)
Description copied from interface: FuncTestRpcHandler
Blows away the main Confluence search index.

Specified by:
clearIndex in interface FuncTestRpcHandler

restoreAbstractPage

public boolean restoreAbstractPage(java.lang.String token,
                                   java.lang.String abstractPageId)
Description copied from interface: FuncTestRpcHandler
Restores an abstract page from the trash.

Specified by:
restoreAbstractPage in interface FuncTestRpcHandler

getIdOfPagePermission

public java.lang.String getIdOfPagePermission(java.lang.String token,
                                              java.lang.String contentId,
                                              java.lang.String permissionType,
                                              java.lang.String username)
Specified by:
getIdOfPagePermission in interface FuncTestRpcHandler
Returns:
the id of the identified content permission or 0 if there is no match found.

createUserMacro

public boolean createUserMacro(java.lang.String token,
                               java.lang.String name,
                               boolean hasBody,
                               java.lang.String bodyType,
                               java.lang.String outputType,
                               java.lang.String template)
                        throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Create a User Macro

Specified by:
createUserMacro in interface FuncTestRpcHandler
bodyType - how the body should be treated. "raw", "escapehtml", or "rendered". May be null only if hasBody is false.
outputType - whether the macro is expected to return html or wiki markup. "html" or "wiki".
template - the velocity rendered by the macro
Returns:
true all the time because XMLRPC methods need a non-void return type.
Throws:
NotPermittedException

removeUserMacro

public boolean removeUserMacro(java.lang.String token,
                               java.lang.String name)
                        throws NotPermittedException
Description copied from interface: FuncTestRpcHandler
Remove a User Macro with the given name if it exists.

Specified by:
removeUserMacro in interface FuncTestRpcHandler
Returns:
true all the time because XMLRPC methods need a non-void return type.
Throws:
NotPermittedException


Copyright © 2003-2010 Atlassian. All Rights Reserved.