MembersCsvImportHandler (JCMS API)

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.handler.MembersCsvImportHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class MembersCsvImportHandler
extends EditDataHandler
```
This handler is used to perform Member CSV import through JCMS modal.
See also MemberImportManager.

Since:

jcms-8

Version:

$Revision: 83982 $

Author:

Sylvain Devaux

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADMIN_USERS_MEMBER_ACL`
`protected java.lang.Class<? extends Publication>`	`collaborativeSpaceClazz` The optional Collaborative Space class.
`protected boolean`	`collaborativeSpaceInitDone`
`static java.lang.String`	`CREATED_IDS_REQ_ATTR`
`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` The uploaded csvFile.
`static java.lang.String`	`DBMEMBER_PARAM`
`protected java.lang.String`	`dbMembers` True to store as DBMember.class, false as Member.class.
`protected DocUploadInfo`	`docUploadInfo`
`static java.lang.String`	`EMAIL_SENT_REQ_ATTR`
`protected long`	`endTime` For debug purpose.
`protected java.lang.String`	`filename` Used to pass the fileDoc filename through different steps.
`protected static java.lang.String`	`FILENAME_HTML_PARAM`
`protected boolean`	`hasToSendEmail`
`static java.lang.String`	`IMPORT_DONE_REQ_ATTR`
`protected MemberImportManager`	`importManager`
`protected boolean`	`isBlockingError` Is there any blocking error during checking the csv file ? Not implemented yet.
`protected java.util.List<MemberImport>`	`memberInfoList` The list containing each line.
`protected boolean`	`opUpload`
`static java.lang.String`	`REVISION`
`static java.lang.String`	`SEND_EMAIL_HTML_PARAM`
`protected java.lang.String`	`sendEmail`
`protected java.lang.String`	`separator`
`static java.lang.String`	`SEPARATOR_HTML_PARAM`
`protected long`	`startTime` For debug purpose.
`static int`	`STEP_1_FILE`
`static int`	`STEP_2_PREVIEW`
`static int`	`STEP_3`
`static int`	`STEP_4`
`static java.lang.String`	`UPDATED_IDS_REQ_ATTR`
`protected int`	`usage` The usage to set for members to create. By default creates Accounts.
`static java.lang.String`	`USAGE_PARAM`
`protected boolean`	`useDbMembers` Same as `dbMembers`, as boolean.
`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, op, opCancel, opCreate, opDelete, opFinish, opNext, opPrevious, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdate

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, 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, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, 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, 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, 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, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, 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, 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

Constructors
Constructor and Description

MembersCsvImportHandler()
The default constructor.
Checks first the actual member limit to avoid member import if limit is already reached.

Constructors
Constructor and Description
`MembersCsvImportHandler()` The default constructor. Checks first the actual member limit to avoid member import if limit is already reached.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`deleteCsvFile()` If the file exists, try to delete it. This method has to be called each time the csvFile is no more used (eg.
`boolean`	`displayUsageOption()`
`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 worksapce, or collaborative space has public access.
`int`	`getCreateCount()`
`java.lang.String[]`	`getCsGrpIds()`
`java.lang.Class<? extends Data>`	`getDataClass()` Overriding EditDataHandler for Steps modal Form purpose, but not really editing a Data.
`java.lang.String`	`getFilename()`
`int`	`getFormStepCount()` The number of steps is dynamic, is minimum 2, and maximum 4.
`java.lang.String`	`getFormStepHiddenFields()` Stores through different steps the uploaded file path.
`protected java.lang.String`	`getHiddenField(java.lang.String htmlName, java.io.File csvFile)` Specific method to put a file relative to JCMS temp dir as hidden modal field. Does not encode value, since super.getHiddenField() does it.
`int`	`getInvalidCount()`
`java.util.List<MemberImport>`	`getMemberInfoList()`
`java.lang.String`	`getSendEmail()`
`java.lang.String`	`getSeparator()`
`int`	`getUpdateCount()`
`protected java.io.File`	`getUploadDir()`
`int`	`getUsage()`
`java.util.Set<Workspace>`	`getWorkspaceSet()` Retrieve all the workspaces as a Set, with the following conditions : workspace's getCatSet() is child of `getWorkspaceRootCat()` root category.
`java.lang.String[]`	`getWsGrpIds()`
`boolean`	`hasToSendEmail()`
`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`	`isAnyError()`
`protected boolean`	`isCollaborativeSpacePluginAvailable()`
`boolean`	`isCollaborativeSpaceStep()`
`boolean`	`isContactMode()` Return true if import mode is `Contact`.
`boolean`	`isWorkspaceStep()`
`boolean`	`processAction()` Performs the import (real or simulation) if a valid CSV file has been uploaded.
`void`	`setCsGrpIds(java.lang.String[] csGrpIds)`
`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)`
`void`	`setOpUpload(java.lang.String upload)`
`void`	`setSendEmail(java.lang.String sendEmail)`
`void`	`setSeparator(java.lang.String separator)`
`void`	`setUsage(int usage)`
`void`	`setWsGrpIds(java.lang.String[] wsGrpIds)`
`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.
`boolean`	`useDbMembers()`
`protected boolean`	`validateFinish()`
`protected boolean`	`validatePrevious()`
`boolean`	`validateUpload()` Validates the file format to import.

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

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
checkMissingField, getAvailableMainLanguage, 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, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, 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, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, 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, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
  - ADMIN_USERS_MEMBER_ACL
```
public static final java.lang.String ADMIN_USERS_MEMBER_ACL
```
    See Also:
    
    Constant Field Values
  - opUpload
```
protected boolean opUpload
```
  - separator
```
protected java.lang.String separator
```
  - sendEmail
```
protected java.lang.String sendEmail
```
  - hasToSendEmail
```
protected boolean hasToSendEmail
```
  - wsGrpIds
```
protected java.lang.String[] wsGrpIds
```
  - csGrpIds
```
protected java.lang.String[] csGrpIds
```
  - docUploadInfo
```
protected DocUploadInfo docUploadInfo
```
  - dbMembers
```
protected java.lang.String dbMembers
```
    True to store as DBMember.class, false as Member.class.
    
    Since:
    
    jcms-8.0.1
  - useDbMembers
```
protected boolean useDbMembers
```
    Same as dbMembers, as boolean.
  - usage
```
protected int usage
```
    The usage to set for members to create.
    By default creates Accounts.
    
    Since:
    
    jcms-8.0.1
  - csvFile
```
protected java.io.File csvFile
```
    The uploaded csvFile. May only be set after step 1.
    It is retrieved only when filename is posted (as hidden field).
  - 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
  - DBMEMBER_PARAM
```
public static final java.lang.String DBMEMBER_PARAM
```
    See Also:
    
    Constant Field Values
  - USAGE_PARAM
```
public static final java.lang.String USAGE_PARAM
```
    See Also:
    
    Constant Field Values
  - IMPORT_DONE_REQ_ATTR
```
public static final java.lang.String IMPORT_DONE_REQ_ATTR
```
    See Also:
    
    Constant Field Values
  - CREATED_IDS_REQ_ATTR
```
public static final java.lang.String CREATED_IDS_REQ_ATTR
```
    See Also:
    
    Constant Field Values
  - UPDATED_IDS_REQ_ATTR
```
public static final java.lang.String UPDATED_IDS_REQ_ATTR
```
    See Also:
    
    Constant Field Values
  - EMAIL_SENT_REQ_ATTR
```
public static final java.lang.String EMAIL_SENT_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
  - startTime
