Class RoleArchiveService


public class RoleArchiveService extends BaseArchiveService
Provides a role archive export and import service.
  • Field Details

    • ROLE_CONFIG_FILENAME

      public static final String ROLE_CONFIG_FILENAME
      The role configuration file name
      See Also:
    • METADATA_ROLE_NAME

      public static final String METADATA_ROLE_NAME
      The name of the metadata value storing the name of the role or set of roles to be imported
      See Also:
  • Constructor Details

    • RoleArchiveService

      public RoleArchiveService()
  • Method Details

    • validateImportData

      public void validateImportData(byte[] importData) throws ImportValidationException, IOException
      Validate a form archive before it is imported.
      Specified by:
      validateImportData in class BaseArchiveService
      Parameters:
      importData - the import archive as a byte array
      Throws:
      ImportValidationException - if the archive can be parsed, but does not contain the expected archive files
      IOException - if an error occurs loading the import archive contents
    • getImportMetadata

      public Map<String,String> getImportMetadata(byte[] importData) throws ImportValidationException, IOException
      Retrieve the set of metadata values describing a role 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:
      IOException - if an error occurs while parsing the import archive
      ImportValidationException - if the XML file describing the form was not found in the archive
    • writeExportData

      protected void writeExportData(Object object, ZipOutputStream zos, Map<String,String> additionalHeaders) throws IOException, ParserConfigurationException
      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:
      IOException
      ParserConfigurationException
    • processImportFile

      protected void processImportFile(String fileName, byte[] fileData) throws UnsupportedEncodingException
      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:
      UnsupportedEncodingException
    • 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 Role 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)
      object - ImportAction containing action performed (required)
      Since:
      17.10.2