com.atlassian.confluence.core
Class ConfluenceActionSupport

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport

All Implemented Interfaces:

WebInterface, Action, LocaleProvider, TextProvider, Validateable, ValidationAware, Serializable

Direct Known Subclasses:

AbstractBackupRestoreAction, AbstractCommandAction, AbstractEntityPaginationAction, AbstractGroupAction, AbstractLabelDisplayingAction, AbstractLabelsForEntityAction, AbstractLogoAction, AbstractPageAwareAction, AbstractPermissionsAction, AbstractSetupAction, AbstractSetupEmailAction, AbstractSpaceAction, AbstractTrustedApplicationAction, AbstractUpdateLicenseAction, AbstractUserProfileAction, AbstractUsersAction, AbstractUserStatusJsonResultAction, AbstractViewAttachmentsAction, AddFavouriteAction, AddLabelAction, AddLabelAjaxAction, AddSpaceToFavouriteAjaxAction, AdministrationConsoleAction, AdminStylesheetAction, AdvancedSearchTipsAction, AttachedImagesAction, AttachFileAction, AttachmentNotFoundAction, AttachmentStorageSetupAction, AuthenticateAction, AutocompleteLabelsAction, BreadcrumbAction, BrowseCommentsAction, BrowseMacrosAction, BrowseShortcutsAction, BuildIndexAction, CacheStatisticsAction, ClearUserStatusAction, ClusterConfigurationAction, ColorsStylesheetAction, ColourPickerAction, CombinedStylesheetAction, ConfigureCaptchaAction, ConfigureLanguageAction, ConfigureLog4jAction, ConfigureRssFeedAction, ContentNameSearchAction, CreateRssFeedAction, CustomHtmlAction, CustomStylesheetAction, DailyBackupAdminAction, DashboardAction, DeleteUserStatusAction, DraftAction, DraftAttachmentSearchAction, DropAuthenticationAction, EditDefaultSpaceContentAction, EditStylesheetAction, EncodingTestAction, ExternalUserConnectivityAction, FindRestrictableEntitiesAction, FlushCacheAction, FlushIndexQueueAction, FollowUserAction, ForgotUserPasswordAction, FourOhFourAction, GeneralConfigurationAction, GlobalRssFeedAction, HeartbeatAction, HistoryAction, HomepageAction, IndexProgressAction, ListNewOrUpdatedPagesAction, ListWatchersAction, LoginAction, LogoutAction, LongRunningTaskMonitorAction, ManagePluginsAction, ManageReferrersAction, NetworkFeedAction, NotationHelpAction, OpenSearchDescriptorAction, PageDestinationSearchAction, PageNotFoundAction, PageNotificationAction, PagePickerAction, PageSummaryAction, PeopleDirectoryAction, PluginOsgiExportsAction, PurgeReferrersAction, RebuildAncestorTableAction, RefreshLicensingAction, ReIndexAction, ReindexTaskProgressAction, RemoveFavouriteAction, RemoveLabelAction, RemoveLabelAjaxAction, RemoveSmtpMailServerAction, RemoveSpaceFromFavouriteAjaxAction, ResetUserPasswordAction, ResumeDraftAction, SearchIndexesAction, SearchSiteAction, SecurityConfigurationAction, SendTestEmailAction, SetupDBOtherAction, SignupAction, SiteSupportAction, StartClusterAction, StylesheetAction, SuggestLabelsAction, ThemeColorsStylesheetAction, TinyUrlAction, UnFollowUserAction, UserMacroAction, UserPopupAction, UserSearchAction, ViewIndexQueueAction, ViewMailQueueAction, ViewMailServersAction, ViewSystemClasspathAction, ViewSystemInfoAction, ViewUserHistoryAction, WysiwygConverterAction, XsrfTokenExpiredAction

public class ConfluenceActionSupport
extends ActionSupport
implements LocaleProvider, WebInterface

Base class for all Confluence webwork actions. Mainly takes care of managing permissions, and a few other tasks that are common across all actions in the app.

See Also:

Serialized Form

Field Summary

static String	CANCEL
static String	DEVMODE
protected EventManager	eventManager
protected I18NBeanFactory	i18NBeanFactory
protected LabelManager	labelManager
protected LanguageManager	languageManager
static String	LICENSE_EXPIRED
static String	LICENSE_USERS_EXCEEDED
protected org.apache.log4j.Logger	log Deprecated. since 2.6.1 create a private static logger in your action class
protected PermissionManager	permissionManager
protected boolean	permitted
protected PluginAccessor	pluginAccessor
static String	PREVIEW
protected SettingsManager	settingsManager
protected SpacePermissionManager	spacePermissionManager
protected UserAccessor	userAccessor
protected WebInterfaceManager	webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

