com.jalios.jcms.caddy
Class CaddyPopinHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcms.caddy.CaddyPopinHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class CaddyPopinHandler
extends JcmsJspContext

This handler is used to add or remove content to the caddy.

Since:

jcms-5.1

Version:

$Revision: 33686 $

Author:

Olivier Jaquemet

Field Summary

protected int	action
static int	ACTION_ADD
static int	ACTION_ADD_CATEGORYS_CHILDREN
static String	ACTION_ADD_CATEGORYS_CHILDREN_STR
static String	ACTION_ADD_STR
static int	ACTION_CLEAR
static String	ACTION_CLEAR_STR
static int	ACTION_NOACTION
static int	ACTION_REMOVE
static String	ACTION_REMOVE_STR
static int	ACTION_REPLACE
static String	ACTION_REPLACE_STR
static String[]	ALL_ACTIONS
protected boolean	caddyUpdated
protected boolean	checkPstatus
protected Class<? extends Data>	dataClass
protected HashSet<Data>	dataSet
protected HashSet<String>	dbMemberIdSet
protected String	dbMemberQueryString
protected String	groupQueryString
protected String	memberQueryString
protected String	queryString
static String	REVISION
protected String	workspaceQueryString

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

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, 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, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, 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, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, 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

CaddyPopinHandler()

Method Summary

protected void	add() Add all data to the caddy.
protected void	addCategorysChildren() For all categories in the dataSet, add their descendant.
protected void	clear() Clear the caddy.
Class<? extends Data>	getDataClass()
String	getDataType()
boolean	isCaddyUpdated() Check if the caddy was updated from the invocation to this handler.
protected void	remove() Remove all data from the caddy.
protected void	replace() Replace all data from the caddy.
protected void	retrieveResultFromDBMemberQuery() Use the member query string to retrieve more results in the dataSet.
protected void	retrieveResultFromGroupQuery() Use the group query string to retrieve more results in the dataSet.
protected void	retrieveResultFromMemberQuery() Use the member query string to retrieve more results in the dataSet.
protected void	retrieveResultFromQuery() Use the query string to retrieve more results in the dataSet.
protected void	retrieveResultFromWorkspaceQuery() Use the workspace query string to retrieve more results in the dataSet.
void	setCadAction(String str) Define the type of action to do.
void	setCadCheckPstatus(String check) Set whether to check for pstatus when using query string (default is true)
void	setCadDataType(String str) Define the type of data we want to display.
void	setCadDbMemberQueryString(String dbMemberQueryString) Set the DBMember query string to query Data to add or remove to caddy.
void	setCadGroupQueryString(String groupQueryString) Set the group query string to query Data to add or remove to caddy.
void	setCadId(String id) Set id of Data to add or remove to caddy.
void	setCadIds(String[] ids) Set ids of Data to add or remove to caddy.
void	setCadMemberQueryString(String memberQueryString) Set the member query string to query Data to add or remove to caddy.
void	setCadQueryString(String queryString) Set the query string to query Data to add or remove to caddy.
void	setCadWorkspaceQueryString(String workspaceQueryString) Set the workspace query string to query Data to add or remove to caddy.
boolean	validate() Effectively trigger the action of this handler.

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

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

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

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, getWorkspace, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

ACTION_ADD_STR

public static final String ACTION_ADD_STR

See Also:

Constant Field Values

ACTION_REMOVE_STR

public static final String ACTION_REMOVE_STR

See Also:

Constant Field Values

ACTION_REPLACE_STR

public static final String ACTION_REPLACE_STR

See Also:

Constant Field Values

ACTION_ADD_CATEGORYS_CHILDREN_STR

public static final String ACTION_ADD_CATEGORYS_CHILDREN_STR

See Also:

Constant Field Values

ACTION_CLEAR_STR

public static final String ACTION_CLEAR_STR

See Also:

Constant Field Values

ALL_ACTIONS

public static final String[] ALL_ACTIONS

ACTION_NOACTION

public static final int ACTION_NOACTION

See Also:

Constant Field Values

ACTION_ADD

public static final int ACTION_ADD

See Also:

Constant Field Values

ACTION_REMOVE

public static final int ACTION_REMOVE

See Also:

Constant Field Values

ACTION_REPLACE

public static final int ACTION_REPLACE

See Also:

Constant Field Values

