java.lang.Object
- com.jalios.jcms.context.JcmsContext
- - com.jalios.jcms.context.JcmsJspContext
  - - com.jalios.jcms.handler.JcmsFormHandler
    - - com.jalios.jcms.handler.EditDataHandler
      - com.jalios.jcms.member.csvimport.MemberCsvImportHandler

All Implemented Interfaces:

JcmsConstants, MemberImportConstants, JaliosConstants
```
public class MemberCsvImportHandler
extends EditDataHandler
implements MemberImportConstants
```
Handler providing Member CSV import.

Since:

jcms-10.0.8 / JCMS-10510

Author:

Sylvain Devaux

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ADMIN_USERS_MEMBER_ACL`
`protected boolean`	`asGuests`
`protected java.lang.Class<? extends Publication>`	`collaborativeSpaceClazz`
`protected boolean`	`collaborativeSpaceInitDone`
`protected boolean`	`collaborativeSpacePluginActive`
`static java.lang.String`	`CS_GROUP_ID_PARAM`
`protected java.lang.String[]`	`csGrpIds`
`static java.lang.String`	`CSV_COMMA_CHAR_SEP`
`static java.lang.String`	`CSV_FILE_HTML_PARAM`
`static java.lang.String`	`CSV_SEMICOLON_CHAR_SEP`
`protected java.io.File`	`csvFile`
`static java.lang.String`	`DBMEMBER_PARAM`
`protected java.lang.String`	`dbMembers`
`protected DocUploadInfo`	`docUploadInfo`
`protected java.lang.String`	`filename`
`protected static java.lang.String`	`FILENAME_HTML_PARAM`
`static java.lang.String`	`FORMHANDLER_REQ_ATTR`
`protected java.lang.String`	`gid`
`static java.lang.String`	`GID_PARAM`
`static java.lang.String`	`GLOBAL_GROUP_ID_PARAM`
`static java.lang.String`	`GLOBAL_GROUP_IDS_FLAG_PARAM`
`protected java.lang.String[]`	`globalGrpIds`
`static java.lang.String`	`IMPORT_TYPE_ACCOUNT`
`static java.lang.String`	`IMPORT_TYPE_CONTACT`
`static java.lang.String`	`IMPORT_TYPE_GUEST`
`static java.lang.String`	`IMPORT_TYPE_PARAM`
`protected boolean`	`isGlobalGrpStepReached`
`static java.lang.String`	`SEND_EMAIL_HTML_PARAM`
`protected boolean`	`sendEmail`
`protected java.lang.String`	`separator`
`static java.lang.String`	`SEPARATOR_HTML_PARAM`
`static int`	`STEP_1_FILE`
`static int`	`STEP_2_PREVIEW`
`static int`	`STEP_3`
`static int`	`STEP_4`
`static int`	`STEP_5`
`protected int`	`usage`
`static java.lang.String`	`USAGE_PARAM`
`protected boolean`	`useDbMembers`
`static java.lang.String`	`WS_GROUP_ID_PARAM`
`protected java.lang.String[]`	`wsGrpIds`

Fields inherited from class com.jalios.jcms.handler.EditDataHandler
extFormHandler, id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, 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.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

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, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_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_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_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, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, 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_COUNT_PROP_PREFIX, 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.jcms.member.csvimport.MemberImportConstants
COMMENT_CHARACTER, DEFAULT_AS_GUESTS, DEFAULT_DBMEMBER, DEFAULT_DEFERR_EMAILS, DEFAULT_USAGE, EMAIL_BATCH_DEFERR_SECONDS_PROP, IS_IMPORT_ENABLED_PROP, MAX_ERROR_PER_IMPORT_PROP, MAX_MEMBER_PER_IMPORT_PROP, MEMBER_DC_SRC_COLUMNS_KEY, MEMBER_IMPORT_PROCESS_ATTR, WORKSPACE_ROOT_CATEGORY_VID_PROP

Constructor Summary

Constructors
Constructor Description

MemberCsvImportHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`displayGuestOption()`
`boolean`	`displayUsageOption()`
`java.util.Collection<java.lang.String>`	`getAllGroupIds()`
`java.util.Set<Workspace>`	`getCollaborativeSpaceSet()`	Retrieve all the Collaborative workspaces as a Set, with the following conditions : workspace's isCollaborativeSpace() method return true; workspace is open workspace is not a model member belongs to workspace, or collaborative space has public access.
`int`	`getCreateCount()`
`java.lang.String[]`	`getCsGrpIds()`
`java.lang.Class<? extends Data>`	`getDataClass()`
`java.lang.String`	`getFilename()`
`int`	`getFormStepCount()`	Retrieve the total number of steps used for edition when invoking this form handler.
`java.lang.String`	`getFormStepHiddenFields()`
`java.lang.String`	`getGid()`
`Group`	`getGidGroup()`
`java.util.Set<Group>`	`getGlobalGroupSet()`
`java.lang.String[]`	`getGlobalGrpIds()`	Return common groups selected by user in GUI to add new members to.
`Group`	`getGuestGroup()`
`java.lang.String`	`getImportType()`
`int`	`getInvalidCount()`
`java.util.List<MemberImport>`	`getMemberInfoList()`
`java.lang.String`	`getModalCss()`
`java.lang.String`	`getModalHtmlAttributes()`
`java.lang.String`	`getModalTitle()`
`java.lang.String`	`getSendEmail()`
`java.lang.String`	`getSeparator()`
`int`	`getUpdateCount()`
`int`	`getUsage()`
`java.util.Set<Workspace>`	`getWorkspaceSet()`	Retrieve all the workspaces as a Set, with the following conditions : workspace's getCatSet() is child of "$id.member.csv-import.ws-root-cat" root category.
`java.lang.String[]`	`getWsGrpIds()`
`boolean`	`hasCollaborativeSpaceStep()`
`boolean`	`hasGlobalGroupsStep()`
`boolean`	`hasToSendEmail()`
`boolean`	`hasWorkspaceStep()`	Returns weither Workspace step should be displayed.
`protected void`	`init()`	Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
`boolean`	`isAccountMode()`	Return true if import mode is `Account`.
`boolean`	`isAnotherProcessRunning()`
`boolean`	`isAnyError()`
`protected boolean`	`isCollaborativeSpacePluginAvailable()`
`boolean`	`isContactMode()`	Return true if import mode is `Contact`.
`boolean`	`isGlobalGroupsStep()`
`boolean`	`isGuestMode()`
`boolean`	`isImportInProgress()`
`boolean`	`isImportProcessAuthor()`
`boolean`	`isPreviewStep()`
`boolean`	`performCancel()`
`protected boolean`	`performFinish()`
`protected boolean`	`performPrevious()`
`boolean`	`processAction()`	Method to be implemented to check/validate action to be performed and process them.
`void`	`setCsGrpIds(java.lang.String[] v)`
`void`	`setDbMembers(java.lang.String dbMembers)`	Set true to create Member in DataBase. False, to create JStore Members. Only used for creation, not for updates.
`void`	`setDocuments(java.lang.String[] v)`	Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.
`void`	`setFilename(java.lang.String filename)`	Set the name of the file, previous uploaded in temporary directory on first step, that we must use for CSV import.
`void`	`setGid(java.lang.String v)`
`void`	`setGlobalGrpIds(java.lang.String[] v)`
`void`	`setGlobalGrpIdsFlag(java.lang.String v)`	A flag to indicate common groups step was reached.
`void`	`setGuest(java.lang.String v)`	Set weither members have to be imported as guests.
`void`	`setImportType(java.lang.String importType)`
`void`	`setSendEmail(java.lang.String sendEmail)`
`void`	`setSeparator(java.lang.String separator)`
`void`	`setUsage(int usage)`
`void`	`setWsGrpIds(java.lang.String[] v)`
`boolean`	`showFinishButton()`	Check if the "Finish" button should be displayed in step modal form.
`boolean`	`showNextButton()`	Check if the "Next" button should be displayed in step modal form.
`boolean`	`showPreviousButton()`	Check if the "Previous" button should be displayed in step modal form.
`java.lang.String`	`toString()`
`boolean`	`useDbMembers()`
`protected boolean`	`validateFinish()`
`protected boolean`	`validateNext()`	Does custom check on csv file in update file step.
`protected boolean`	`validatePrevious()`

Methods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getDeleteRedirect, getEnumLabels, getEnumValues, getExtFormHandler, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isFirstAccess, performCreateExtension, performRefresh, performUpdateExtension, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, sendRedirect, setExtFormHandler, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setId, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateCreateExtension, validateRefresh, validateUpdateExtension, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performNext, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF

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, copyMsgListToMsgSessionList, 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, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, 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, updateWorkspace, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ADMIN_USERS_MEMBER_ACL
```
public static final java.lang.String ADMIN_USERS_MEMBER_ACL
```
    See Also:
    
    Constant Field Values
  - CSV_SEMICOLON_CHAR_SEP
```
public static final java.lang.String CSV_SEMICOLON_CHAR_SEP
```
    See Also:
    
    Constant Field Values
  - CSV_COMMA_CHAR_SEP
```
public static final java.lang.String CSV_COMMA_CHAR_SEP
```
    See Also:
    
    Constant Field Values
  - CSV_FILE_HTML_PARAM
```
public static final java.lang.String CSV_FILE_HTML_PARAM
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_HTML_PARAM
```
public static final java.lang.String SEPARATOR_HTML_PARAM
```
    See Also:
    
    Constant Field Values
  - SEND_EMAIL_HTML_PARAM
