com.jalios.jcms.workspace

Class WorkspaceQueryHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.AbstractQueryHandler<Workspace>

com.jalios.jcms.workspace.WorkspaceQueryHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class WorkspaceQueryHandler
extends AbstractQueryHandler<Workspace>

Search for Workspace, by checking rights, workspace belonging, and testing if member is worker of the workspace. Currently used in topbar and sidebar workspace lists

Since:

jcms-10.0.0

Author:

Kévin Bransard

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.handler.AbstractQueryHandler

AbstractQueryHandler.HiddenParamQhPrinter, AbstractQueryHandler.QueryHandlerPrinter, AbstractQueryHandler.QueryStringQhPrinter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
WorkspaceQueryHandler() Constructs a new empty WorkspaceQueryHandler with default option.
WorkspaceQueryHandler(java.lang.String queryString) Constructs a new WorkspaceQueryHandler by parsing the specified query string.
WorkspaceQueryHandler(java.lang.String queryString, javax.servlet.http.HttpServletRequest request) Constructs a new WorkspaceQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

Method Summary

Modifier and Type	Method and Description
protected org.apache.log4j.Logger	getLogger()
WorkspaceResult	getResults() Return a WorkspaceResult instance using filters specified in this WorkspaceQueryHandler.
java.util.Set<Workspace>	getResultSet() Return results of a query done using this WorkspaceQueryHandler.
java.util.Set<Workspace>	getResultSet(java.util.Comparator<? super Workspace> comparator) Return results of a query done using this WorkspaceQueryHandler.
java.lang.String	getWorkspaceQuery() Retrieves the text being search in workspace for this query
java.lang.String	getWsModel() Retrieve workspace model filter applied for this query.
java.lang.String	getWsState() Retrieve workspace state filter applied for this query.
java.lang.String	getWsType() Retrieve workspace type filter applied for this query.
boolean	isBelongsToWorkspace()
boolean	isOpSearch()
boolean	isShowModel()
boolean	isWithPortal()
boolean	isWorker()
protected void	parseQueryStringParam(java.lang.String paramName, java.lang.String[] paramValues) Method to be implemented by subclass to decode parameter from queryString.
protected java.lang.String	printParams(AbstractQueryHandler.QueryHandlerPrinter printer) Method to be implemented by subclass to provide params printing in query or hidden input format. Typical implementation :
void	setBelongsToWorkspace(boolean belongsToWorkspace)
void	setOpSearch(boolean opSearch)
void	setShowModel(boolean showModel)
void	setWithPortal(boolean withPortal)
void	setWorker(boolean worker)
void	setWorkspaceQuery(java.lang.String workspaceQuery) Set the text to search in Workspace title
void	setWsModel(java.lang.String filter) Set the workspace model filter to apply to searched workspace.
void	setWsState(java.lang.String filter) Set the workspace state filter to apply to searched workspace.
void	setWsType(java.lang.String filter) Set the workspace type filter to apply to searched workspace.
java.lang.String	toString()

Methods inherited from class com.jalios.jcms.handler.AbstractQueryHandler

getAttribute, getAttributeMap, getDataSet, getHiddenParams, getQueryString, init, parseQueryString, removeAttribute, setAttribute, setDataSet

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, performFinish, performNext, performPrevious, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate, validateFinish, validateNext, validatePrevious

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

WorkspaceQueryHandler

public WorkspaceQueryHandler()

Constructs a new empty WorkspaceQueryHandler with default option.

WorkspaceQueryHandler

public WorkspaceQueryHandler(java.lang.String queryString)

Constructs a new WorkspaceQueryHandler by parsing the specified query string.

See WorkspaceQueryHandler(String, HttpServletRequest) for a list of the decoded parameters.

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?) e.g : "text=welcome&worker=true"

Since:

jcms-10.0.4 / JCMS-7924

WorkspaceQueryHandler

public WorkspaceQueryHandler(java.lang.String queryString,
                             javax.servlet.http.HttpServletRequest request)

Constructs a new WorkspaceQueryHandler by parsing the specified query string and using informations available from the specified request (logged member, user language, etc).

The following parameters (and only those listed here) will be automatically decoded from the specified query string. Other parameters should be set using apropriate setters.

• "text" : setWorkspaceQuery(String)
• "belongsToWorkspace" : setBelongsToWorkspace(boolean)
• "worker" : setWorker(boolean)
• "showModel" : setShowModel(boolean)
• "withPortal" : setWithPortal(boolean)
• "wsType" : setWsType(String)
• "wsModel" : setWsModel(String)
• "wsState" : setWsState(String)

Parameters:

queryString - a query String consisting of parameters (key=value) to be set in this handler.

• Parameters must be separated with ampersand (&).
• Values must be encoded in UTF-8.
• Query must not starts with question mark (?) e.g : "text=welcome&worker=true"

request - the HttpServletRequest to use to retrieve loggedMember, userLang, userLocale that will be used by this handler, ignored if null.

Since:

jcms-10.0.4 / JCMS-7924

Method Detail

getResults

