Package com.atlassian.confluence.admin.actions.mail

Class ViewMailQueueAction

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.admin.actions.mail.ViewMailQueueAction

All Implemented Interfaces:

WebInterface, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.Validateable

public class ViewMailQueueAction
extends ConfluenceActionSupport

getMailQueue() returns an ErrorQueuedTaskQueue. This queue object maintains 2 queues:

• The first is a queue of Task objects that may be decorated by a TaskDecorator (which is just a wrapper that keeps count of number of times the task has executed)
• The second is the error queue which is of type DefaultTaskQueue. Items in this queue are undecorated.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
ViewMailQueueAction()

Method Summary

Modifier and Type	Method	Description
String	doDeleteErrorQueue()	removes all items from the error queue
String	doDeleteQueue()	used in functional tests to efficiently clear the list of notifications for teardown()
String	doFlush()
String	doResend()	transfer items on the error queue onto the normal queue and flush
String	execute()
Collection<com.atlassian.core.task.Task>	getErrorMailQueueItemsFromTasks()
com.atlassian.core.task.TaskQueueWithErrorQueue	getMailQueue()
Collection<com.atlassian.core.task.Task>	getMailQueueItemsFromTasks()
String	getPage()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
void	setMailTaskQueue(com.atlassian.core.task.TaskQueueWithErrorQueue queue)
void	setPage(String page)

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getCurrentRequest, getCurrentResponse, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSkipIsPermitted, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermitted

Methods inherited from class com.atlassian.confluence.core.AbstractI18nActionSupport

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

ViewMailQueueAction

public ViewMailQueueAction()

Method Details

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class ConfluenceActionSupport

execute

public String execute()

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class org.apache.struts2.ActionSupport

getMailQueue

public com.atlassian.core.task.TaskQueueWithErrorQueue getMailQueue()

getMailQueueItemsFromTasks

public Collection<com.atlassian.core.task.Task> getMailQueueItemsFromTasks()

getErrorMailQueueItemsFromTasks

public Collection<com.atlassian.core.task.Task> getErrorMailQueueItemsFromTasks()

doFlush

public String doFlush()

doResend

public String doResend()

transfer items on the error queue onto the normal queue and flush

doDeleteErrorQueue

public String doDeleteErrorQueue()

removes all items from the error queue

doDeleteQueue

public String doDeleteQueue()

used in functional tests to efficiently clear the list of notifications for teardown()

getPage

public String getPage()

setPage

public void setPage(String page)

setMailTaskQueue

public void setMailTaskQueue(com.atlassian.core.task.TaskQueueWithErrorQueue queue)