```
public static final java.lang.String SEND_EMAIL_HTML_PARAM
```
    See Also:
    
    Constant Field Values
  - WS_GROUP_ID_PARAM
```
public static final java.lang.String WS_GROUP_ID_PARAM
```
    See Also:
    
    Constant Field Values
  - CS_GROUP_ID_PARAM
```
public static final java.lang.String CS_GROUP_ID_PARAM
```
    See Also:
    
    Constant Field Values
  - GLOBAL_GROUP_ID_PARAM
```
public static final java.lang.String GLOBAL_GROUP_ID_PARAM
```
    See Also:
    
    Constant Field Values
  - GID_PARAM
```
public static final java.lang.String GID_PARAM
```
    See Also:
    
    Constant Field Values
  - GLOBAL_GROUP_IDS_FLAG_PARAM
```
public static final java.lang.String GLOBAL_GROUP_IDS_FLAG_PARAM
```
    See Also:
    
    Constant Field Values
  - DBMEMBER_PARAM
```
public static final java.lang.String DBMEMBER_PARAM
```
    See Also:
    
    Constant Field Values
  - IMPORT_TYPE_PARAM
```
public static final java.lang.String IMPORT_TYPE_PARAM
```
    See Also:
    
    Constant Field Values
  - USAGE_PARAM
