com.atlassian.confluence.test.rpc
Class FuncTestRpcHandlerImpl

java.lang.Object
  com.atlassian.confluence.test.rpc.FuncTestRpcHandlerImpl

All Implemented Interfaces:

FuncTestRpcHandler

public class FuncTestRpcHandlerImpl
extends java.lang.Object
implements FuncTestRpcHandler

Field Summary

static org.apache.log4j.Category

log

Constructor Summary

FuncTestRpcHandlerImpl()

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	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	changeCommentCreatedDate(java.lang.String token, java.lang.String commentId, java.util.Date createdDate) Change the created date of a comment
boolean	changeSpaceCreatedDate(java.lang.String token, java.lang.String spaceKey, java.util.Date createdDate) Change the created date of a space
boolean	clearQueue(java.lang.String token, java.lang.String queueName) Removes all items from the specified queue
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	flushAllCaches(java.lang.String token) Flushes all the caches.
java.util.Vector	getContentPropertyKeys(java.lang.String token, java.lang.String entityId) Get the content property keys for a content entity given its id
FuncTestEventQueue	getFuncTestEventQueue()
java.lang.String	getLeastRecentTestAppenderLogMessage(java.lang.String token, java.lang.String className)
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.
com.atlassian.mail.server.MailServerManager	getMailServerManager()
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
boolean	isCurrentApplicationSet(java.lang.String token) Check whether or not the trustedApplicationManager has its currentApplication set.
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	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	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	removeMailServer(java.lang.String token, java.lang.String serverName) Remove the named mail server.
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	resumeJob(java.lang.String token, java.lang.String jobName) Resumes a named job in the quartz scheduler
void	setAttachmentManager(AttachmentManager attachmentManager)
void	setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
void	setCacheManager(com.atlassian.cache.CacheManager cacheManager)
void	setCaptchaManager(CaptchaManager captchaManager)
void	setCommentManager(CommentManager commentManager)
void	setContentEntityManager(ContentEntityManager contentEntityManager)
void	setContentPropertyManager(ContentPropertyManager contentPropertyManager)
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
void	setDraftManager(DraftManager draftManager)
void	setEventManager(com.atlassian.event.EventManager eventManager)
void	setFuncTestEventQueue(FuncTestEventQueue funcTestEventQueue)
void	setHeartbeatManager(HeartbeatManager heartbeatManager)
void	setIndexManager(ConfluenceIndexManager indexManager)
void	setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
void	setPageManager(PageManager pageManager)
void	setPermissionManager(PermissionManager permissionManager)
void	setPersonalInformationManager(PersonalInformationManager personalInformationManager)
void	setScheduler(org.quartz.Scheduler scheduler)
void	setSettingsManager(SettingsManager settingsManager)
boolean	setSharedMode(java.lang.String token, boolean set)
void	setSpaceManager(SpaceManager spaceManager)
void	setSpacePermissionManager(SpacePermissionManager spacePermissionManager)
void	setTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)
void	setThemeManager(ThemeManager themeManager)
void	setTrustedApplicationsManager(TrustedApplicationsManager trustedApplicationsManager)
void	setUserAccessor(UserAccessor userAccessor)
void	setUserManager(com.atlassian.user.UserManager userManager)
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	unregisterTestAppenderForClass(java.lang.String token, java.lang.String className)
boolean	updateDraft(java.lang.String token, java.lang.String draftOwner, java.lang.String draftType, java.lang.String title, java.lang.String content) 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

Field Detail

log

public static final org.apache.log4j.Category log

Constructor Detail

FuncTestRpcHandlerImpl

public FuncTestRpcHandlerImpl()

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:

• info - message will be logged at INFO level
• debug - message will be logged at DEBUG level
• warn - message will be logged at WARN level
• error - message will be logged at ERROR level
• sout - message will be written via System.out.println
• serr - message will be written via System.err.println

Specified by:

logMessage in interface FuncTestRpcHandler

Parameters:

token - The token idenfitying the user.

destination - The destination of the message to be logged

message - The text message to be logged to the console

Returns:

boolean True if the message is logged (ie destination is a valid level)

Throws:

RemoteException

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 NotPermittedException

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.

Specified by:

nukeUserAndGroupDependentObjects in interface FuncTestRpcHandler

Throws:

NotPermittedException

disconnectUser