public WorkspaceResult getResults()

Return a WorkspaceResult instance using filters specified in this WorkspaceQueryHandler.

Warning - this method DOES NOT support the following option :

• setWsType(String)
• setWsModel(String)
• setWsState(String)
• AbstractQueryHandler.setDataSet(Set)

Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

Returns:

a WorkspaceResult, never return null

getResultSet

public java.util.Set<Workspace> getResultSet()

Return results of a query done using this WorkspaceQueryHandler.

Warning - this method DOES NOT support the following option :

• setShowModel(boolean), use setWsModel(String) instead

Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

Returns:

a new Set containing all Workspace found by this query.

Since:

jcms-10.0.4 / JCMS-7924

getResultSet

public java.util.Set<Workspace> getResultSet(java.util.Comparator<? super Workspace> comparator)

Return results of a query done using this WorkspaceQueryHandler.

Warning - this method DOES NOT support the following option :

• setShowModel(boolean), use setWsModel(String) instead

Warning: This method process the query each time it is invoked, therefore do not call it multiple times if you don't need it.

Parameters:

comparator - the optional Comparator to sort the return collection

Returns:

a new Set containing all Workspace found by this query.

Since:

jcms-10.0.4 / JCMS-7924

getWorkspaceQuery

public java.lang.String getWorkspaceQuery()

Retrieves the text being search in workspace for this query

Returns:

a string or null if no text is being searched

setWorkspaceQuery

public void setWorkspaceQuery(java.lang.String workspaceQuery)

Set the text to search in Workspace title

Parameters:

workspaceQuery - any string to look for in Workspaces

isOpSearch

public boolean isOpSearch()

setOpSearch

public void setOpSearch(boolean opSearch)

isBelongsToWorkspace

public boolean isBelongsToWorkspace()

setBelongsToWorkspace

public void setBelongsToWorkspace(boolean belongsToWorkspace)

isWorker

public boolean isWorker()

setWorker

public void setWorker(boolean worker)

isShowModel

public boolean isShowModel()

Returns:

the showModel

setShowModel

public void setShowModel(boolean showModel)

Parameters:

showModel - the showModel to set

isWithPortal

public boolean isWithPortal()

Returns:

the withPortal

setWithPortal

public void setWithPortal(boolean withPortal)

Parameters:

withPortal - the withPortal to set

setWsType

public void setWsType(java.lang.String filter)

Set the workspace type filter to apply to searched workspace.

• "all" (default) no filter (except filter defined with other setters)
• "ws" all but collaborative space
• "cs" collaborative space only

Parameters:

filter -

Since:

jcms-10.0.4 / JCMS-7924

getWsType

public java.lang.String getWsType()

Retrieve workspace type filter applied for this query.

Returns:

a string from value authorized in setter

Since:

jcms-10.0.4 / JCMS-7924

See Also:

setWsType(String)

setWsModel

public void setWsModel(java.lang.String filter)

Set the workspace model filter to apply to searched workspace.

• "all" (default) no filter (except filter defined with other setters)
• "true" model workspace only
• "false" all but model workspace

Parameters:

filter -

Since:

jcms-10.0.4 / JCMS-7924

getWsModel

public java.lang.String getWsModel()

Retrieve workspace model filter applied for this query.

Returns:

a string from value authorized in setter

Since:

jcms-10.0.4 / JCMS-7924

See Also:

setWsModel(String)

setWsState

public void setWsState(java.lang.String filter)

Set the workspace state filter to apply to searched workspace.

• "all" (default) no filter (except filter defined with other setters)
• "opened" opened workspace only
• "closed" closed workspace only

Parameters:

filter -

Since:

jcms-10.0.4 / JCMS-7924

getWsState

public java.lang.String getWsState()

Retrieve workspace state filter applied for this query.

Returns:

a string from value authorized in setter

Since:

jcms-10.0.4 / JCMS-7924

See Also:

setWsState(String)

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class AbstractQueryHandler<Workspace>

parseQueryStringParam

protected void parseQueryStringParam(java.lang.String paramName,
                                     java.lang.String[] paramValues)

Description copied from class: AbstractQueryHandler

Method to be implemented by subclass to decode parameter from queryString.

Specified by:

parseQueryStringParam in class AbstractQueryHandler<Workspace>

Parameters:

paramName - the parameter name, never null nor empty.

paramValues - the parameter values, NEVER NULL NOR EMPTY. You can safely invoke paramValues[0]

printParams

protected java.lang.String printParams(AbstractQueryHandler.QueryHandlerPrinter printer)

Description copied from class: AbstractQueryHandler

Method to be implemented by subclass to provide params printing in query or hidden input format.
Typical implementation :

 protected String printParams(QueryHandlerPrinter printer) {
   printer.printParam("foo", getFoo());
   printer.printParam("bar", getBar());
   return printer.toString();
 }
 

Specified by:

printParams in class AbstractQueryHandler<Workspace>

Parameters:

printer - a QueryHandlerPrinter to use

Returns:

a string containing all parameters of this handler printed using specified QueryHandlerPrinter.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object