public abstract class

AbstractUserProfileAction

extends ConfluenceActionSupport
implements UserAware BreadcrumbAware
java.lang.Object
   ↳ com.opensymphony.xwork.ActionSupport
     ↳ com.atlassian.confluence.core.ConfluenceActionSupport
       ↳ com.atlassian.confluence.user.actions.AbstractUserProfileAction
Known Direct Subclasses
Known Indirect Subclasses

Summary

Constants
String HOMEPAGE_DASHBOARD
String HOMEPAGE_PROFILE
String HOMEPAGE_SITEHOME
String HTML_FRIENDLY_NAME
String HTML_MIME_TYPE
String TEXT_FRIENDLY_NAME
String TEXT_MIME_TYPE
[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ConfluenceActionSupport
From interface com.opensymphony.xwork.Action
Fields
protected AttachmentManager attachmentManager
protected FavouriteManager favouriteManager
protected FollowManager followManager
protected NotificationManager notificationManager
protected PersonalInformationManager personalInformationManager
protected SpaceManager spaceManager
protected StatusTextRenderer statusTextRenderer
protected UserDetailsManager userDetailsManager
protected UserStatusManager userStatusManager
protected WikiStyleRenderer wikiStyleRenderer
[Expand]
Inherited Fields
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
Public Constructors
AbstractUserProfileAction()
Public Methods
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()
Object getRenderedAboutMe()
StatusTextRenderer getStatusTextRenderer()
User getUser()
ProfilePictureInfo getUserProfilePicture()
Object getUserProperty(String key)
String getUsername()
WebInterfaceContext getWebInterfaceContext()
Returns a context which can be passed to web items when rendering them.
boolean hasPersonalSpace()
boolean isFavourite()
boolean isFollowing()
boolean isHasAboutMe()
final boolean isUserRequired()
If the action requires that the user be set before being run, then it should return true to this method.
final boolean isViewPermissionRequired()
boolean isViewingMyProfile()
This method is deprecated. since 3.0 use isMyProfile()
final void setAttachmentManager(AttachmentManager attachmentManager)
final void setFavouriteManager(FavouriteManager favouriteManager)
final void setFollowManager(FollowManager followManager)
final void setNotificationManager(NotificationManager notificationManager)
void setPersonalInformation(String personalInformation)
final void setPersonalInformationManager(PersonalInformationManager personalInformationManager)
final void setSpaceManager(SpaceManager spaceManager)
void setStatusTextRenderer(StatusTextRenderer statusTextRenderer)
final void setUserDetailsManager(UserDetailsManager userDetailsManager)
final void setUserStatusManager(UserStatusManager userStatusManager)
final void setWikiStyleRenderer(WikiStyleRenderer wikiStyleRenderer)
Protected Methods
String getPersonalSpaceKey(User user)
UserPreferences getUserPreferences()
boolean isMyProfile()
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
From class java.lang.Object
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface
From interface com.atlassian.confluence.user.actions.UserAware
From interface com.atlassian.confluence.util.breadcrumbs.BreadcrumbAware
From interface com.opensymphony.xwork.Action
From interface com.opensymphony.xwork.LocaleProvider
From interface com.opensymphony.xwork.TextProvider
From interface com.opensymphony.xwork.Validateable
From interface com.opensymphony.xwork.ValidationAware

Constants

public static final String HOMEPAGE_DASHBOARD

Constant Value: "dashboard"

public static final String HOMEPAGE_PROFILE

Constant Value: "profile"

public static final String HOMEPAGE_SITEHOME

Constant Value: "siteHomepage"

public static final String HTML_FRIENDLY_NAME

Constant Value: "HTML"

public static final String HTML_MIME_TYPE

Constant Value: "text/html"

public static final String TEXT_FRIENDLY_NAME

Constant Value: "Text"

public static final String TEXT_MIME_TYPE

Constant Value: "text/plain"

Fields

protected AttachmentManager attachmentManager

protected FavouriteManager favouriteManager

protected FollowManager followManager

protected NotificationManager notificationManager

protected PersonalInformationManager personalInformationManager

protected SpaceManager spaceManager

protected StatusTextRenderer statusTextRenderer

protected UserDetailsManager userDetailsManager

protected UserStatusManager userStatusManager

protected WikiStyleRenderer wikiStyleRenderer

Public Constructors

public AbstractUserProfileAction ()

Public Methods

public List getAttachments ()

public Breadcrumb getBreadcrumb ()

Returns the breadcrumb to be shown when the action is accessed.

Returns
  • Breadcrumb

public Map<String, Object> getContext ()

public UserStatus getCurrentStatus ()

public Object getEmail ()

public Object getFullName ()

public boolean getHasStatusUpdates ()

public String getPageTitle ()

public String getPersonalInformation ()

public PersonalInformation getPersonalInformationEntity ()

public Object getRenderedAboutMe ()

public StatusTextRenderer getStatusTextRenderer ()

public User getUser ()

public ProfilePictureInfo getUserProfilePicture ()

public Object getUserProperty (String key)

public String getUsername ()

public WebInterfaceContext getWebInterfaceContext ()

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.

public boolean hasPersonalSpace ()

public boolean isFavourite ()

public boolean isFollowing ()

public boolean isHasAboutMe ()

public final boolean isUserRequired ()

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

Returns
  • true if the action requires a page in order to execute

public final boolean isViewPermissionRequired ()

public boolean isViewingMyProfile ()

This method is deprecated.
since 3.0 use isMyProfile()

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

public final void setAttachmentManager (AttachmentManager attachmentManager)

public final void setFavouriteManager (FavouriteManager favouriteManager)

public final void setFollowManager (FollowManager followManager)

public final void setNotificationManager (NotificationManager notificationManager)

public void setPersonalInformation (String personalInformation)

public final void setPersonalInformationManager (PersonalInformationManager personalInformationManager)

public final void setSpaceManager (SpaceManager spaceManager)

public void setStatusTextRenderer (StatusTextRenderer statusTextRenderer)

public final void setUserDetailsManager (UserDetailsManager userDetailsManager)

public final void setUserStatusManager (UserStatusManager userStatusManager)

public final void setWikiStyleRenderer (WikiStyleRenderer wikiStyleRenderer)

Protected Methods

protected String getPersonalSpaceKey (User user)

protected UserPreferences getUserPreferences ()

protected boolean isMyProfile ()

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