ConfluenceActionSupport()

Method Summary

void	addActionError(String textKey, Object... args) Adds an error to the current action which will be displayed to the user.
void	addFieldError(String fieldName, String textKey, Object[] args) Adds an error to the current action which will be displayed next to the specified field.
protected void	addPermissionTypeTo(String permissionType, List<String> permissionTypes)
protected void	addToHistory(ContentEntityObject content)
String	doDefault() Default webwork action execution method.
String	formatFriendlyDate(Date date)
String	getActionName() Returns the internationalised name of the current action.
String	getActionName(String fullClassName)
BootstrapManager	getBootstrapManager()
String	getCancelResult()
Map<String,Object>	getContext()
DateFormatter	getDateFormatter()
ResourceBundle	getDefaultResourceBundle()
String	getDocLink(String page) Creates a version specific documentation link for the provided page.
EventManager	getEventManager()
FriendlyDateFormatter	getFriendlyDateFormatter()
Settings	getGlobalSettings()
ThemeHelper	getHelper()
I18NBean	getI18n()
List<Language>	getInstalledLanguages()
LabelManager	getLabelManager()
LanguageManager	getLanguageManager()
String	getLanguageUserFriendly(String locale)
Locale	getLocale()
LocaleManager	getLocaleManager()
String	getLocaleString()
String	getNiceContentType(ContentEntityObject entityObject)
protected List<String>	getPermissionTypes()
protected List	getPermittedEntitiesOf(Iterator entities, int maxCount)
protected List	getPermittedEntitiesOf(Iterator entities, int maxCount, List criteria)
protected List	getPermittedEntitiesOf(List entities)
Date	getPreviousLoginDate()
int	getRandom() Deprecated. since 2.9. Random number generation does not belong here. Please introduce your own random number generation in your own actions.
com.atlassian.user.User	getRemoteUser() Return the user from ServletActionContext.getRequest(), or if that is not found, the user returned from AuthenticatedUserThreadLocal.getUser().
Map	getSession()
SystemInformationService	getSystemInformationService()
String	getText(String key)
String	getText(String key, List list)
String	getText(String key, Object[] args)
String	getText(String key, String defaultValue) This can be used for internationalisation where an uninternationalised default string exists.
static String	getTextStatic(String key)
static String	getTextStatic(String key, Object[] list)
String	getTextStrict(String key)
TimeZone	getTimeZone()
com.atlassian.user.User	getUser(String username)
UserAccessor	getUserAccessor()
String	getUserFullName(String username)
protected UserInterfaceState	getUserInterfaceState()
WebInterfaceContext	getWebInterfaceContext() Returns a context which can be passed to web items when rendering them.
WebInterfaceManager	getWebInterfaceManager()
protected boolean	hasPermissionForSpace(List permissionTypes, Space space)
boolean	isAnonymousUser()
boolean	isCanceled() Has this action been cancelled? Used by CancellingInterceptor to determine if the action should be executed.
boolean	isDevMode() Returns true if the system property confluence.devmode is set and has the value "true".
boolean	isEmailVisible()
boolean	isExternalUserManagementEnabled()
boolean	isLabelable(Object object)
boolean	isPermissionCheck()
boolean	isPermitted()
String	isPermittedAsString()
boolean	isPrintableVersion()
boolean	isSharedMode()
boolean	isUserStatusPluginEnabled() Temporary method until we have plugin points to require i18n keys.
boolean	isUsingHSQL() Placing this method in ConfluenceActionSupport is a bit of a hack, but it is suprisingly difficult to have a generic piece of logic that can be used in decorators.
void	setBootstrapManager(BootstrapManager bootstrapManager)
void	setCancel(String cancel) Set by the "cancel" button on forms.
void	setEventManager(EventManager eventManager)
void	setFormatSettingsManager(FormatSettingsManager formatSettingsManager)
void	setI18NBean(I18NBean i18NBean)
void	setI18NBeanFactory(I18NBeanFactory i18NBeanFactory)
void	setLabelManager(LabelManager labelManager)
void	setLanguageManager(LanguageManager languageManager)
void	setLocaleManager(LocaleManager localeManager)
void	setPermissionCheck(boolean permissionCheck)
void	setPermissionManager(PermissionManager permissionManager)
void	setPluginAccessor(PluginAccessor pluginAccessor)
void	setPreviousLoginDate(Date previousLoginDate)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpacePermissionManager(SpacePermissionManager spacePermissionManager)
void	setSystemInformationService(SystemInformationService systemInformationService)
void	setUserAccessor(UserAccessor userAccessor)
void	setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

