com.atlassian.jira.plugin.link.confluence

Class LinkConfluencePage

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.action.JiraActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.ProjectActionSupport

com.atlassian.jira.web.action.IssueActionSupport

com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

com.atlassian.jira.web.action.issue.AbstractViewIssue

com.atlassian.jira.web.action.issue.AbstractCommentableIssue

com.atlassian.jira.web.action.issue.AbstractIssueLinkAction

com.atlassian.jira.plugin.link.confluence.LinkConfluencePage

All Implemented Interfaces:

OperationContext, ErrorCollection, I18nHelper, IssueSummaryAware, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class LinkConfluencePage
extends AbstractIssueLinkAction

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.issue.AbstractIssueLinkAction

eventPublisher, remoteIssueLinkService, validationResult

Fields inherited from class com.atlassian.jira.web.action.issue.AbstractCommentableIssue

userUtil

Fields inherited from class com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

id, ISSUE_PERMISSION_ERROR, PREPOPULATED_ISSUE_OBJECT

Fields inherited from class com.atlassian.jira.web.action.IssueActionSupport

attachmentManager

Fields inherited from class com.atlassian.jira.web.action.ProjectActionSupport

projectManager

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description

LinkConfluencePage(SubTaskManager subTaskManager, FieldScreenRendererFactory fieldScreenRendererFactory, FieldManager fieldManager, ProjectRoleManager projectRoleManager, CommentService commentService, UserUtil userUtil, RemoteIssueLinkService remoteIssueLinkService, com.atlassian.event.api.EventPublisher eventPublisher, IssueEventManager issueEventManager, IssueEventBundleFactory issueEventBundleFactory, ConfluenceApplicationLinks confluenceAppLinks, ConfluencePageService confluencePageService)

Method Summary

Modifier and Type	Method and Description
String	doDefault() The "default" command.
protected String	doExecute()
protected void	doValidation() Validate that the user has permission to link issues, and that the comment field is valid.
String	getAppId()
Collection<com.atlassian.applinks.api.ApplicationLink>	getAppLinks()
Collection<String>	getFlushedErrorMessages() Get error messages, then get rid of them.
String	getPageUrl()
boolean	isValidToView() Returns true if the contents of the action should be shown, false if otherwise.
void	setPageUrl(String pageUrl)

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractIssueLinkAction

createAndDispatchComment, createLink, createLink, dispatchCommentEvents, getCommentSectionHtml, getDisplayParams, getKeyboardShortcutContext, getModifierKey, getRedirectUrl, handleCredentialsRequired, isRequiresCredentials

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractCommentableIssue

createComment, doCommentValidation, getComment, getCommentLevel, getFieldScreenRendererLayoutItemForField, getFieldScreenRendererWithAllFields, getFieldValuesHolder, getGroupLevel, getGroupLevels, getIssueOperation, getOrderableField, getRoleLevels, populateCommentFields, setComment, setCommentLevel, setFieldValuesHolder, setGroupLevel

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractViewIssue

getAttachments, getPossibleComponents, getPossibleVersions, getPossibleVersionsReleasedFirst

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

addErrorMessage, assertIssueIsValid, cameFromIssue, cameFromParent, getId, getIssue, getIssueObject, getIssueObjectWithoutDatabaseRead, getIssuePath, getKey, getLayoutBean, getMutableIssue, getParentIssueObject, getProject, getProjectObject, getSecurityLevel, getSubTaskManager, getSummaryIssue, getViewIssueKey, getViewUrl, isEditable, isEditable, isHasEditIssuePermission, isIssueExists, isIssueValid, isSubTask, isSubTaskCreatable, isWorkflowAllowsEdit, redirectToView, refreshIssueObject, setId, setIssueObject, setKey, setViewIssueKey

Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport

addIssueToHistory, getAttachmentManager, getCurrentDateTimeInUsersTimezone, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getFormToken, getHoursPerDay, getIssueManager, getLastFailedLogin, getLastLogin, getLoginCount, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getPreviousLogin, getSearchRequest, getSelectedIssueId, getSessionPagerFilterManager, getSessionSearchRequestManager, getSessionSearchRequestManagerFactory, getSessionSelectedIssueManager, getTotalFailedLoginCount, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isElevatedSecurityCheckRequired, isFieldHidden, isFieldHidden, isTimeTrackingEnabled, setFormToken, setSearchRequest, setSelectedIssueId, updateSearchRequest

Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport

getBrowsableProjects, getSelectedProjectId, setSelectedProject, setSelectedProject

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, 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.jira.issue.customfields.OperationContext

getFieldValuesHolder, getIssueOperation

Methods inherited from interface com.atlassian.jira.web.action.issue.IssueSummaryAware

getLoggedInApplicationUser

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

LinkConfluencePage

@Autowired
public LinkConfluencePage(SubTaskManager subTaskManager,
                                     FieldScreenRendererFactory fieldScreenRendererFactory,
                                     FieldManager fieldManager,
                                     ProjectRoleManager projectRoleManager,
                                     CommentService commentService,
                                     UserUtil userUtil,
                                     RemoteIssueLinkService remoteIssueLinkService,
                                     com.atlassian.event.api.EventPublisher eventPublisher,
                                     IssueEventManager issueEventManager,
                                     IssueEventBundleFactory issueEventBundleFactory,
                                     ConfluenceApplicationLinks confluenceAppLinks,
                                     ConfluencePageService confluencePageService)

Method Detail

isValidToView

public boolean isValidToView()

Description copied from class: AbstractIssueLinkAction

Returns true if the contents of the action should be shown, false if otherwise.

Overrides:

isValidToView in class AbstractIssueLinkAction

Returns:

true if the contents of the action should be shown, false if otherwise

doValidation

protected void doValidation()

Description copied from class: AbstractIssueLinkAction

Validate that the user has permission to link issues, and that the comment field is valid. Override this method to perform validation specific to the concrete action. It is recommended that this method be invoked by any overriding methods.

Overrides:

doValidation in class AbstractIssueLinkAction

doDefault

public String doDefault()
                 throws Exception

Description copied from class: AbstractIssueLinkAction

The "default" command. Checks that the current issue exists and that the user has permission to view it.

Overrides:

doDefault in class AbstractIssueLinkAction

Returns:

INPUT if success, ERROR if otherwise

Throws:

Exception

doExecute

protected String doExecute()

Overrides:

doExecute in class webwork.action.ActionSupport

getPageUrl

public String getPageUrl()

setPageUrl

public void setPageUrl(String pageUrl)

getAppId

public String getAppId()

getFlushedErrorMessages

public Collection<String> getFlushedErrorMessages()

Description copied from interface: ErrorCollection

Get error messages, then get rid of them.

Specified by:

getFlushedErrorMessages in interface ErrorCollection

Overrides:

getFlushedErrorMessages in class JiraWebActionSupport

Returns:

The (now cleared) error messages.

getAppLinks

public Collection<com.atlassian.applinks.api.ApplicationLink> getAppLinks()