Quality Assurance

Qualitätsprüfungen

Das Package "qualityassurance" beinhaltet Schritte, die der Qualitätsprüfung von SIPs dienen.

Quality Assurance: extract SIP into workfolder

Extrahiert ein gezipptes SIP nach feeder.workbench.work. Ein optionaler zweiter Parameter kann verwendet werden, um einen anderen Zielordner anzugeben.

java ch.docuteam.feeder.qualityassurance.SIPExtractor \
     [path/to/]SIP [targetdir]
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property
[targetdir] target directory; absolute path of the directory where to unzip the SIP to. Optional, defaults to feeder.workbench.work

Quality Assurance: check fixity of SIP

Überprüft die Dateien in einem SIP auf Konformität mit den hinterlegten Checksummen in der METS-Datei. Die Resultate der Prüfung werden in Form von PREMIS-Events in das METS-File geschrieben.

java ch.docuteam.feeder.qualityassurance.SIPFixityCheck \
     [path/to/]SIP
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.workdir property

Quality Assurance: check file path length

Prüft, ob die Länge von absoluten Pfade eines SIPs über einem anzugebenden Wert liegen.

java ch.docuteam.feeder.qualityassurance.FilePathLengthCheck \
     /absolute/path/to/folder maxAllowedFilePathLength
Parameter Beschreibung
/absolute/path/to/folder absolute path of the folder that should be checked
maxAllowedFilePathLength the max allowed number of characters of the canonical file path

Quality Assurance: check sip path length

Prüft die Dateipfadlängen innerhalb eines SIPs gegen einen anzugebenden Grenzwert.

java ch.docuteam.feeder.qualityassurance.SIPPathLengthCheck \
     [path/to/]SIP  maxAllowedFilePathLength
Parameter Beschreibung
[path/to/]SIP name of the SIP; if not path is given, it will be expected to be in the location defined by the feeder.workbench.work property
maxAllowedFilePathLength the max allowed number of characters of the canonical file path

Quality Assurance: get PID

Verbindet sich mit dem Fedora Repository und holt eine einzelne PID, um das SIP zu identifizieren. Diese PID wird später zur Grundlage für die Einlagerung ins Repository. Der Wert wird im Element <mets:OBJID> gespeichert.

java ch.docuteam.feeder.qualityassurance.SIPConfirmation \
     [path/to/]SIP [PIDNamespace[:###]]
Parameter Beschreibung
[path/to/]SIP name of the SIP. If no path is given, it will be expected to be in the location defined by the feeder.workbench.dir property
[PID namespace[:###]] namespace for new PID or complete PID to use for the object; if omitted, the standard namespace from the submission agreement will be used; if the submission agreement cannot be found, the default namespace of the Fedora repository will be used.

Quality Assurance: convert to safe filenames

Benennt Dateien mit Spezialzeichen um. Sichere Dateinamen beinhalten nur Zeichen aus A-Z, a-z, 0-9, und "_.-".

java ch.docuteam.feeder.qualityassurance.SIPConvertToSafeFileNames \
     [path/to/]SIP
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property

Quality Assurance: check file extensions

Überprüft die Dateiendungen in einem SIP und ergänzt diese wenn nötig.

java ch.docuteam.feeder.qualityassurance.SIPFileExtensionCheck \
     [path/to/]SIP
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property

Quality Assurance: delete backup files

Löscht Dateien aus dem SIP, die einem bestimmten Namensmuster entsprechen.

java ch.docuteam.feeder.qualityassurance.SIPDeleteBackupFiles \
     [path/to/]SIP  [filenamePattern filenamePattern ...]
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property
[filenamePattern filenamePattern ...] a list of filename patterns (not case-sensitive, '*' is wildcard, but is only allowed at the beginning or end of the pattern). Files matching any one of this patterns will be deleted

Quality Assurance: check SIP against submission agreement

Prüft ob die Dateiformate mit den Vorgaben aus dem Submission Agreement übereinstimmen. Es gibt zwei Modi: im ersten Modus (removeBadFiles = false), wird jede Datei, welche über keine Übereinstimmung mit dem Submission Agreement hat, aufgelistet (verwendet werden hierzu die WARN log-Einträge) und zudem wird ein Fehlercode ausgegeben. Beim zweiten Modus (removeBadFiles = true), wird jede Datei, welche über keine Übereinstimmung mit dem Submission Agreement aufweist, aus dem SIP gelöscht. Das modifizierte mets.xml wird gespeichert (das originale SIP bleibt unverändert als Backup bestehen).

java ch.docuteam.feeder.qualityassurance.SIPSubmissionAgreementCheck \
     [path/to/]SIP [removeBadFiles]
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property
[removeBadFiles] optional, { true

Quality Assurance: SIP virus check

Jede im SIP vorhandene Datei wird auf Viren überprüft. Für die Virenprüfung wird der Virenscanner von ClamAV (www.clamav.net) verwendet.

Voraussetzung für diese Prüfung ist ein gestarteter ClamAV Dienst. Abhängig vom zweiten Argument werden infizierte Dateien verworfen oder automatisch gelöscht.

java ch.docuteam.feeder.qualityassurance.SIPVirusCheck \
     [path/to/]SIP deleteInfected
Parameter Beschreibung
[path/to/]SIP name of the SIP; if no path is given, it will be expected to be in the location defined by the feeder.workbench.work property
deleteInfected if true, the operation automatically removes infected files from the SIP

Quality Assurance: remove by level of description

Entfernt bestimmte Verzeichnungsstufe aus einem SIP.

java ch.docuteam.feeder.qualityassurance.RemoveByLevelOfDescription \
     [/path/to/]folder levelOfDescription
Parameter Beschreibung
[path/to/]folder path of the folder to rename; if no path is given, it will be expected to be in the location defined by the feeder.workbench.inbox property
levelOfDescription name of the level of description to be removed from the SIP