```
protected long startTime
```
    For debug purpose.
  - endTime
```
protected long endTime
```
    For debug purpose.
  - isBlockingError
```
protected boolean isBlockingError
```
    Is there any blocking error during checking the csv file ? Not implemented yet. (No case of blocking error).
  - filename
```
protected java.lang.String filename
```
    Used to pass the fileDoc filename through different steps.
  - memberInfoList
```
protected java.util.List<MemberImport> memberInfoList
```
    The list containing each line.
  - importManager
```
protected MemberImportManager importManager
```
  - collaborativeSpaceClazz
```
protected java.lang.Class<? extends Publication> collaborativeSpaceClazz
```
    The optional Collaborative Space class.
    
    Since:
    
    jcms-8
  - collaborativeSpaceInitDone
```
protected boolean collaborativeSpaceInitDone
```
- Constructor Detail
  - MembersCsvImportHandler
```
public MembersCsvImportHandler()
```
    The default constructor.
    Checks first the actual member limit to avoid member import if limit is already reached.
    
    Since:
    
    jcms-8
- Method Detail
  - processAction
```
public boolean processAction()
                      throws java.io.IOException
```
    Performs the import (real or simulation) if a valid CSV file has been uploaded.
    
    Overrides:
    
    processAction in class EditDataHandler
    
    Returns:
    
    true if import has been performed.
    
    Throws:
    
    java.io.IOException - IO Exception
    
    Since:
    
    jcms-8
  - 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
    
    Since:
    
    jcms-8
    
    See Also:
    
    JcmsFormHandler.init()
  isCollaborativeSpacePluginAvailable
  
  protected boolean isCollaborativeSpacePluginAvailable()
  
  Returns:
  
  true if the generated.CollaborativeSpace.class has been found.
  
  Since:
  
  jcms-8
  
  validatePrevious
  
  protected boolean validatePrevious() throws java.io.IOException
  
  Overrides:
  
  validatePrevious in class EditDataHandler
  
  Throws:
  
  java.io.IOException
  
  Since:
  
  jcms-8
  
  validateUpload
  
  public boolean validateUpload() throws java.io.IOException
  
  Validates the file format to import.
  
  Returns:
  
  true if file is ok.
  
  Throws:
  
  java.io.IOException - if an exception occurs while simulating import.
  
  Since:
  
  jcms-8.0.1
  
  validateFinish
  
  protected boolean validateFinish() throws java.io.IOException
  
  Overrides:
  
  validateFinish in class EditDataHandler
  
  Throws:
  
  java.io.IOException
  
  Since:
  
  jcms-8
  
  deleteCsvFile
  
  protected void deleteCsvFile()
  
  If the file exists, try to delete it.
  This method has to be called each time the csvFile is no more used (eg. return from step 2 to step 1; Error on step 1; last step success; etc...)
  If this method cannot be called (cancel by user, browser closed, ...) then the MultipartFilter will do his job by cleaning the UPLOAD dir at next JCMS restart. (See MultipartFilter.initFileUpload()).
  
  Since:
  
  jcms-8
  
  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
  
  Since:
  
  jcms-8
  
  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
  
  Since:
  
  jcms-8
  
  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
  
  Since:
  
  jcms-8
  
  getFormStepHiddenFields
  
  public java.lang.String getFormStepHiddenFields()
  
  Stores through different steps the uploaded file path.
  
  Overrides:
  
  getFormStepHiddenFields in class JcmsFormHandler
  
  Returns:
  
  the uploaded file path.
  
  Since:
  
  jcms-8
  
  getFormStepCount
  
  public int getFormStepCount()
  
  The number of steps is dynamic, is minimum 2, and maximum 4.
  
  1. file
  
  2. verifications and finish
  
  3. (optional) workspaces's groups
  
  4. (optional) collaborative workspaces's groups
  
  Optionnal steps are only available when importing Members with usage Account.
  
  Overrides:
  
  getFormStepCount in class JcmsFormHandler
  
  Returns:
  
  the total number of steps in this formhandler
  
  Since:
  
  jcms-8
  
  See Also:
  
  JcmsFormHandler.getFormStepCount()
  
  isWorkspaceStep
  
  public boolean isWorkspaceStep()
  
  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().
  
  Since:
  
  jcms-8
  
  isCollaborativeSpaceStep
  
  public boolean isCollaborativeSpaceStep()
  
  Returns:
  
  true if the current loggedMember can see any Collaborative Space.
  
  Since:
  
  jcms-8
  
  getWorkspaceSet
  
  public java.util.Set<Workspace> getWorkspaceSet()
  
  Retrieve all the workspaces as a Set, with the following conditions :
  
  workspace's getCatSet() is child of getWorkspaceRootCat() 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
  
  Returns:
  
  the ws set.
  
  Since:
  
  jcms-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 worksapce, or collaborative space has public access.
  
  Returns:
  
  the ws set.
  
  Since:
  
  jcms-8
  
  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-8
  
  getUploadDir
  
  protected java.io.File getUploadDir()
  
  Returns:
  
  the JCMS temporary directory.
  
  Since:
  
  jcms-8
  
  setOpUpload
  
  public void setOpUpload(java.lang.String upload)
  
  Parameters:
  
  upload - set the opUpload
  
  Since:
  
  jcms-8.0.1
  
  getSeparator
  
  public java.lang.String getSeparator()
  
  Returns:
  
  the separator
  
  Since:
  
  jcms-8
  
  setSeparator
  
  public void setSeparator(java.lang.String separator)
  
  Parameters:
  
  separator - the separator to set
  
  Since:
  
  jcms-8
  
  getSendEmail
  
  public java.lang.String getSendEmail()
  
  Returns:
  
  the sendEmail
  
  Since:
  
  jcms-8
  
  setSendEmail
  
  public void setSendEmail(java.lang.String sendEmail)
  
  Parameters:
  
  sendEmail - the sendEmail to set
  
  Since:
  
  jcms-8
  
  hasToSendEmail
  
  public boolean hasToSendEmail()
  
  Returns:
  
  the sendEmail
  
  Since:
  
  jcms-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-8.0.1
  
  useDbMembers
  
  public boolean useDbMembers()
  
  Returns:
  
  Weither to use DBMember or Member class.
  
  Since:
  
  jcms-8.0.1
  
  getCreateCount
  
  public int getCreateCount()
  
  Returns:
  
  the createCount
  
  Since:
  
  jcms-8
  
  getUpdateCount
  
  public int getUpdateCount()
  
  Returns:
  
  the updateCount
  
  Since:
  
  jcms-8
  
  getInvalidCount
  
  public int getInvalidCount()
  
  Returns:
  
  the invalidCount
  
  Since:
  
  jcms-8
  
  getMemberInfoList
  
  public java.util.List<MemberImport> getMemberInfoList()
  
  Returns:
  
  the memberInfoList
  
  Since:
  
  jcms-8
  
  isAnyError
  
  public boolean isAnyError()
  
  Returns:
  
  true if the current import manager contains error.
  
  Since:
  
  jcms-8
  
  getWsGrpIds
  
  public java.lang.String[] getWsGrpIds()
  
  Returns:
  
  the wsGrpIds
  
  Since:
  
  jcms-8
  
  setWsGrpIds
  
  public void setWsGrpIds(java.lang.String[] wsGrpIds)
  
  Parameters:
  
  wsGrpIds - the wsGrpIds to set
  
  Since:
  
  jcms-8
  
  getCsGrpIds
  
  public java.lang.String[] getCsGrpIds()
  
  Returns:
  
  the csGrpIds
  
  Since:
  
  jcms-8
  
  setCsGrpIds
  
  public void setCsGrpIds(java.lang.String[] csGrpIds)
  
  Parameters:
  
  csGrpIds - the csGrpIds to set
  
  Since:
  
  jcms-8
  
  getUsage
  
  public int getUsage()
  
  Returns:
  
  the usage (Account or contact) for members to create.
  
  Since:
  
  jcms-8.0.1
  
  setUsage
  
  public void setUsage(int usage)
  
  Parameters:
  
  usage - the usage (Account or contact) for members to create to set.
  
  Since:
  
  jcms-8.0.1
  
  isAccountMode
  
  public boolean isAccountMode()
  
  Return true if import mode is Account.
  
  Returns:
  
  true if import mode is Account.
  
  Since:
  
  jcms-8.0.1
  
  isContactMode
  
  public boolean isContactMode()
  
  Return true if import mode is Contact.
  
  Returns:
  
  true if import mode is Contact.
  
  Since:
  
  jcms-8.0.1
  
  getFilename
  
  public java.lang.String getFilename()
  
  Returns:
  
  the relative filename of the imported file.
  
  Since:
  
  jcms-8.0.1
  
  setFilename
  
  public void setFilename(java.lang.String filename)
  
  Parameters:
  
  filename - the filename to set
  
  Since:
  
  jcms-8.0.1
  
  getDataClass
  
  public java.lang.Class<? extends Data> getDataClass()
  
  Overriding EditDataHandler for Steps modal Form purpose, but not really editing a Data.
  
  Specified by:
  
  getDataClass in class EditDataHandler
  
  Since:
  
  jcms-8
  
  See Also:
  
  EditDataHandler.getDataClass()
  
  getHiddenField
  
  protected java.lang.String getHiddenField(java.lang.String htmlName, java.io.File csvFile)
  
  Specific method to put a file relative to JCMS temp dir as hidden modal field.
  Does not encode value, since super.getHiddenField() does it.
  
  Parameters:
  
  htmlName - : the HTTP param name.
  
  csvFile - : the File.
  
  Returns:
  
  the hidden input as HTML.
  
  Since:
  
  jcms-8
  
  displayUsageOption
  
  public boolean displayUsageOption()
  
  Returns:
  
  true if option usage must be proposed.
  
  Since:
  
  jcms-8.0.1