```
public static final java.lang.String USAGE_PARAM
```
    See Also:
    
    Constant Field Values
  - FORMHANDLER_REQ_ATTR
```
public static final java.lang.String FORMHANDLER_REQ_ATTR
```
    See Also:
    
    Constant Field Values
  - FILENAME_HTML_PARAM
```
protected static final java.lang.String FILENAME_HTML_PARAM
```
    See Also:
    
    Constant Field Values
  - STEP_1_FILE
```
public static final int STEP_1_FILE
```
    See Also:
    
    Constant Field Values
  - STEP_2_PREVIEW
```
public static final int STEP_2_PREVIEW
```
    See Also:
    
    Constant Field Values
  - STEP_3
```
public static final int STEP_3
```
    See Also:
    
    Constant Field Values
  - STEP_4
```
public static final int STEP_4
```
    See Also:
    
    Constant Field Values
  - STEP_5
```
public static final int STEP_5
```
    See Also:
    
    Constant Field Values
  - IMPORT_TYPE_ACCOUNT
```
public static final java.lang.String IMPORT_TYPE_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - IMPORT_TYPE_CONTACT
```
public static final java.lang.String IMPORT_TYPE_CONTACT
```
    See Also:
    
    Constant Field Values
  - IMPORT_TYPE_GUEST
```
public static final java.lang.String IMPORT_TYPE_GUEST
```
    See Also:
    
    Constant Field Values
  - separator
```
protected java.lang.String separator
```
  - sendEmail
```
protected boolean sendEmail
```
  - wsGrpIds
```
protected java.lang.String[] wsGrpIds
```
  - csGrpIds
```
protected java.lang.String[] csGrpIds
```
  - globalGrpIds
```
protected java.lang.String[] globalGrpIds
```
  - gid
```
protected java.lang.String gid
```
  - isGlobalGrpStepReached
```
protected boolean isGlobalGrpStepReached
```
  - docUploadInfo
```
protected DocUploadInfo docUploadInfo
```
  - dbMembers
```
protected java.lang.String dbMembers
```
  - useDbMembers
```
protected boolean useDbMembers
```
  - usage
```
protected int usage
```
  - asGuests
```
protected boolean asGuests
```
  - csvFile
```
protected java.io.File csvFile
```
  - filename
```
protected java.lang.String filename
```
  - collaborativeSpaceClazz
```
protected java.lang.Class<? extends Publication> collaborativeSpaceClazz
```
  - collaborativeSpacePluginActive
```
protected boolean collaborativeSpacePluginActive
```
  - collaborativeSpaceInitDone
```
protected boolean collaborativeSpaceInitDone
```
- Constructor Detail
  - MemberCsvImportHandler
```
public MemberCsvImportHandler()
```
- Method Detail
  - init
```
protected void init()
```
    Description copied from class: JcmsFormHandler
    
    Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
    You must absolutely not perform any action which modify data or site configuration.
    Therefore it is strongly recommend NOT TO implement this method, or use very wisely.
    
    Overrides:
    
    init in class JcmsFormHandler
  - processAction
```
public boolean processAction()
                      throws java.io.IOException
