com.jalios.jcms.mashup
Class ImportManager

java.lang.Object
  com.jalios.jcms.mashup.ImportManager

All Implemented Interfaces:

JcmsConstants, ImportConstants, MashupConstants, JaliosConstants

public class ImportManager
extends Object
implements ImportConstants, JcmsConstants

The ImportManager is the main class to manage data import.
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

Version:

$Revision: 27753 $

Author:

Olivier Dedieu

Field Summary

static String

REVISION

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_PROP

Fields 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

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

ImportManager()

Method Summary

void	addImportSource(ImportSource source) Adds a source to import.
boolean	checkMdate(Data importedData, Data localData) Returns true if importedData.importMdate is newer than the localData.importMdate.
Member	getImportAuthor() Returns the member used to be the author of all the imported data.
Data	getImportedData(String source, String importId) Returns the imported data from the given source and bound to the given importId (do not return conflict copy).
Category	getImportRootCategory() Returns the import root category.
ImportSource	getImportSource(String id) Returns the source bound to the given id.
Map<String,ImportSource>	getImportSourceMap() Returns the source Map {id, source}.
Workspace	getImportWorkspace() Returns the import workspace (the workspace of all the imported publications).
static ImportManager	getInstance() Returns the singleton.
List	getLastImportStatusList() Returns a list of the last ImportStatus.
ImportStatus	importFromDocument(org.jdom.Document doc) Imports data from a JDom Document.
ImportStatus	importFromDocument(org.jdom.Document doc, ImportOptions options) Imports data from a JDom Document.
ImportStatus	importFromFile(File file) Imports data from an XML JCMS export file.
ImportStatus	importFromFile(File file, ImportOptions options) Imports data from an XML JCMS export file.
ImportStatus	importFromFilename(String filename) Imports data from an XML JCMS export file.
ImportStatus	importFromFilename(String filename, ImportOptions options) Imports data from an XML JCMS export file.
ImportStatus	importFromSource(ImportSource source) Imports data from the given source
ImportStatus	importFromUrl(String url) Imports data from an URL
ImportStatus	importFromUrl(String url, ImportOptions options) Imports data from an URL
void	indexImportedData(Data data) Index the given imported data (conflict copy are not indexed).
void	init() Initialize the ImportManager.
boolean	isEnabled() Returns true if the Import Manager is enabled.
void	removeImportSource(ImportSource source) Removes a source to import.
void	saveImportSources() Saves all the import sources.
void	unindexImportedData(Data data) Unindex the given imported data

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

Constructor Detail

ImportManager

public ImportManager()

Method Detail

getInstance

public static ImportManager 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

public List getLastImportStatusList()

Returns a list of the last ImportStatus.

Returns:

a list of the last ImportStatus.

Since:

jcms-5.7.2

addImportSource

public void addImportSource(ImportSource source)

Adds a source to import.

Parameters:

source - the source to add

Since:

jcms-5.7.2

removeImportSource

public void removeImportSource(ImportSource source)

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

public ImportSource getImportSource(String id)

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

public Map<String,ImportSource> getImportSourceMap()

Returns the source Map {id, source}.

Returns:

the source Map {id, source}.

Since:

jcms-5.7.2

importFromSource

public ImportStatus importFromSource(ImportSource source)

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

public ImportStatus importFromUrl(String url)

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

public ImportStatus importFromUrl(String url,
                                  ImportOptions options)

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

public ImportStatus importFromFilename(String filename)

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

public ImportStatus importFromFilename(String filename,
                                       ImportOptions options)

Imports data from an XML JCMS export file.

Parameters:

filename - the filename

options - the ImportOptions

Returns:

an ImportStatus that contains information about this import.

Since:

jcms-5.7.3

importFromFile

public ImportStatus importFromFile(File file)

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

public ImportStatus importFromFile(File file,
                                   ImportOptions options)

Imports data from an XML JCMS export file.

Parameters:

file - the file

options - the ImportOptions

Returns:

an ImportStatus that contains information about this import.

Since:

jcms-5.7.3

importFromDocument

public ImportStatus importFromDocument(org.jdom.Document doc)

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

public ImportStatus importFromDocument(org.jdom.Document doc,
                                       ImportOptions options)

Imports data from a JDom Document.

Parameters:

doc - the JDom Document

options - the ImportOptions

Returns:

an ImportStatus that contains information about this import.

Since:

jcms-5.7.3

checkMdate

public boolean checkMdate(Data importedData,
                          Data localData)

Returns true if importedData.importMdate is newer than the localData.importMdate.

Parameters:

importedData - the imported Data

localData - the local Data

Returns:

true if importedData.importMdate is newer than the localData.importMdate.

Since:

jcms-5.7.2

getImportedData

public Data getImportedData(String source,
                            String importId)

Returns the imported data from the given source and bound to the given importId (do not return conflict copy).

Parameters:

source - the name of the import source

importId - the imported id

Returns:

the imported data bound to the given importId.

Since:

jcms-5.7.2

indexImportedData

public void indexImportedData(Data data)

Index the given imported data (conflict copy are not indexed).

Parameters:

data - the data to index

Since:

jcms-5.7.2

unindexImportedData

public void unindexImportedData(Data data)

Unindex the given imported data

Parameters:

data - the data to unindex

Since:

jcms-5.7.2

getImportAuthor

public Member getImportAuthor()

Returns the member used to be the author of all the imported data.

Returns:

the import author.

Since:

jcms-5.7.2

getImportWorkspace

public Workspace 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

public Category 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