Package com.atlassian.confluence.admin.actions.macros

Class UpdateUserMacroAction

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.macros.UserMacroAction

com.atlassian.confluence.admin.actions.macros.UpdateUserMacroAction

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 UpdateUserMacroAction
extends UserMacroAction

Action for updating a user macro

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.admin.actions.macros.UserMacroAction

macro, macroManager, macroMetadataManager, userMacro, userMacroLibrary

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
UpdateUserMacroAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	doUpdate()	Remove the existing user macro and then add the updated user macro
String	getMode()
String	getOriginalName()
List<HTMLPairType>	getOutputTypes()	Populates the output type select box if the macro being edited is a legacy one with a wiki markup template.
String	getSubmitKey()
void	setOriginalName(String originalName)
void	validate()

Methods inherited from class com.atlassian.confluence.admin.actions.macros.UserMacroAction

addUpdateMacro, countUserMacrosWithoutMetadata, countUserMacrosWithWikiTemplates, getBodyTypes, getCategories, getShowInMacroBrowser, getTemplateHtml, getToBeValidatedUserMacros, getUserMacro, getUserMacros, getVisibleTypes, isMissingMetadata, isPermitted, isWikiTemplate, setDocBean, setMacro, setMacroManager, setMacroMetadataManager, setShowInMacroBrowser, setUserMacro, setUserMacroLibrary, validateMacroForm, validateMacroMissingContextVariables, validateNewMacroName

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, 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, execute, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale

Methods inherited from class java.lang.Object

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

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

execute

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

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

Constructor Details

UpdateUserMacroAction

public UpdateUserMacroAction()

Method Details

getOriginalName

public String getOriginalName()

setOriginalName

public void setOriginalName(String originalName)

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface org.apache.struts2.Validateable

Overrides:

validate in class org.apache.struts2.ActionSupport

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class UserMacroAction

Throws:

Exception

doUpdate

public String doUpdate()

Remove the existing user macro and then add the updated user macro

Returns:

SUCCESS

getOutputTypes

public List<HTMLPairType> getOutputTypes()

Populates the output type select box if the macro being edited is a legacy one with a wiki markup template. Otherwise return an empty list since current Confluence has no choice of template type.

Returns:

list of output types

getMode

public String getMode()

getSubmitKey

public String getSubmitKey()