```
    Description copied from class: JcmsFormHandler
    
    Method to be implemented to check/validate action to be performed and process them.
    Default implementation is to return false. No need to call super method.
    This method may NOT be invoked at all if security validation are not met.
    You must ensure your handler and JSP can work properly without any code invoked in this method.
    
    Overrides:
    
    processAction in class EditDataHandler
    
    Returns:
    
    false if no redirection is needed, true otherwise
    
    Throws:
    
    java.io.IOException - IO Exception
  - getDataClass
```
public java.lang.Class<? extends Data> getDataClass()
```
    Specified by:
    
    getDataClass in class EditDataHandler
  - validatePrevious
```
protected boolean validatePrevious()
                            throws java.io.IOException
```
    Overrides:
    
    validatePrevious in class JcmsFormHandler
    
    Throws:
    
    java.io.IOException
  - validateFinish
```
protected boolean validateFinish()
                          throws java.io.IOException
```
    Overrides:
    
    validateFinish in class JcmsFormHandler
    
    Throws:
    
    java.io.IOException
  - isImportInProgress
```
public boolean isImportInProgress()
```
  - isPreviewStep
```
public boolean isPreviewStep()
```
  - isImportProcessAuthor
```
public boolean isImportProcessAuthor()
```
  - performFinish
```
protected boolean performFinish()
                         throws java.io.IOException
```
    Overrides:
    
    performFinish in class JcmsFormHandler
    
    Throws:
    
    java.io.IOException
  - performPrevious
```
protected boolean performPrevious()
                           throws java.io.IOException
```
    Overrides:
    
    performPrevious in class JcmsFormHandler
    
    Throws:
    
    java.io.IOException
  - showPreviousButton
```
public boolean showPreviousButton()
```
    Description copied from class: JcmsFormHandler
    
    Check if the "Previous" button should be displayed in step modal form.
    The default implementation of this method is to return true if the current step (as returned by JcmsFormHandler.getFormStep() is higher than 0.
    You can provide a custom FormHandler to override this behavior.
    See jcore/doStepButtons.jspf for use of this method.
    
    Overrides:
    
    showPreviousButton in class JcmsFormHandler
    
    Returns:
    
    true to display the "Previous" button, false to hide it
  - showNextButton
```
public boolean showNextButton()
```
    Description copied from class: JcmsFormHandler
    
    Check if the "Next" button should be displayed in step modal form.
    The default implementation of this method is to return true unless the finish button is being displayed by method JcmsFormHandler.showFinishButton().
    You can provide a custom FormHandler to override this behavior.
    See jcore/doStepButtons.jspf for use of this method.
    
    Overrides:
    
    showNextButton in class JcmsFormHandler
    
    Returns:
    
    true to display the "Next" button, false to hide it
  - performCancel
```
public boolean performCancel()
                      throws java.io.IOException