Class MembersCsvImportHandler

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.jcms.JcmsConstants

Fields inherited from interface com.jalios.util.JaliosConstants

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

REVISION

ADMIN_USERS_MEMBER_ACL

opUpload

separator

sendEmail

hasToSendEmail

wsGrpIds

csGrpIds

docUploadInfo

dbMembers

useDbMembers

usage

csvFile

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

DBMEMBER_PARAM

USAGE_PARAM

IMPORT_DONE_REQ_ATTR

CREATED_IDS_REQ_ATTR

UPDATED_IDS_REQ_ATTR

EMAIL_SENT_REQ_ATTR

FILENAME_HTML_PARAM

STEP_1_FILE

STEP_2_PREVIEW

STEP_3

STEP_4

startTime

endTime

isBlockingError

filename

memberInfoList

importManager

collaborativeSpaceClazz

collaborativeSpaceInitDone

Constructor Detail

MembersCsvImportHandler

Method Detail

processAction

init

isCollaborativeSpacePluginAvailable

validatePrevious

validateUpload

validateFinish

deleteCsvFile

showPreviousButton

showNextButton

showFinishButton

getFormStepHiddenFields

getFormStepCount

isWorkspaceStep

isCollaborativeSpaceStep

getWorkspaceSet

getCollaborativeSpaceSet

setDocuments

getUploadDir

setOpUpload

getSeparator

setSeparator

getSendEmail