com.atlassian.confluence.pages.actions

Class AbstractViewAttachmentsAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractViewAttachmentsAction

All Implemented Interfaces:

BootstrapAware, WebInterface, MessageHolderAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

ViewDraftAttachmentsAction, ViewPageAttachmentsAction

public abstract class AbstractViewAttachmentsAction
extends ConfluenceActionSupport
implements com.opensymphony.webwork.interceptor.ServletRequestAware, BootstrapAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AttachmentManager	attachmentManager
protected FileStorer	fileStorer
protected List<String>	highlight

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

CANCEL, contentUiSupport, 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

Constructors

Constructor and Description
AbstractViewAttachmentsAction()

Method Summary

Modifier and Type	Method and Description
void	bootstrap()
String	execute()
String	getActiveContentType()
List<Attachment>	getAllVersions(Attachment attachment)
String[]	getAttachmentDetails(Attachment attachment) Used for writing the "do you want to remove?" message.
int	getContainedCustomContentTypeCount(String contentTypeKey)
List<CustomContentEntityObject>	getContainedCustomContentTypeEntities(String contentTypeKey)
Set<String>	getContainedCustomContentTypes()
abstract ContentEntityObject	getContentEntityObject()
String	getCustomContentTypeI18NKeys(String contentTypeKey) Get i18n keys for each content type
protected SortedMap<String,CustomContentEntityObject>	getFirstContainedCustomContentTypes() Only retrieve one entity for each content types.
List<String>	getHighlight()
String	getHighlightParameter()
String	getIconCssClass(CustomContentEntityObject cceo)
String	getLabels()
List<Attachment>	getLatestVersionsOfAttachments()
int	getMaxAttachments()
com.opensymphony.webwork.dispatcher.multipart.MultiPartRequestWrapper	getMultiPartRequest()
String	getSortBy()
long	getUploadLimit()
String	getViewComponentUrl(CustomContentEntityObject cceo)
WebInterfaceContext	getWebInterfaceContext(WebInterfaceContext context, CustomContentEntityObject cceo)
boolean	hasAttachFilePermissions()
void	setActiveContentType(String activeContentType)
void	setAttachmentManager(AttachmentManager attachmentManager)
void	setContentTypeManager(ContentTypeManager contentTypeManager)
void	setCustomContentManager(CustomContentManager customContentManager)
void	setFileUploadManager(FileUploadManager fileUploadManager)
void	setHighlight(List<String> names)
void	setLabels(String labels)
void	setServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)
void	setSortBy(String sortBy)
protected void	validateUpload()

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendAssetsManager, getFrontendFragment, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getReactUIDarkFeatureHelper, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermitted, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setFrontendAssetsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setReactUIDarkFeatureHelper, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, 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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Field Detail

attachmentManager

protected AttachmentManager attachmentManager

highlight

protected List<String> highlight

fileStorer

protected FileStorer fileStorer

Constructor Detail

AbstractViewAttachmentsAction

public AbstractViewAttachmentsAction()

Method Detail

setServletRequest

public void setServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

Specified by:

setServletRequest in interface com.opensymphony.webwork.interceptor.ServletRequestAware

getMultiPartRequest

public com.opensymphony.webwork.dispatcher.multipart.MultiPartRequestWrapper getMultiPartRequest()

bootstrap

public void bootstrap()

Specified by:

bootstrap in interface BootstrapAware

validateUpload

protected void validateUpload()

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

hasAttachFilePermissions

public boolean hasAttachFilePermissions()

getContentEntityObject

public abstract ContentEntityObject getContentEntityObject()

setAttachmentManager

public void setAttachmentManager(AttachmentManager attachmentManager)

getLatestVersionsOfAttachments

public List<Attachment> getLatestVersionsOfAttachments()

getAttachmentDetails

public String[] getAttachmentDetails(Attachment attachment)

Used for writing the "do you want to remove?" message.

Parameters:

attachment - the attachment to get the details of

Returns:

an array of the attachment's name (XML-escaped) and its version number

getUploadLimit

public long getUploadLimit()

getHighlightParameter

public String getHighlightParameter()

getAllVersions

public List<Attachment> getAllVersions(Attachment attachment)

getMaxAttachments

public int getMaxAttachments()

setFileUploadManager

public void setFileUploadManager(FileUploadManager fileUploadManager)

getHighlight

public List<String> getHighlight()

setHighlight

public void setHighlight(List<String> names)

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

setLabels

public void setLabels(String labels)

getLabels

public String getLabels()

setActiveContentType

public void setActiveContentType(String activeContentType)

getActiveContentType

public String getActiveContentType()

setCustomContentManager

public void setCustomContentManager(CustomContentManager customContentManager)

setContentTypeManager

public void setContentTypeManager(ContentTypeManager contentTypeManager)

getFirstContainedCustomContentTypes

protected SortedMap<String,CustomContentEntityObject> getFirstContainedCustomContentTypes()

Only retrieve one entity for each content types. Keys are sorted in ascending order.

Returns:

Map of content type key to entity

getContainedCustomContentTypes

public Set<String> getContainedCustomContentTypes()

getContainedCustomContentTypeCount

public int getContainedCustomContentTypeCount(String contentTypeKey)

getContainedCustomContentTypeEntities

public List<CustomContentEntityObject> getContainedCustomContentTypeEntities(String contentTypeKey)

getCustomContentTypeI18NKeys

public String getCustomContentTypeI18NKeys(String contentTypeKey)

Get i18n keys for each content type

Returns:

Mapping for content type to i18n key

getViewComponentUrl

public String getViewComponentUrl(CustomContentEntityObject cceo)

getIconCssClass

public String getIconCssClass(CustomContentEntityObject cceo)

getWebInterfaceContext

public WebInterfaceContext getWebInterfaceContext(WebInterfaceContext context,
                                                  CustomContentEntityObject cceo)