Package com.atlassian.confluence.user.actions

Class AbstractUserProfileAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.AbstractUserProfileAction

All Implemented Interfaces:

WebInterface, UserAware, BreadcrumbAware, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

Direct Known Subclasses:

ChangeMyPasswordAction, EditEmailSettingsAction, EditMyProfileAction, EditNotificationsAction, EditorSettingsAction, UserDarkFeaturesAction, ViewFollowAction, ViewFollowersAction, ViewFollowingAction, ViewMyDraftsAction, ViewMyEmailSettingsAction, ViewMyFavouritesAction, ViewMyProfileAction, ViewMySettingsAction, ViewUserActivityAction, ViewUserProfileAction

public abstract class AbstractUserProfileAction
extends ConfluenceActionSupport
implements BreadcrumbAware, UserAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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 com.atlassian.renderer.WikiStyleRenderer	wikiStyleRenderer

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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
AbstractUserProfileAction()

Method Summary

Modifier and Type	Method	Description
boolean	currentUserHasLicensedAccess()
List	getAttachments()
Breadcrumb	getBreadcrumb()	Returns the breadcrumb to be shown when the action is accessed.
Map<String,Object>	getContext()
Object	getEmail()
Object	getFullName()
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	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	setWikiStyleRenderer(com.atlassian.renderer.WikiStyleRenderer wikiStyleRenderer)

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermitted, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiContentUiSupport, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

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

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

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, Struts 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

getUserProperty

public Object getUserProperty(String key)

setUserDetailsManager

public final void setUserDetailsManager(UserDetailsManager userDetailsManager)

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

currentUserHasLicensedAccess

public boolean currentUserHasLicensedAccess()

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