Package com.atlassian.confluence.rss.actions

Class NetworkFeedAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.rss.actions.NetworkFeedAction

All Implemented Interfaces:

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

public class NetworkFeedAction
extends ConfluenceActionSupport
implements UserAware

Generates a feed of the people who are being followed by a specified user.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_RESULTS

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, systemInformationService, 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
NetworkFeedAction()

Method Summary

Modifier and Type	Method	Description
String	execute()
com.rometools.rome.feed.synd.SyndFeed	getSyndFeed()	Magic accessor that is monitored by RssResult.
ConfluenceUser	getUser()
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	setContentType(ContentTypeEnum contentType)	Set the content type to be returned.
void	setFeedBuilder(SyndFeedService feedBuilder)
void	setFollowManager(FollowManagerInternal followManager)
void	setMax(int max)
void	setPredefinedSearchBuilder(PredefinedSearchBuilder predefinedSearchBuilder)
void	setRssType(String rssType)
void	setUserAccessor(UserAccessor userAccessor)
void	setUsername(String username)

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, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, 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, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermitted, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setWebInterfaceManager, useSkipAccessCheck, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, 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

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

NetworkFeedAction

public NetworkFeedAction()

Method Detail

getSyndFeed

public com.rometools.rome.feed.synd.SyndFeed getSyndFeed()

Magic accessor that is monitored by RssResult.

Returns:

the feed

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

setFeedBuilder

public void setFeedBuilder(SyndFeedService feedBuilder)

setPredefinedSearchBuilder

public void setPredefinedSearchBuilder(PredefinedSearchBuilder predefinedSearchBuilder)

setFollowManager

public void setFollowManager(FollowManagerInternal followManager)

getUser

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

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

Overrides:

setUserAccessor in class ConfluenceActionSupport

setUsername

public void setUsername(String username)

setRssType

public void setRssType(String rssType)

setMax

public void setMax(int max)

setContentType

public void setContentType(ContentTypeEnum contentType)

Set the content type to be returned.

Struts sets the contentType from the named parameter using EnumTypeConverter as defined by NetworkFeedAction-conversion.properties.