log

@Deprecated
protected org.apache.log4j.Logger log

Deprecated. since 2.6.1 create a private static logger in your action class

CANCEL

public static final String CANCEL

See Also:

Constant Field Values

PREVIEW

public static final String PREVIEW

See Also:

Constant Field Values

LICENSE_EXPIRED

public static final String LICENSE_EXPIRED

See Also:

Constant Field Values

LICENSE_USERS_EXCEEDED

public static final String LICENSE_USERS_EXCEEDED

See Also:

Constant Field Values

DEVMODE

public static final String DEVMODE

See Also:

Constant Field Values

userAccessor

protected UserAccessor userAccessor

eventManager

protected EventManager eventManager

spacePermissionManager

protected SpacePermissionManager spacePermissionManager

permissionManager

protected PermissionManager permissionManager

settingsManager

protected SettingsManager settingsManager

labelManager

protected LabelManager labelManager

languageManager

protected LanguageManager languageManager

i18NBeanFactory

protected I18NBeanFactory i18NBeanFactory

webInterfaceManager

protected WebInterfaceManager webInterfaceManager

permitted

protected boolean permitted

pluginAccessor

protected PluginAccessor pluginAccessor

Constructor Detail

ConfluenceActionSupport

public ConfluenceActionSupport()

Method Detail

setCancel

public void setCancel(String cancel)

Set by the "cancel" button on forms. This tells the CancellingInterceptor that an action should not be executed, and should just return its getCancelResult() result.

Parameters:

cancel - Any non-null, non-empty string value.

isCanceled

public boolean isCanceled()

Has this action been cancelled? Used by CancellingInterceptor to determine if the action should be executed.

See Also:

setCancel(String)

getRandom

public int getRandom()

Deprecated. since 2.9. Random number generation does not belong here. Please introduce your own random number generation in your own actions.

doDefault

public String doDefault()
                 throws Exception

Default webwork action execution method.

Overrides:

doDefault in class ActionSupport

Returns:

the action result

Throws:

Exception - if something goes wrong

getText

public String getText(String key)

Specified by:

getText in interface TextProvider

Overrides:

getText in class ActionSupport

getText

public String getText(String key,
                      String defaultValue)

This can be used for internationalisation where an uninternationalised default string exists. If the key is null or returns a null value, then the default will be used instead.

Specified by:

getText in interface TextProvider

Overrides:

getText in class ActionSupport

getText

public String getText(String key,
                      Object[] args)

getText

public String getText(String key,
                      List list)

Specified by:

getText in interface TextProvider

Overrides:

getText in class ActionSupport

getActionName

public String getActionName(String fullClassName)

getActionName

public String getActionName()

Returns the internationalised name of the current action.

Since:

3.1

getTextStrict

public String getTextStrict(String key)

isPrintableVersion

public boolean isPrintableVersion()

isPermittedAsString

public String isPermittedAsString()

isPermitted

public boolean isPermitted()

getPermissionTypes

protected List<String> getPermissionTypes()

isPermissionCheck

public boolean isPermissionCheck()

setPermissionCheck

public void setPermissionCheck(boolean permissionCheck)

getRemoteUser

public com.atlassian.user.User getRemoteUser()

Return the user from ServletActionContext.getRequest(), or if that is not found, the user returned from AuthenticatedUserThreadLocal.getUser().

Returns:

the remote user

getUser

public com.atlassian.user.User getUser(String username)

getUserFullName

public String getUserFullName(String username)

addPermissionTypeTo

protected void addPermissionTypeTo(String permissionType,
                                   List<String> permissionTypes)

getPermittedEntitiesOf

protected List getPermittedEntitiesOf(List entities)

getPermittedEntitiesOf

protected List getPermittedEntitiesOf(Iterator entities,
                                      int maxCount,
                                      List criteria)

getPermittedEntitiesOf

protected List getPermittedEntitiesOf(Iterator entities,
                                      int maxCount)

setPreviousLoginDate

public void setPreviousLoginDate(Date previousLoginDate)

getPreviousLoginDate

public Date getPreviousLoginDate()

isExternalUserManagementEnabled

public boolean isExternalUserManagementEnabled()

addToHistory

protected void addToHistory(ContentEntityObject content)

getSession

public Map getSession()

getUserInterfaceState

protected UserInterfaceState getUserInterfaceState()

isAnonymousUser

public boolean isAnonymousUser()

isDevMode

public boolean isDevMode()

Returns true if the system property confluence.devmode is set and has the value "true".

