Package com.avoka.fc.core.service.archive

Class LibraryArchiveService

java.lang.Object
com.avoka.fc.core.service.BaseService
com.avoka.fc.core.service.CayenneService
com.avoka.fc.core.service.archive.BaseArchiveService
com.avoka.fc.core.service.archive.LibraryArchiveService
public class LibraryArchiveService extends BaseArchiveService
Provides a library archive export and import service.

  • Field Details

    • LIBRARY_CONFIG_FILENAME

      public static final String LIBRARY_CONFIG_FILENAME
      The library configuration file name
      See Also:

    • PARAM_LIBRARY

      public static final String PARAM_LIBRARY
      The name of the parameter containing the library entity during import
      See Also:

    • METADATA_LIBRARY_NAME

      public static final String METADATA_LIBRARY_NAME
      The name of the metadata value storing the name of the library to be imported
      See Also:

  • Constructor Details

    • LibraryArchiveService

      public LibraryArchiveService()

  • Method Details

    • writeExportData

      protected void writeExportData(Object object, ZipOutputStream zos, Map<String,String> additionalHeaders) throws Exception
      Description copied from class: BaseArchiveService
      Does the actual export of the data without having to worry about handling errors or preparing and closing the stream
      Specified by:
      writeExportData in class BaseArchiveService
      Parameters:
      object - the non-null object to be exported
      zos - the stream to be written to
      additionalHeaders - the map of additional headers to be included in metadata
      Throws:
      Exception - if an error occurs

    • validateImportData

      public void validateImportData(byte[] importData)
      Description copied from class: BaseArchiveService
      Validate an archive before it is imported.
      Specified by:
      validateImportData in class BaseArchiveService
      Parameters:
      importData - the import archive as a byte array

    • getImportMetadata

      public Map<String,String> getImportMetadata(byte[] importData) throws Exception
      Description copied from class: BaseArchiveService
      Retrieve the set of metadata values describing an archive that is being imported.
      Specified by:
      getImportMetadata in class BaseArchiveService
      Parameters:
      importData - the import archive as a byte array
      Returns:
      a map of metadata names and their values
      Throws:
      Exception - if an error occurs while the metadata is being loaded

    • processImportFile

      protected void processImportFile(String fileName, byte[] fileData) throws Exception
      Description copied from class: BaseArchiveService
      For a given file in the imported archive, the service stores its contents as it sees fit, preserving what it will need to recreate entities later. This operation happens before the database transaction wrapping the actual import to the SFM database.
      Specified by:
      processImportFile in class BaseArchiveService
      Parameters:
      fileName - the full file name of the ZIP file entry (e.g. form/TestForm.pdf)
      fileData - the file data of the ZIP file entry
      Throws:
      Exception - if an error occurs

    • performImport

      protected void performImport(ImportAction importAction, Set<? extends Enum> importOptions, Map<String,Object> parameters)
      Description copied from class: BaseArchiveService
      Performs the act of importing the data contained in the archive to the SFM database. When this method will be called, the caller is expected to have established a transaction, and will also handle errors thrown by this method.
      Specified by:
      performImport in class BaseArchiveService
      Parameters:
      importAction - the import action related to this import
      importOptions - the set of import options that should be applied
      parameters - optional parameters to be used during import

    • getEntityName

      protected String getEntityName()
      Description copied from class: BaseArchiveService
      Return the name identifying the individual entity being exported (e.g. for a client, the client's name)
      Specified by:
      getEntityName in class BaseArchiveService
      Returns:
      the entity name

    • exportAuditLogger

      protected void exportAuditLogger(Object object)
      Create an entry in the audit log when an export is performed
      Specified by:
      exportAuditLogger in class BaseArchiveService
      Parameters:
      object - Object of type Library that was exported (Optional)
      Since:
      17.10.2

    • importAuditLogger

      protected void importAuditLogger(ImportAction importAction)
      Create an entry in the audit log when an import is performed
      Specified by:
      importAuditLogger in class BaseArchiveService
      Parameters:
      importAction - ImportAction containing action performed (required)
      Since:
      17.10.2