Package com.atlassian.jira.web.action.admin.index

Class IndexAdminImpl

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.ProjectActionSupport

com.atlassian.jira.web.action.admin.index.IndexAdminImpl

All Implemented Interfaces:

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

public class IndexAdminImpl
extends ProjectActionSupport
implements IndexAdmin

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.ProjectActionSupport

projectManager

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

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

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

Description

IndexAdminImpl(ProjectManager projectManager, PermissionManager permissionManager, IndexLifecycleManager indexLifecycleManager, GlobalPermissionManager globalPermissionManager, TaskManager taskManager, JiraAuthenticationContext authenticationContext, TaskDescriptorBean.Factory factory, IndexPathManager indexPathManager, FileFactory fileFactory, IndexRecoveryService indexRecoveryService, ClusterManager clusterManager, FileStores fileStores, I18nHelper.BeanFactory i18nBeanFactory, JohnsonProvider johnsonProvider, HelpUrls helpUrls, IndexingFeatures indexingFeatures, IndexCancellationManager indexCancellationManager, ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method	Description
void	addIllegalArgumentException(String fieldName, IllegalArgumentException e)	Override addIllegalArgumentException from the IllegalArgumentAware interface.
String	doAbortZombieTask()
String	doActivate()
String	doCancel()
String	doCopy()
String	doDefault()
protected String	doExecute()
String	doProgress()
String	doRecover()
String	doReindex()
String	getCannotReindexInForegroundMessage()
String	getCopyFromNodeId()
TaskDescriptorBean<IndexCommandResult>	getCurrentIndexTask()
String	getCurrentNodeId()
TaskDescriptorBean<IndexCommandResult>	getCurrentTask()
String	getDestinationURL()
String	getIndexPath()
String	getIndexSnapshotsPath()
String	getNodeId()
Collection<Node>	getNodeList()
String	getPrettyCron(String cronExpression)
String	getRecoveryFilename()
long	getReindexTime()
String	getSearchIndexingDocsLink()
String	getSnapshotCronExpression()
String	getSnapshotDirectory()
Long	getTaskId()
Map<String,Object>	getTemplateInputData()
String	getZombieTaskDocsLink()
boolean	isAnyLiveTasks()
boolean	isClustered()
boolean	isCopyRequested()
boolean	isCurrentIndexTaskZombie()
boolean	isHasSystemAdminPermission()
boolean	isIndexConsistent()
boolean	isIndexRecoveryFromRelativePathOnlyEnabled()
boolean	isTaskInProgress()
boolean	isTaskOnSameNode()
boolean	recoveryEnabled()
void	setCopyFromNodeId(String copyFromNodeId)
void	setRecoveryFilename(String recoveryFilename)
void	setReindexTime(long reindexTime)
void	setTaskId(Long taskId)

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, addErrorMessages, addErrorMessages, addErrors, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getActionNameJspa, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doValidation, 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 webwork.action.CommandDriven

getCommandName, setCommand

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

addError, addErrorMessage, setErrorMessages

Constructor Details

IndexAdminImpl

public IndexAdminImpl(ProjectManager projectManager,
 PermissionManager permissionManager,
 IndexLifecycleManager indexLifecycleManager,
 GlobalPermissionManager globalPermissionManager,
 TaskManager taskManager,
 JiraAuthenticationContext authenticationContext,
 TaskDescriptorBean.Factory factory,
 IndexPathManager indexPathManager,
 FileFactory fileFactory,
 IndexRecoveryService indexRecoveryService,
 ClusterManager clusterManager,
 FileStores fileStores,
 I18nHelper.BeanFactory i18nBeanFactory,
 JohnsonProvider johnsonProvider,
 HelpUrls helpUrls,
 IndexingFeatures indexingFeatures,
 IndexCancellationManager indexCancellationManager,
 ApplicationProperties applicationProperties)

Method Details

doDefault

public String doDefault()
                 throws Exception

Overrides:

doDefault in class webwork.action.ActionSupport

Throws:

Exception

getIndexPath

public String getIndexPath()

Specified by:

getIndexPath in interface IndexAdmin

getIndexSnapshotsPath

public String getIndexSnapshotsPath()

getNodeId

public String getNodeId()

addIllegalArgumentException

public void addIllegalArgumentException(String fieldName,
 IllegalArgumentException e)

Override addIllegalArgumentException from the IllegalArgumentAware interface. This method is called from within the Jira WebWork implementation when an IllegalArgumentException is thrown by a field validator e.g. when a query param has an incorrect type. The default behaviour redirects to the Error view instead of running the action (doExecute method). Index Admin page needs to call doExecute to enable switching to different views based on the Search Platform so automatic handling of validation errors is disabled, and they are handled manually.

Specified by:

addIllegalArgumentException in interface webwork.action.IllegalArgumentAware

Overrides:

addIllegalArgumentException in class JiraWebActionSupport

Parameters:

fieldName - The name of the field that caused the exception.

e - The IllegalArgumentException that was thrown.

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

doActivate

public String doActivate()
                  throws Exception

Specified by:

doActivate in interface IndexAdmin

Throws:

Exception

doReindex

public String doReindex()
                 throws Exception

Specified by:

doReindex in interface IndexAdmin

Throws:

Exception

doProgress

public String doProgress()
                  throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

doCancel

public String doCancel()
                throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

doRecover

public String doRecover()
                 throws Exception

Throws:

Exception

isIndexRecoveryFromRelativePathOnlyEnabled

public boolean isIndexRecoveryFromRelativePathOnlyEnabled()

doCopy

public String doCopy()
              throws Exception

Throws:

Exception

getReindexTime

public long getReindexTime()

Specified by:

getReindexTime in interface IndexAdmin

setReindexTime

public void setReindexTime(long reindexTime)

isAnyLiveTasks

public boolean isAnyLiveTasks()

isHasSystemAdminPermission

public boolean isHasSystemAdminPermission()

getTaskId

public Long getTaskId()

setTaskId

public void setTaskId(Long taskId)

getCurrentIndexTask

public TaskDescriptorBean<IndexCommandResult> getCurrentIndexTask()

getCurrentTask

public TaskDescriptorBean<IndexCommandResult> getCurrentTask()

isIndexConsistent

public boolean isIndexConsistent()

getDestinationURL

public String getDestinationURL()

isTaskInProgress

public boolean isTaskInProgress()

getCannotReindexInForegroundMessage

public String getCannotReindexInForegroundMessage()

getRecoveryFilename

public String getRecoveryFilename()

setRecoveryFilename

public void setRecoveryFilename(String recoveryFilename)

getSnapshotCronExpression

public String getSnapshotCronExpression()

getPrettyCron

public String getPrettyCron(String cronExpression)

getSnapshotDirectory

public String getSnapshotDirectory()

recoveryEnabled

public boolean recoveryEnabled()

getCopyFromNodeId

public String getCopyFromNodeId()

setCopyFromNodeId

public void setCopyFromNodeId(String copyFromNodeId)

getNodeList

public Collection<Node> getNodeList()

isClustered

public boolean isClustered()

getCurrentNodeId

public String getCurrentNodeId()

isCopyRequested

public boolean isCopyRequested()

isTaskOnSameNode

public boolean isTaskOnSameNode()

isCurrentIndexTaskZombie

public boolean isCurrentIndexTaskZombie()

doAbortZombieTask

public String doAbortZombieTask()
                         throws ExecutionException,
InterruptedException

Throws:

ExecutionException

InterruptedException

getTemplateInputData

public Map<String,Object> getTemplateInputData()

getZombieTaskDocsLink

public String getZombieTaskDocsLink()

getSearchIndexingDocsLink

public String getSearchIndexingDocsLink()