Returns:

boolean

getCancelResult

public String getCancelResult()

getNiceContentType

public String getNiceContentType(ContentEntityObject entityObject)

getDefaultResourceBundle

public ResourceBundle getDefaultResourceBundle()

getGlobalSettings

public Settings getGlobalSettings()

isEmailVisible

public boolean isEmailVisible()

isLabelable

public boolean isLabelable(Object object)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

hasPermissionForSpace

protected boolean hasPermissionForSpace(List permissionTypes,
                                        Space space)

getEventManager

public EventManager getEventManager()

setEventManager

public void setEventManager(EventManager eventManager)

setBootstrapManager

public void setBootstrapManager(BootstrapManager bootstrapManager)

getBootstrapManager

public BootstrapManager getBootstrapManager()

setSpacePermissionManager

public void setSpacePermissionManager(SpacePermissionManager spacePermissionManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

getWebInterfaceManager

public WebInterfaceManager getWebInterfaceManager()

setWebInterfaceManager

public void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

setLabelManager

public void setLabelManager(LabelManager labelManager)

getLabelManager

public LabelManager getLabelManager()

setLanguageManager

public void setLanguageManager(LanguageManager languageManager)

getLanguageManager

public LanguageManager getLanguageManager()

getHelper

public ThemeHelper getHelper()

getUserAccessor

public UserAccessor getUserAccessor()

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

getTextStatic

public static String getTextStatic(String key)

getTextStatic

public static String getTextStatic(String key,
                                   Object[] list)

getLocale

public Locale getLocale()

Specified by:

getLocale in interface LocaleProvider

Overrides:

getLocale in class ActionSupport

getLocaleString

public String getLocaleString()

getLanguageUserFriendly

public String getLanguageUserFriendly(String locale)

getInstalledLanguages

public List<Language> getInstalledLanguages()

addFieldError

public void addFieldError(String fieldName,
                          String textKey,
                          Object[] args)

Adds an error to the current action which will be displayed next to the specified field. HTML-escapes any String arguments to avoid cross-site scripting problems with user input.

Parameters:

fieldName - field to apply error to

textKey - key to internationalised text

args - args to be merged with text via standard MessageFormat rules

addActionError

public void addActionError(String textKey,
                           Object... args)

Adds an error to the current action which will be displayed to the user. HTML-escapes any String arguments to avoid cross-site scripting problems with user input.

Parameters:

textKey - key to internationalised text

args - args to be merged with text via standard MessageFormat rules

getI18n

public I18NBean getI18n()

getDocLink

public String getDocLink(String page)

Creates a version specific documentation link for the provided page. This method exists because some error messages include links. Otherwise use $docBean which is available on the velocity context.

Parameters:

page - the page to link to (just the title)

Returns:

version specific documentation link.

getSystemInformationService

public SystemInformationService getSystemInformationService()

setSystemInformationService

public void setSystemInformationService(SystemInformationService systemInformationService)

setLocaleManager

public void setLocaleManager(LocaleManager localeManager)

getLocaleManager

public LocaleManager getLocaleManager()

setI18NBeanFactory

public void setI18NBeanFactory(I18NBeanFactory i18NBeanFactory)

getTimeZone

public TimeZone getTimeZone()

getDateFormatter

public DateFormatter getDateFormatter()

getFriendlyDateFormatter

public FriendlyDateFormatter getFriendlyDateFormatter()

formatFriendlyDate

public String formatFriendlyDate(Date date)

setFormatSettingsManager

public void setFormatSettingsManager(FormatSettingsManager formatSettingsManager)

isUsingHSQL

public boolean isUsingHSQL()

Placing this method in ConfluenceActionSupport is a bit of a hack, but it is suprisingly difficult to have a generic piece of logic that can be used in decorators.

Returns:

true if Confluence is currently using a Hypersonic database

setI18NBean

public void setI18NBean(I18NBean i18NBean)

getWebInterfaceContext

public WebInterfaceContext getWebInterfaceContext()

Description copied from interface: WebInterface

Returns a context which can be passed to web items when rendering them.

Typically, WebWork actions will implement this to provide extra details in the context such as content objects, and so on.

Specified by:

getWebInterfaceContext in interface WebInterface

isSharedMode

public boolean isSharedMode()

isUserStatusPluginEnabled

public boolean isUserStatusPluginEnabled()

Temporary method until we have plugin points to require i18n keys. CONF-15428

Returns:

true if "user status" is enabled.

setPluginAccessor

public void setPluginAccessor(PluginAccessor pluginAccessor)

getContext

public Map<String,Object> getContext()