```
    Overrides:
    
    performCancel in class EditDataHandler
    
    Throws:
    
    java.io.IOException
  - showFinishButton
```
public boolean showFinishButton()
```
    Description copied from class: JcmsFormHandler
    
    Check if the "Finish" button should be displayed in step modal form.
    The default implementation of this method is to return true if the current step (as returned by JcmsFormHandler.getFormStep() is the last one (as compared with JcmsFormHandler.getFormStepCount().
    You can provide a custom FormHandler to override this behavior.
    See jcore/doStepButtons.jspf for use of this method.
    
    Overrides:
    
    showFinishButton in class JcmsFormHandler
    
    Returns:
    
    true to display the "Finish" button, false to hide it
  - getFormStepHiddenFields
```
public java.lang.String getFormStepHiddenFields()
```
    Overrides:
    
    getFormStepHiddenFields in class JcmsFormHandler
  - getFormStepCount
```
public int getFormStepCount()
```
    Description copied from class: JcmsFormHandler
    
    Retrieve the total number of steps used for edition when invoking this form handler.
    The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
    You can provide a custom FormHandler to override this behavior.
    See jcore/doSteps.jspf for use of this method.
    
    Overrides:
    
    getFormStepCount in class JcmsFormHandler
    
    Returns:
    
    the total number of steps in this formhandler
  - getModalTitle
```
public java.lang.String getModalTitle()
```
  - getModalHtmlAttributes
```
public java.lang.String getModalHtmlAttributes()
```
  - getModalCss
```
public java.lang.String getModalCss()
```
  - isCollaborativeSpacePluginAvailable
```
protected boolean isCollaborativeSpacePluginAvailable()
```
    Returns:
    
    true if CollaborativeSpace plugin is active.
    
    Since:
    
    jcms-10.0.8
  - validateNext
```
protected boolean validateNext()
                        throws java.io.IOException