ACTION_ADD_CATEGORYS_CHILDREN

public static final int ACTION_ADD_CATEGORYS_CHILDREN

See Also:

Constant Field Values

ACTION_CLEAR

public static final int ACTION_CLEAR

See Also:

Constant Field Values

action

protected int action

dataClass

protected Class<? extends Data> dataClass

dataSet

protected HashSet<Data> dataSet

dbMemberIdSet

protected HashSet<String> dbMemberIdSet

queryString

protected String queryString

groupQueryString

protected String groupQueryString

memberQueryString

protected String memberQueryString

dbMemberQueryString

protected String dbMemberQueryString

workspaceQueryString

protected String workspaceQueryString

checkPstatus

protected boolean checkPstatus

caddyUpdated

protected boolean caddyUpdated

Constructor Detail

CaddyPopinHandler

public CaddyPopinHandler()

Method Detail

validate

public boolean validate()
                 throws IOException

Effectively trigger the action of this handler.

Returns:

true if a redirect was done, false otherwise

Throws:

IOException - on error

retrieveResultFromQuery

protected void retrieveResultFromQuery()

Use the query string to retrieve more results in the dataSet.

retrieveResultFromGroupQuery

protected void retrieveResultFromGroupQuery()

Use the group query string to retrieve more results in the dataSet.

retrieveResultFromMemberQuery

protected void retrieveResultFromMemberQuery()

Use the member query string to retrieve more results in the dataSet.

retrieveResultFromDBMemberQuery

protected void retrieveResultFromDBMemberQuery()

Use the member query string to retrieve more results in the dataSet.

retrieveResultFromWorkspaceQuery

protected void retrieveResultFromWorkspaceQuery()

Use the workspace query string to retrieve more results in the dataSet.

add

protected void add()

Add all data to the caddy.

remove

protected void remove()

Remove all data from the caddy.

replace

protected void replace()

Replace all data from the caddy.

clear

protected void clear()

Clear the caddy.

addCategorysChildren

protected void addCategorysChildren()

For all categories in the dataSet, add their descendant.

getDataClass

public Class<? extends Data> getDataClass()

getDataType

public String getDataType()

setCadAction

public void setCadAction(String str)

Define the type of action to do.

Parameters:

str - the action to perform, as a string

setCadDataType

public void setCadDataType(String str)

Define the type of data we want to display.

Parameters:

str - the data type to display, "Category", "Workspace", etc...

setCadId

public void setCadId(String id)

Set id of Data to add or remove to caddy.

Parameters:

id - an id of Data to add/remove from the caddy

setCadIds

public void setCadIds(String[] ids)

Set ids of Data to add or remove to caddy.

Parameters:

ids - an array of Data's id to add/remove from the caddy

setCadQueryString

public void setCadQueryString(String queryString)

Set the query string to query Data to add or remove to caddy.

Parameters:

queryString - a querystring as generated from QueryHandler

setCadGroupQueryString

public void setCadGroupQueryString(String groupQueryString)

Set the group query string to query Data to add or remove to caddy.

Parameters:

groupQueryString - a querystring as generated from GroupQueryHandler

Since:

jcms-5.7.4

setCadMemberQueryString

public void setCadMemberQueryString(String memberQueryString)

Set the member query string to query Data to add or remove to caddy.

Parameters:

memberQueryString - a querystring as generated from MemberQueryHandler

Since:

jcms-5.7.4

setCadDbMemberQueryString

public void setCadDbMemberQueryString(String dbMemberQueryString)

Set the DBMember query string to query Data to add or remove to caddy.

Parameters:

dbMemberQueryString - a querystring as generated from DBMemberQueryHandler

Since:

jcms-6.1

setCadWorkspaceQueryString

public void setCadWorkspaceQueryString(String workspaceQueryString)

Set the workspace query string to query Data to add or remove to caddy.

Parameters:

workspaceQueryString - a querystring as generated from WorkspaceQueryHandler

Since:

jcms-6.0

setCadCheckPstatus

public void setCadCheckPstatus(String check)

Set whether to check for pstatus when using query string (default is true)

Parameters:

check - true to check pstatus during query, false otherwise.

isCaddyUpdated

public boolean isCaddyUpdated()

Check if the caddy was updated from the invocation to this handler. Use this method AFTER the invocation to validate method.

Returns:

true if caddy was modified, false if was not changed.