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
Author:
Olivier Dedieu
  • Constructor Details

    • ImportManager

      public ImportManager()
  • Method Details

    • 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