```
    Does custom check on csv file in update file step.
    
    Overrides:
    
    validateNext in class JcmsFormHandler
    
    Returns:
    
    true if file is ok at upload step, else if opNext is clicked
    
    Throws:
    
    java.io.IOException - if an exception occurs while simulating import.
    
    Since:
    
    jcms-10.0.8
  - hasWorkspaceStep
```
public boolean hasWorkspaceStep()
```
    Returns weither Workspace step should be displayed.
    
    Returns:
    
    true if a valid Workspaces root category has been defined, and the logged member can see at least one workspace under this cat. See getWorkspaceSet().
  - hasCollaborativeSpaceStep
```
public boolean hasCollaborativeSpaceStep()
```
    Returns:
    
    true if the current loggedMember can see any Collaborative Space.
  - hasGlobalGroupsStep
```
public boolean hasGlobalGroupsStep()
```
    Returns:
    
    true if the current loggedMember can see any global groups.
    
    Since:
    
    jcms-10.0.5
  - isGlobalGroupsStep
```
public boolean isGlobalGroupsStep()
```
  - getWorkspaceSet
```
public java.util.Set<Workspace> getWorkspaceSet()
```
    Retrieve all the workspaces as a Set, with the following conditions :
    
    workspace's getCatSet() is child of "$id.member.csv-import.ws-root-cat" root category.
    
    the workspace is not a collaborative space
    
    the workspace is not a model
    
    the workspace is open
    
    the workspace does have at least one group visible by loggedMember
    Returns:
    
    the ws set.
    
    Since:
    
    jcms-10.0.8
  - getCollaborativeSpaceSet
```
public java.util.Set<Workspace> getCollaborativeSpaceSet()
```
    Retrieve all the Collaborative workspaces as a Set, with the following conditions :
    
    workspace's isCollaborativeSpace() method return true;
    
    workspace is open
    
    workspace is not a model
    
    member belongs to workspace, or collaborative space has public access.
    
    the workspace does have at least one group visible by loggedMember
    Returns:
    
    the ws set.
    
    Since:
    
    jcms-10.0.8
  - getGlobalGroupSet
```
public java.util.Set<Group> getGlobalGroupSet()
```
  - isAnotherProcessRunning
```
public boolean isAnotherProcessRunning()
```
  - setDocuments
```
public void setDocuments(java.lang.String[] v)
```
    Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.
    
    Parameters:
    
    v - the documents argument from plupload.
    
    Since:
    
    jcms-10.0.8
  - getSeparator
```
public java.lang.String getSeparator()
```
    Returns:
    
    the separator
    
    Since:
    
    jcms-10.0.8
  - setSeparator
```
public void setSeparator(java.lang.String separator)
```
    Parameters:
    
    separator - the separator to set
    
    Since:
    
    jcms-10.0.8
  - getSendEmail
```
public java.lang.String getSendEmail()
```
    Returns:
    
    the sendEmail
    
    Since:
    
    jcms-10.0.8
  - setSendEmail
```
public void setSendEmail(java.lang.String sendEmail)
```
    Parameters:
    
    sendEmail - the sendEmail to set
    
    Since:
    
    jcms-10.0.8
  - hasToSendEmail
```
public boolean hasToSendEmail()
```
    Returns:
    
    the sendEmail
    
    Since:
    
    jcms-10.0.8
  - setDbMembers
```
public void setDbMembers(java.lang.String dbMembers)
```
    Set true to create Member in DataBase.
    False, to create JStore Members.
    Only used for creation, not for updates.
    
    Parameters:
    
    dbMembers - the dbMembers to set
    
    Since:
    
    jcms-10.0.8
  - useDbMembers
```
public boolean useDbMembers()
```
    Returns:
    
    Weither to use DBMember or Member class.
    
    Since:
    
    jcms-10.0.8
  - getCreateCount
```
public int getCreateCount()
```
    Returns:
    
    the createCount
    
    Since:
    
    jcms-10.0.8
  - getUpdateCount
```
public int getUpdateCount()
```
    Returns:
    
    the updateCount
    
    Since:
    
    jcms-10.0.8
  - getInvalidCount
```
public int getInvalidCount()
```
    Returns:
    
    the invalidCount
    
    Since:
    
    jcms-10.0.8
  - getMemberInfoList
```
public java.util.List<MemberImport> getMemberInfoList()
```
    Returns:
    
    the memberInfoList
    
    Since:
    
    jcms-10.0.8
  - isAnyError
```
public boolean isAnyError()
```
    Returns:
    
    true if the current import manager contains error.
    
    Since:
    
    jcms-10.0.8
  - getWsGrpIds
```
public java.lang.String[] getWsGrpIds()
```
    Returns:
    
    the wsGrpIds
    
    Since:
    
    jcms-10.0.8
  - setWsGrpIds
```
public void setWsGrpIds(java.lang.String[] v)
```
    Parameters:
    
    v - the wsGrpIds to set
    
    Since:
    
    jcms-10.0.8
  - getCsGrpIds
```
public java.lang.String[] getCsGrpIds()
```
    Returns:
    
    the csGrpIds
    
    Since:
    
    jcms-10.0.8
  - setCsGrpIds
```
public void setCsGrpIds(java.lang.String[] v)
```
    Parameters:
    
    v - the csGrpIds to set
    
    Since:
    
    jcms-10.0.8
  - getGlobalGrpIds
```
public java.lang.String[] getGlobalGrpIds()
```
    Return common groups selected by user in GUI to add new members to.
    Note: before 10.0.7 (JCMS-9493):
    Automatically adds channel default group by default, only if file validation step was reached, and if common groups step was not reached, when opImport is posted. Since 10.0.7 (JCMS-9493), this no longer happen for guests accounts import.
    
    Returns:
    
    the globalGrpIds
    
    Since:
    
    jcms-10.0.5
  - setGlobalGrpIds
```
public void setGlobalGrpIds(java.lang.String[] v)
```
    Parameters:
    
    v - the globalGrpIds to set
    
    Since:
    
    jcms-10.0.5
  - setGlobalGrpIdsFlag
```
public void setGlobalGrpIdsFlag(java.lang.String v)
```
    A flag to indicate common groups step was reached.
    Note: before 10.0.7 (JCMS-9493):
    When true, selected common groups will not be modified, and will be exactly ones user requested.
    When false, default common groups can be selected by the system. (eg: the channel default Group)
    Since 10.0.7 (JCMS-9493), default group is no longer added to those groups.
    
    Parameters:
    
    v - true when step was reached
    
    Since:
    
    jcms-10.0.6 JCMS-8958
  - getGid
```
public java.lang.String getGid()
```
  - getGidGroup
```
public Group getGidGroup()
```
  - setGid
```
public void setGid(java.lang.String v)
```
  - getAllGroupIds
```
public java.util.Collection<java.lang.String> getAllGroupIds()
```
    Returns:
    
    all the groups members to be added in
    
    Since:
    
    jcms-10.0.7
  - setImportType
```
public void setImportType(java.lang.String importType)
```
    Parameters:
    
    importType - the type of import
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - getImportType
```
public java.lang.String getImportType()
```
    Returns:
    
    tye type of import
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - getUsage
```
public int getUsage()
```
    Returns:
    
    the usage (Account or contact) for members to create.
    
    Since:
    
    jcms-10.0.8
  - setUsage
```
public void setUsage(int usage)
```
    Parameters:
    
    usage - the usage (Account or contact) for members to create to set.
    
    Since:
    
    jcms-10.0.8
  - isAccountMode
```
public boolean isAccountMode()
```
    Return true if import mode is Account.
    
    Returns:
    
    true if import mode is Account.
    
    Since:
    
    jcms-10.0.8
  - isContactMode
```
public boolean isContactMode()
```
    Return true if import mode is Contact.
    
    Returns:
    
    true if import mode is Contact.
    
    Since:
    
    jcms-10.0.8
  - displayUsageOption
```
public boolean displayUsageOption()
```
    Returns:
    
    true if option usage must be proposed.
    
    Since:
    
    jcms-10.0.8
  - displayGuestOption
```
public boolean displayGuestOption()
```
    Returns:
    
    true if option import as guests must be proposed.
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - isGuestMode
```
public boolean isGuestMode()
```
    Returns:
    
    true if members should be imported as CSP guests.
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - getGuestGroup
```
public Group getGuestGroup()
```
    Returns:
    
    the guest group if any
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - setGuest
```
public void setGuest(java.lang.String v)
```
    Set weither members have to be imported as guests.
    
    Parameters:
    
    v - form parameter
    
    Since:
    
    jcms-10.0.5 / JCMS-8503
  - getFilename
```
public java.lang.String getFilename()
```
    Returns:
    
    the relative filename of the imported file.
    
    Since:
    
    jcms-10.0.8
  - setFilename
```
public void setFilename(java.lang.String filename)
```
    Set the name of the file, previous uploaded in temporary directory on first step, that we must use for CSV import.
    
    Parameters:
    
    filename - the filename to set
    
    Since:
    
    jcms-10.0.8
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MemberCsvImportHandler

Field Summary

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

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

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

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

Fields inherited from interface com.jalios.util.JaliosConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

Fields inherited from interface com.jalios.jcms.member.csvimport.MemberImportConstants

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

ADMIN_USERS_MEMBER_ACL

CSV_SEMICOLON_CHAR_SEP

CSV_COMMA_CHAR_SEP

CSV_FILE_HTML_PARAM

SEPARATOR_HTML_PARAM

SEND_EMAIL_HTML_PARAM

WS_GROUP_ID_PARAM

CS_GROUP_ID_PARAM

GLOBAL_GROUP_ID_PARAM

GID_PARAM

GLOBAL_GROUP_IDS_FLAG_PARAM

DBMEMBER_PARAM

IMPORT_TYPE_PARAM

USAGE_PARAM

FORMHANDLER_REQ_ATTR

FILENAME_HTML_PARAM

STEP_1_FILE

STEP_2_PREVIEW

STEP_3

STEP_4

STEP_5

IMPORT_TYPE_ACCOUNT

IMPORT_TYPE_CONTACT

IMPORT_TYPE_GUEST

separator

sendEmail

wsGrpIds

csGrpIds

globalGrpIds

gid

isGlobalGrpStepReached

docUploadInfo

dbMembers

useDbMembers

usage

asGuests

csvFile

filename

collaborativeSpaceClazz

collaborativeSpacePluginActive

collaborativeSpaceInitDone

Constructor Detail

MemberCsvImportHandler

Method Detail

init

processAction

getDataClass

validatePrevious

validateFinish

isImportInProgress

isPreviewStep

isImportProcessAuthor

performFinish

performPrevious

showPreviousButton

showNextButton

performCancel

showFinishButton

getFormStepHiddenFields

getFormStepCount

getModalTitle

getModalHtmlAttributes

getModalCss