public boolean disconnectUser(java.lang.String token,
                              java.lang.String userName)
                       throws NotPermittedException

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:

NotPermittedException

disconnectGroup

public boolean disconnectGroup(java.lang.String token,
                               java.lang.String groupName)
                        throws NotPermittedException

Description copied from interface: FuncTestRpcHandler

Disconnect a group from Confluence. Removes all its permissions.

Specified by:

disconnectGroup in interface FuncTestRpcHandler

Throws:

NotPermittedException

removeAllOtherUsers

public boolean removeAllOtherUsers(java.lang.String token)
                            throws NotPermittedException

Description copied from interface: FuncTestRpcHandler

Remove all users except the current user.

Specified by:

removeAllOtherUsers in interface FuncTestRpcHandler

Throws:

NotPermittedException

removeAllGroupsExceptDefaults

public boolean removeAllGroupsExceptDefaults(java.lang.String token)
                                      throws NotPermittedException

Description copied from interface: FuncTestRpcHandler

Remove all groups aside from the default Confluence groups

Specified by:

removeAllGroupsExceptDefaults in interface FuncTestRpcHandler

Throws:

NotPermittedException

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

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

putStringMappingInCache

public boolean putStringMappingInCache(java.lang.String token,
                                       java.lang.String cacheName,
                                       java.lang.String key,
                                       java.lang.String value)

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.

flushAllCaches

public boolean flushAllCaches(java.lang.String token)

Description copied from interface: FuncTestRpcHandler

Flushes all the caches.

Specified by:

flushAllCaches in interface FuncTestRpcHandler

Returns:

true because void isn't allowed.

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)

Specified by:

setSharedMode in interface FuncTestRpcHandler

removeUserUncleanly

public boolean removeUserUncleanly(java.lang.String token,
                                   java.lang.String username)
                            throws com.atlassian.user.EntityException

Description copied from interface: FuncTestRpcHandler

Remove a User without removing the things that refer to that user.

Specified by:

removeUserUncleanly in interface FuncTestRpcHandler

Throws:

com.atlassian.user.EntityException

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

updateDraft

public boolean updateDraft(java.lang.String token,
                           java.lang.String draftOwner,
                           java.lang.String draftType,
                           java.lang.String title,
                           java.lang.String content)

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

draftOwner - owner/author of the draft

draftType - type of content this draft is for

title - update draft to this title

content - update this draft to this content

Returns:

true if the draft was found and successfully updated. Returns false if draft is not found.

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.

Throws:

java.lang.IllegalArgumentException - if no queue could be found with the specified queueName.

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.

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

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.

setIndexManager

public void setIndexManager(ConfluenceIndexManager indexManager)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

setAttachmentManager

public void setAttachmentManager(AttachmentManager attachmentManager)

setPageManager

public void setPageManager(PageManager pageManager)

setThemeManager

public void setThemeManager(ThemeManager themeManager)

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

setFuncTestEventQueue

public void setFuncTestEventQueue(FuncTestEventQueue funcTestEventQueue)

setScheduler

public void setScheduler(org.quartz.Scheduler scheduler)

getFuncTestEventQueue

public FuncTestEventQueue getFuncTestEventQueue()

setBandanaManager

public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)

setContentPropertyManager

public void setContentPropertyManager(ContentPropertyManager contentPropertyManager)

setContentEntityManager

public void setContentEntityManager(ContentEntityManager contentEntityManager)

setPersonalInformationManager

public void setPersonalInformationManager(PersonalInformationManager personalInformationManager)

setCacheManager

public void setCacheManager(com.atlassian.cache.CacheManager cacheManager)

setHeartbeatManager

public void setHeartbeatManager(HeartbeatManager heartbeatManager)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setUserManager

public void setUserManager(com.atlassian.user.UserManager userManager)

setDraftManager

public void setDraftManager(DraftManager draftManager)

setTaskManager

public void setTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)

getMailServerManager

public com.atlassian.mail.server.MailServerManager getMailServerManager()

setMailServerManager

public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)

setEventManager

public void setEventManager(com.atlassian.event.EventManager eventManager)

setSpacePermissionManager

public void setSpacePermissionManager(SpacePermissionManager spacePermissionManager)

setTrustedApplicationsManager

public void setTrustedApplicationsManager(TrustedApplicationsManager trustedApplicationsManager)

setCommentManager

public void setCommentManager(CommentManager commentManager)