com.atlassian.confluence.user.actions
Class AbstractUserProfileAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.user.actions.AbstractUserProfileAction
All Implemented Interfaces:
WebInterface, UserAware, BreadcrumbAware, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable
Direct Known Subclasses:
ChangeMyPasswordAction, EditEmailSettingsAction, EditMyProfileAction, EditNotificationsAction, EditorSettingsAction, RevokeOAuthTokensAction, StatusListAction, UserDarkFeaturesAction, ViewFollowAction, ViewFollowersAction, ViewFollowingAction, ViewMyDraftsAction, ViewMyEmailSettingsAction, ViewMyFavouritesAction, ViewMyLabelsAction, ViewMyProfileAction, ViewMySettingsAction, ViewUserActivityAction, ViewUserProfileAction, ViewUserStatusAction

public abstract class AbstractUserProfileAction
extends ConfluenceActionSupport
implements BreadcrumbAware, UserAware

See Also:
Serialized Form

Field Summary
protected  AttachmentManager attachmentManager
           
protected  FavouriteManager favouriteManager
           
protected  FollowManagerInternal followManager
           
static String HOMEPAGE_DASHBOARD
           
static String HOMEPAGE_PROFILE
           
static String HOMEPAGE_SITEHOME
           
static String HTML_FRIENDLY_NAME
           
static String HTML_MIME_TYPE
           
protected  NotificationManager notificationManager
           
protected  PersonalInformationManager personalInformationManager
           
protected  SpaceManager spaceManager
           
protected  StatusTextRenderer statusTextRenderer
           
static String TEXT_FRIENDLY_NAME
           
static String TEXT_MIME_TYPE
           
protected  UserDetailsManager userDetailsManager
           
protected  UserStatusManager userStatusManager
           
protected  com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer
           
 
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, 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
AbstractUserProfileAction()
           
 
Method Summary
 List getAttachments()
           
 Breadcrumb getBreadcrumb()
          Returns the breadcrumb to be shown when the action is accessed.
 Map<String,Object> getContext()
           
 UserStatus getCurrentStatus()
           
 Object getEmail()
           
 Object getFullName()
           
 boolean getHasStatusUpdates()
           
 String getPageTitle()
           
 String getPersonalInformation()
           
 PersonalInformation getPersonalInformationEntity()
           
protected  String getPersonalSpaceKey(com.atlassian.user.User user)
           
 Object getRenderedAboutMe()
           
 StatusTextRenderer getStatusTextRenderer()
           
 ConfluenceUser getUser()
           
 String getUsername()
           
protected  com.atlassian.core.user.preferences.UserPreferences getUserPreferences()
           
 ProfilePictureInfo getUserProfilePicture()
           
 Object getUserProperty(String key)
           
 WebInterfaceContext getWebInterfaceContext()
          Returns a context which can be passed to web items when rendering them.
 boolean hasPersonalSpace()
           
 boolean isFavourite()
           
 boolean isFollowing()
           
 boolean isHasAboutMe()
           
 boolean isMyProfile()
           
 boolean isUserRequired()
          If the action requires that the user be set before being run, then it should return true to this method.
 boolean isViewingMyProfile()
          Deprecated. since 3.0 use isMyProfile()
 boolean isViewPermissionRequired()
           
 void setAttachmentManager(AttachmentManager attachmentManager)
           
 void setFavouriteManager(FavouriteManager favouriteManager)
           
 void setFollowManager(FollowManagerInternal followManager)
           
 void setNotificationManager(NotificationManager notificationManager)
           
 void setPersonalInformation(String personalInformation)
           
 void setPersonalInformationManager(PersonalInformationManager personalInformationManager)
           
 void setSpaceManager(SpaceManager spaceManager)
           
 void setStatusTextRenderer(StatusTextRenderer statusTextRenderer)
           
 void setUserDetailsManager(UserDetailsManager userDetailsManager)
           
 void setUserStatusManager(UserStatusManager userStatusManager)
           
 void setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)
           
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager
 
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
 
Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware
validate
 

Field Detail

HTML_FRIENDLY_NAME

public static final String HTML_FRIENDLY_NAME
See Also:
Constant Field Values

TEXT_FRIENDLY_NAME

public static final String TEXT_FRIENDLY_NAME
See Also:
Constant Field Values

HTML_MIME_TYPE

