Class CmsSearchIndexList
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.CmsDialog
-
- org.opencms.workplace.list.A_CmsListDialog
-
- org.opencms.workplace.tools.searchindex.CmsSearchIndexList
-
public class CmsSearchIndexList extends A_CmsListDialog
A list that displays all search indexes of the OpenCms installation and offers operations on them.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
LIST_ACTION_DELETE
list action id constant.static java.lang.String
LIST_ACTION_EDIT
list action id constant.static java.lang.String
LIST_ACTION_INDEXSOURCES
list action id constant.static java.lang.String
LIST_ACTION_REBUILD
list action id constant.static java.lang.String
LIST_ACTION_SEARCH
list action id constant.static java.lang.String
LIST_ACTION_SEARCHINDEX_OVERVIEW
list action id constant.static java.lang.String
LIST_COLUMN_CONFIGURATION
list column id constant.static java.lang.String
LIST_COLUMN_DELETE
list column id constant.static java.lang.String
LIST_COLUMN_EDIT
list column id constant.static java.lang.String
LIST_COLUMN_INDEXSOURCES
list column id constant.static java.lang.String
LIST_COLUMN_LOCALE
list column id constant.static java.lang.String
LIST_COLUMN_NAME
list column id constant.static java.lang.String
LIST_COLUMN_PROJECT
list column id constant.static java.lang.String
LIST_COLUMN_REBUILD
list column id constant.static java.lang.String
LIST_COLUMN_REBUILDMODE
list column id constant.static java.lang.String
LIST_COLUMN_SEARCH
list column id constant.static java.lang.String
LIST_DETAIL_FIELDCONFIGURATION
list item detail id constant.static java.lang.String
LIST_DETAIL_INDEXSOURCE
list item detail id constant.protected static java.lang.String
LIST_ICON_INDEX
The path to the searchindex list icon (edit column).protected static java.lang.String
LIST_ICON_INDEXSOURCE
The path to the indexsource list icon.protected static java.lang.String
LIST_ICON_REBUILD_MULTI
The path to the rebuild multiple indexes icon.protected static java.lang.String
LIST_ICON_REBUILD_SINGLE
The path to the rebuild single indexes icon.protected static java.lang.String
LIST_ICON_SEARCH
The path to the search (within indexsource) list icon.static java.lang.String
LIST_ID
list id constant.static java.lang.String
LIST_MACTION_DELETE
list action id constant.static java.lang.String
LIST_MACTION_REBUILD
list action id constant.-
Fields inherited from class org.opencms.workplace.list.A_CmsListDialog
ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, KEY_META_DATA_CACHE, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL
-
Fields inherited from class org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE
-
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
-
Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsSearchIndexList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor.CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName)
Public constructor.CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
Public constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
executeListMultiActions()
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
void
executeListSingleActions()
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
protected void
fillDetails(java.lang.String detailId)
Lazy initialization for detail data.protected java.util.List<CmsListItem>
getListItems()
Should generate a list with the list items to be displayed.protected void
initMessages()
protected void
setColumns(CmsListMetadata metadata)
Should create the columns and add them to the given list metadata object.protected void
setIndependentActions(CmsListMetadata metadata)
Should add the independent actions to the given list metadata object.protected void
setMultiActions(CmsListMetadata metadata)
Should add the multi actions to the given list metadata object.protected void
writeConfiguration(boolean refresh)
Writes the updated search configuration back to the XML configuration file and refreshes the complete list.-
Methods inherited from class org.opencms.workplace.list.A_CmsListDialog
actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog
-
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
-
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle
-
Methods inherited from class org.opencms.workplace.CmsWorkplace
addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
Field Detail
-
LIST_ACTION_DELETE
public static final java.lang.String LIST_ACTION_DELETE
list action id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_EDIT
public static final java.lang.String LIST_ACTION_EDIT
list action id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_INDEXSOURCES
public static final java.lang.String LIST_ACTION_INDEXSOURCES
list action id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_REBUILD
public static final java.lang.String LIST_ACTION_REBUILD
list action id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_SEARCH
public static final java.lang.String LIST_ACTION_SEARCH
list action id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_SEARCHINDEX_OVERVIEW
public static final java.lang.String LIST_ACTION_SEARCHINDEX_OVERVIEW
list action id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_CONFIGURATION
public static final java.lang.String LIST_COLUMN_CONFIGURATION
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_DELETE
public static final java.lang.String LIST_COLUMN_DELETE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_EDIT
public static final java.lang.String LIST_COLUMN_EDIT
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_INDEXSOURCES
public static final java.lang.String LIST_COLUMN_INDEXSOURCES
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_LOCALE
public static final java.lang.String LIST_COLUMN_LOCALE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_NAME
public static final java.lang.String LIST_COLUMN_NAME
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_PROJECT
public static final java.lang.String LIST_COLUMN_PROJECT
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_REBUILD
public static final java.lang.String LIST_COLUMN_REBUILD
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_REBUILDMODE
public static final java.lang.String LIST_COLUMN_REBUILDMODE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_SEARCH
public static final java.lang.String LIST_COLUMN_SEARCH
list column id constant.- See Also:
- Constant Field Values
-
LIST_DETAIL_FIELDCONFIGURATION
public static final java.lang.String LIST_DETAIL_FIELDCONFIGURATION
list item detail id constant.- See Also:
- Constant Field Values
-
LIST_DETAIL_INDEXSOURCE
public static final java.lang.String LIST_DETAIL_INDEXSOURCE
list item detail id constant.- See Also:
- Constant Field Values
-
LIST_ID
public static final java.lang.String LIST_ID
list id constant.- See Also:
- Constant Field Values
-
LIST_MACTION_DELETE
public static final java.lang.String LIST_MACTION_DELETE
list action id constant.- See Also:
- Constant Field Values
-
LIST_MACTION_REBUILD
public static final java.lang.String LIST_MACTION_REBUILD
list action id constant.- See Also:
- Constant Field Values
-
LIST_ICON_INDEX
protected static final java.lang.String LIST_ICON_INDEX
The path to the searchindex list icon (edit column).- See Also:
- Constant Field Values
-
LIST_ICON_INDEXSOURCE
protected static final java.lang.String LIST_ICON_INDEXSOURCE
The path to the indexsource list icon.- See Also:
- Constant Field Values
-
LIST_ICON_REBUILD_MULTI
protected static final java.lang.String LIST_ICON_REBUILD_MULTI
The path to the rebuild multiple indexes icon.- See Also:
- Constant Field Values
-
LIST_ICON_REBUILD_SINGLE
protected static final java.lang.String LIST_ICON_REBUILD_SINGLE
The path to the rebuild single indexes icon.- See Also:
- Constant Field Values
-
LIST_ICON_SEARCH
protected static final java.lang.String LIST_ICON_SEARCH
The path to the search (within indexsource) list icon.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsSearchIndexList
public CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.- Parameters:
jsp
- an initialized JSP action element
-
CmsSearchIndexList
public CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName)
Public constructor.- Parameters:
jsp
- an initialized JSP action elementlistId
- the id of the listlistName
- the list name
-
CmsSearchIndexList
public CmsSearchIndexList(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)
Public constructor.- Parameters:
jsp
- an initialized JSP action elementlistId
- the id of the displayed listlistName
- the name of the listsortedColId
- the a priory sorted columnsortOrder
- the order of the sorted columnsearchableColId
- the column to search into
-
CmsSearchIndexList
public CmsSearchIndexList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor.Public constructor with JSP variables.
- Parameters:
context
- the JSP page contextreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
executeListMultiActions
public void executeListMultiActions() throws java.io.IOException, javax.servlet.ServletException, org.opencms.main.CmsRuntimeException
Description copied from class:A_CmsListDialog
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListMultiActions
in classA_CmsListDialog
- Throws:
java.io.IOException
- in case of errors when including a required sub-elementjavax.servlet.ServletException
- in case of errors when including a required sub-elementorg.opencms.main.CmsRuntimeException
- to signal that an action is not supported- See Also:
A_CmsListDialog.executeListMultiActions()
-
executeListSingleActions
public void executeListSingleActions() throws java.io.IOException, javax.servlet.ServletException, org.opencms.main.CmsRuntimeException
Description copied from class:A_CmsListDialog
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListSingleActions
in classA_CmsListDialog
- Throws:
java.io.IOException
- in case of errors when including a required sub-elementjavax.servlet.ServletException
- in case of errors when including a required sub-elementorg.opencms.main.CmsRuntimeException
- to signal that an action is not supported- See Also:
A_CmsListDialog.executeListSingleActions()
-
fillDetails
protected void fillDetails(java.lang.String detailId)
Description copied from class:A_CmsListDialog
Lazy initialization for detail data.Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
- Specified by:
fillDetails
in classA_CmsListDialog
- Parameters:
detailId
- the id of the detail to initialize- See Also:
A_CmsListDialog.fillDetails(java.lang.String)
-
getListItems
protected java.util.List<CmsListItem> getListItems()
Description copied from class:A_CmsListDialog
Should generate a list with the list items to be displayed.- Specified by:
getListItems
in classA_CmsListDialog
- Returns:
- a list of
sCmsListItem
- See Also:
A_CmsListDialog.getListItems()
-
initMessages
protected void initMessages()
- Overrides:
initMessages
in classorg.opencms.workplace.CmsWorkplace
- See Also:
CmsWorkplace.initMessages()
-
setColumns
protected void setColumns(CmsListMetadata metadata)
Description copied from class:A_CmsListDialog
Should create the columns and add them to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setColumns
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
-
setIndependentActions
protected void setIndependentActions(CmsListMetadata metadata)
Description copied from class:A_CmsListDialog
Should add the independent actions to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setIndependentActions
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
-
setMultiActions
protected void setMultiActions(CmsListMetadata metadata)
Description copied from class:A_CmsListDialog
Should add the multi actions to the given list metadata object.This method will be just executed once, the first time the constructor is called.
- Specified by:
setMultiActions
in classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)
-
writeConfiguration
protected void writeConfiguration(boolean refresh)
Writes the updated search configuration back to the XML configuration file and refreshes the complete list.- Parameters:
refresh
- if true, the list items are refreshed
-
-