com.atlassian.confluence.userstatus.actions
Class ClearUserStatusAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.userstatus.actions.ClearUserStatusAction
All Implemented Interfaces:
WebInterface, UserAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class ClearUserStatusAction
extends ConfluenceActionSupport
implements UserAware

This action clears/resets the specified user's status

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, 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
ClearUserStatusAction()
           
 
Method Summary
 String execute()
           
 com.atlassian.user.User getUser()
           
 String getUsername()
           
 boolean isPermitted()
           
 boolean isUserRequired()
          If the action requires that the user be set before being run, then it should return true to this method.
 boolean isViewPermissionRequired()
           
 void setUsername(String username)
           
 void setUserStatusManager(UserStatusManager userStatusManager)
           
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setUserAccessor, setWebInterfaceManager
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, 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
 

Constructor Detail

ClearUserStatusAction

public ClearUserStatusAction()
Method Detail

execute

public String execute()
               throws Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
Exception

setUserStatusManager

public void setUserStatusManager(UserStatusManager userStatusManager)

isPermitted

public boolean isPermitted()
Overrides:
isPermitted in class ConfluenceActionSupport

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getUser

public com.atlassian.user.User getUser()
Specified by:
getUser in interface UserAware
Returns:
user - the user that the action worked on

isUserRequired

public boolean isUserRequired()
Description copied from interface: UserAware
If the action requires that the user be set before being run, then it should return true to this method. If the action requires a user, but no user is available, then the interceptor will automatically redirect to the 'notfound' result

Specified by:
isUserRequired in interface UserAware
Returns:
true if the action requires a page in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()
Specified by:
isViewPermissionRequired in interface UserAware
Returns:
true if the action requires a check on com.atlassian.confluence.user.actions.UserAwareInterceptor.VIEW_USER_PROFILE_PERMISSION


Copyright © 2003-2011 Atlassian. All Rights Reserved.