public static final String HTML_MIME_TYPE
See Also:
Constant Field Values

TEXT_MIME_TYPE

public static final String TEXT_MIME_TYPE
See Also:
Constant Field Values

HOMEPAGE_DASHBOARD

public static final String HOMEPAGE_DASHBOARD
See Also:
Constant Field Values

HOMEPAGE_SITEHOME

public static final String HOMEPAGE_SITEHOME
See Also:
Constant Field Values

HOMEPAGE_PROFILE

public static final String HOMEPAGE_PROFILE
See Also:
Constant Field Values

userStatusManager

protected UserStatusManager userStatusManager

statusTextRenderer

protected StatusTextRenderer statusTextRenderer

wikiStyleRenderer

protected com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer

followManager

protected FollowManagerInternal followManager

favouriteManager

protected FavouriteManager favouriteManager

notificationManager

protected NotificationManager notificationManager

personalInformationManager

protected PersonalInformationManager personalInformationManager

attachmentManager

protected AttachmentManager attachmentManager

spaceManager

protected SpaceManager spaceManager

userDetailsManager

protected UserDetailsManager userDetailsManager
Constructor Detail

AbstractUserProfileAction

public AbstractUserProfileAction()
Method Detail

getUser

public ConfluenceUser getUser()
Specified by:
getUser in interface UserAware
Returns:
user - the user that the action worked on

getFullName

public Object getFullName()

getEmail

public Object getEmail()

getUserPreferences

protected com.atlassian.core.user.preferences.UserPreferences getUserPreferences()

getPersonalInformationEntity

public PersonalInformation getPersonalInformationEntity()

getPersonalInformation

public String getPersonalInformation()

setPersonalInformation

public void setPersonalInformation(String personalInformation)

getUsername

public String getUsername()

isViewingMyProfile

@Deprecated
public boolean isViewingMyProfile()
Deprecated. since 3.0 use isMyProfile()

Returns:
true if the current user is logged in viewing their own profile

isMyProfile

public boolean isMyProfile()
Returns:
true if the current user is logged in viewing their own profile

getUserProfilePicture

public ProfilePictureInfo getUserProfilePicture()

getAttachments

public List getAttachments()

setAttachmentManager

public final void setAttachmentManager(AttachmentManager attachmentManager)

setNotificationManager

public final void setNotificationManager(NotificationManager notificationManager)

setPersonalInformationManager

public final void setPersonalInformationManager(PersonalInformationManager personalInformationManager)

setSpaceManager

public final void setSpaceManager(SpaceManager spaceManager)

getPersonalSpaceKey

protected String getPersonalSpaceKey(com.atlassian.user.User user)

getPageTitle

public String getPageTitle()

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
Overrides:
getWebInterfaceContext in class ConfluenceActionSupport

isHasAboutMe

public boolean isHasAboutMe()

getRenderedAboutMe

public Object getRenderedAboutMe()

getBreadcrumb

public Breadcrumb getBreadcrumb()
Description copied from interface: BreadcrumbAware
Returns the breadcrumb to be shown when the action is accessed.

Specified by:
getBreadcrumb in interface BreadcrumbAware
Returns:
Breadcrumb

getCurrentStatus

public UserStatus getCurrentStatus()

getHasStatusUpdates

public boolean getHasStatusUpdates()

getUserProperty

public Object getUserProperty(String key)

setUserDetailsManager

public final void setUserDetailsManager(UserDetailsManager userDetailsManager)

setUserStatusManager

public final void setUserStatusManager(UserStatusManager userStatusManager)

setWikiStyleRenderer

public final void setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)

setFollowManager

public final void setFollowManager(FollowManagerInternal followManager)

setFavouriteManager

public final void setFavouriteManager(FavouriteManager favouriteManager)

getStatusTextRenderer

public StatusTextRenderer getStatusTextRenderer()

setStatusTextRenderer

public void setStatusTextRenderer(StatusTextRenderer statusTextRenderer)

isFollowing

public boolean isFollowing()

isFavourite

public boolean isFavourite()

hasPersonalSpace

public boolean hasPersonalSpace()

isUserRequired

public final 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 final 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

getContext

public Map<String,Object> getContext()
Overrides:
getContext in class ConfluenceActionSupport


Copyright © 2003–2015 Atlassian. All rights reserved.