Package wt.ixb.publicforapps

Interface ApplicationImportHandler

All Superinterfaces:
ApplicationExpImportHandler
All Known Implementing Classes:
ApplicationImportHandlerForJar, ApplicationImportHandlerForRepository, ApplicationImportHandlerForXml, ApplicationImportHandlerTemplate
public interface ApplicationImportHandler extends ApplicationExpImportHandler
This interface represents application specific implementation of how import process gets input information. There are two types of imput information for import process:
  • XML files representing objects for import
  • Content files for objects, that are content holders
Any import application must implement such a handler and supply it to import service.

To improve performance of import process there are two different methods, that import service uses to get input information:

  • InputStream getContentAsInputStream (String contentId) throws WTException;
  • ApplicationData getContentAsApplicationData (String contentId) throws WTException;
The first method represents a general regular way how import service can get input information.
The second method represents rather specific way, that allows improve performance in some specific cases (particularely, in Replication import implementation). If application can not or does not want to use this method then this method should return null.

Supported API: true

Extendable: false

  • Method Details

    • getContentAsInputStream

      InputStream getContentAsInputStream(String contentId) throws WTException
      Returns InputStream representing input information for import process

      Supported API: true
      Parameters:
      contentId - The unique id to identify the content data, such as the file name (including the path) in a jar file.
      Returns:
      InputStream
      Throws:
      WTException

    • getContentAsApplicationData

      ApplicationData getContentAsApplicationData(String contentId) throws WTException
      Returns ApplicationData representing input information for import process. Import application does not have really implement this method. It can simple return null.

      Supported API: true
      Parameters:
      contentId - The unique id to identify the content data, such as the file name (including the path) in a jar file.
      Returns:
      ApplicationData
      Throws:
      WTException

    • importObjectNotification

      void importObjectNotification(List<IxbHndHelper.ElementObjectPair> elementObjPair, boolean created) throws WTException
      Notifies application about objects, that are created in import process.

      Supported API: true
      Parameters:
      elementObjPair -
      created - "true" if import process creates new object and "false" otherwise.
      Throws:
      WTException

    • finalizeImportObjectNotification

      void finalizeImportObjectNotification(Object object) throws WTException
      Notifies application about objects after being persisted.

      Supported API: true
      Parameters:
      object -
      Throws:
      WTException