Package com.jalios.jcms.mashup
Class ImportManager
java.lang.Object
com.jalios.jcms.mashup.ImportManager
- All Implemented Interfaces:
JcmsConstants,ImportConstants,MashupConstants,JaliosConstants
The ImportManager is the main class to manage data import.
This class is a singleton (see
It provides method to import data from an ImportSource, an URL or a File.
It also manages import logs (ImportStatus).
This class is a singleton (see
getInstance()).It provides method to import data from an ImportSource, an URL or a File.
It also manages import logs (ImportStatus).
- Since:
- jcms-5.7.2
- Author:
- Olivier Dedieu
-
Field Summary
Fields inherited from interface com.jalios.jcms.mashup.ImportConstants
IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROPFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, 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, GENERATIONAL_STORE_DIRECTORY, 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, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_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_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, 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, TYPES_UNKNOWN_CLASS_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_XMLFields inherited from interface com.jalios.jcms.mashup.MashupConstants
DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddImportSource(ImportSource source) Adds a source to import.booleancheckMdate(Data importedData, Data localData) Returns true if importedData.importMdate is newer than the localData.importMdate.Returns the member used to be the author of all the imported data.getImportedData(String source, String importId) Returns the imported data from the givensourceand bound to the givenimportId(do not return conflict copy).Returns the import root category.Returns the source bound to the given id.Returns the source Map {id, source}.Returns the import workspace (the workspace of all the imported publications).static ImportManagerReturns the singleton.Returns a list of the last ImportStatus.importFromDocument(org.jdom.Document doc) Imports data from a JDom Document.importFromDocument(org.jdom.Document doc, ImportOptions options) Imports data from a JDom Document.importFromFile(File file) Imports data from an XML JCMS export file.importFromFile(File file, ImportOptions options) Imports data from an XML JCMS export file.importFromFilename(String filename) Imports data from an XML JCMS export file.importFromFilename(String filename, ImportOptions options) Imports data from an XML JCMS export file.importFromSource(ImportSource source) Imports data from the given sourceimportFromUrl(String url) Imports data from an URLimportFromUrl(String url, ImportOptions options) Imports data from an URLvoidindexImportedData(Data data) Index the given imported data (conflict copy are not indexed).voidinit()Initialize the ImportManager.booleanReturns true if the Import Manager is enabled.voidremoveImportSource(ImportSource source) Removes a source to import.voidSaves all the import sources.voidunindexImportedData(Data data) Unindex the given imported data
-
Constructor Details
-
ImportManager
public ImportManager()
-
-
Method Details
-
getInstance
Returns the singleton. Caution: This method is not thread-safe.- Returns:
- the singleton.
- Since:
- jcms-5.7.2
-
isEnabled
public boolean isEnabled()Returns true if the Import Manager is enabled.- Returns:
- true if the Import Manager is enabled.
- Since:
- jcms-5.7.2
-
init
public void init()Initialize the ImportManager.- Since:
- jcms-5.7.2
-
getLastImportStatusList
Returns a list of the last ImportStatus.- Returns:
- a list of the last ImportStatus.
- Since:
- jcms-5.7.2
-
addImportSource
Adds a source to import.- Parameters:
source- the source to add- Since:
- jcms-5.7.2
-
removeImportSource
Removes a source to import.- Parameters:
source- the source to remove- Since:
- jcms-5.7.2
-
saveImportSources
public void saveImportSources()Saves all the import sources.- Since:
- jcms-5.7.2
-
getImportSource
Returns the source bound to the given id.- Parameters:
id- a source's id- Returns:
- the source bound to the given id.
- Since:
- jcms-5.7.2
-
getImportSourceMap
Returns the source Map {id, source}.- Returns:
- the source Map {id, source}.
- Since:
- jcms-5.7.2
-
importFromSource
Imports data from the given source- Parameters:
source- the source to import- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.2
-
importFromUrl
Imports data from an URL- Parameters:
url- the URL of an XML JCMS export file.- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.2
-
importFromUrl
Imports data from an URL- Parameters:
url- the URL of an XML JCMS export file.options- the ImportOptions- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.3
-
importFromFilename
Imports data from an XML JCMS export file.- Parameters:
filename- the filename- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.2
-
importFromFilename
Imports data from an XML JCMS export file.- Parameters:
filename- the filenameoptions- the ImportOptions- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.3
-
importFromFile
Imports data from an XML JCMS export file.- Parameters:
file- the file- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.2
-
importFromFile
Imports data from an XML JCMS export file.- Parameters:
file- the fileoptions- the ImportOptions- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.3
-
importFromDocument
Imports data from a JDom Document.- Parameters:
doc- the JDom Document- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.2
-
importFromDocument
Imports data from a JDom Document.- Parameters:
doc- the JDom Documentoptions- the ImportOptions- Returns:
- an ImportStatus that contains information about this import.
- Since:
- jcms-5.7.3
-
checkMdate
Returns true if importedData.importMdate is newer than the localData.importMdate.- Parameters:
importedData- the imported DatalocalData- the local Data- Returns:
- true if importedData.importMdate is newer than the localData.importMdate.
- Since:
- jcms-5.7.2
-
getImportedData
Returns the imported data from the givensourceand bound to the givenimportId(do not return conflict copy).- Parameters:
source- the name of the import sourceimportId- the imported id- Returns:
- the imported data bound to the given
importId. - Since:
- jcms-5.7.2
-
indexImportedData
Index the given imported data (conflict copy are not indexed).- Parameters:
data- the data to index- Since:
- jcms-5.7.2
-
unindexImportedData
Unindex the given imported data- Parameters:
data- the data to unindex- Since:
- jcms-5.7.2
-
getImportAuthor
Returns the member used to be the author of all the imported data.- Returns:
- the import author.
- Since:
- jcms-5.7.2
-
getImportWorkspace
Returns the import workspace (the workspace of all the imported publications). The import workspace is defined with the property IMPORT_WS_PROP. If this property is missing, the default workspace is used.- Returns:
- the import workspace.
- Since:
- jcms-5.7.2
-
getImportRootCategory
Returns the import root category. This category will be the root of all imported categories.- Returns:
- the import root category
- Since:
- jcms-5.7.2
-