package
0.0.0-20240627150858-f50264a9cb12
Repository: https://github.com/aptrust/dart-runner.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ArtifactsDeleteByJobID deletes all artifacts associated with JobID.
No description provided by the author
BagItProfileFromJSON converts a JSON representation of a BagIt Profile to a Profile object.
BagItProfileLoad loads a BagIt Profile from the specified file.
ClearArtifactsTable is for testing use only.
ClearDartTable is for testing use only.
ConvertProfile converts a BagIt profile from a known format to a DART BagIt profile.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrorEvent creates a new EventMessage with EventType error.
FindConflictingUUID returns the UUID of the object having the same name and type as obj.
Finish event creates an EventMessage with a JobResult describing how the job turned out.
GetAppSetting returns the value of the AppSetting with the given name.
GetRemoteRepoClient returns a client that can talk to a RemoteRepository.
GuessProfileType tries to determine the type of a BagIt profile based on its structure.
GuessProfileTypeFromJson tries to determine the type of a BagIt profile based on its structure.
InfoEvent creates a new EventMessage with EventType info.
No description provided by the author
InitEvent creates a new initialization event message.
No description provided by the author
JobFromJson converts the JSON data in file pathToFile into a Job object.
JobFromWorkflow creates a new job based on the specified workflow.
For testing only.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewAppSetting creates a new AppSetting with the specified name and value.
NewAPTrustClientV3 returns a new instance of the APTrust remote repo client.
NewArtifact creates a new empty Artifact with a unique id and timestamp.
No description provided by the author
No description provided by the author
NewBagItProfileCreationForm returns a form for starting the BagIt Profile creation process.
NewBagItProfileImport creates a new BagItProfileImport object.
No description provided by the author
NewCSVBatchParser creates a new parser to convert records in a CSV batch file to a slice of JobParams.
NewExportOptions returns an object containing the data we need to populate lists on the export settings page.
NewExportOptionsFromSettings returns an object containing data for use on the export questions page.
NewExportQuestion returns a new ExportQuestion with a unique ID.
NewExportSettings returns a new ExportSettings object.
NewField creates a new field for a form.
NewFileMap returns a pointer to a new FileMap object.
NewFileRecord returns a pointer to a new FileRecord object.
NewForm creates a new form for the specified object type and id.
No description provided by the author
NewJob creates a new Job with a unique ID.
NewJobParams creates a new JobParams object.
NewJobResult creates an object containing the results of all actions attempted in a job.
NewJobResultArtifact creates a new Artifact to store a JobResult.
No description provided by the author
NewJobResultFromValidationJob creates a new JobResult containing info about the outcome of a ValidationJob.
NewJobSummary creates a new JobSummaryInfo object based on the given job.
NewLOCKSSClientV2 returns a new instance of the LOCKSS remote repo client.
NewManifestArtifact creates a new Artifact to store a bag's payload manifest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewStandardProfile creates a new StandardProfile object with all internal structs, slices, and maps allocated and initialized to empty values.
No description provided by the author
NewStreamProgress returns a new StreamProgress object.
NewTag returns a new Tag object.
NewTagFileArtifact creates a new Artifact to store a bag's tag file.
NewTarredBagReader creates a new TarredBagReader.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO: Deprecate this.
No description provided by the author
NewWorkflowCSVEntry creates a new WorkflowCSVEntry.
NewWorkflowCSVFile creates a new WorkflowCSVFile object.
NewWorkflowRunner creates a new WorkFlowRunner object.
NewWorkflowRunnerWithMessageChannel creates a new workflow runner that sends status events back to the GUI.
ObjByNameAndType returns the object of the specified type with the matching name.
ObjChoiceList returns a list of all items of type objType in the database.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjNameIdList returns a list of all items of type objType in the database.
ObjSave validates an object and then saves it if it passes validation.
ObjSaveWithoutValidation saves an object without validating it first.
ParseManifest parses a checksum manifest, returning a slice of Checksums.
No description provided by the author
ParseTagFile parses the tags in a tag file that conforms to the BagIt spec, which uses colon-separated Label:Value tags that may span multiple lines.
ProfileFromLOCOrdered converts the JSON representation of an ordered Library of Congress BagIt profile to a DART BagIt profile.
ProfileFromLOCUnordered converts the JSON representation of an unordered Library of Congress BagIt profile to a DART BagIt profile.
ReadInput reads input from the specified reader (which, in practice, will usually be STDIN) and returns it with newlines preserved.
RegisterRepoClient registers a remote repo client, so that DART knows it's available.
RemoteRepoClientAPTrust returns an APTrustlient as a basic RemoteRepoClient to support automated discovery and generation of clients using the factory method GetRemoteRepoClient().
RemoteRepoClientLOCKSS returns a LOCKSSClient as a basic RemoteRepoClient to support automated discovery and generation of clients using the factory method GetRemoteRepoClient().
RepoClientList returns a list of NameIDPair objects, listing available remote repository clients.
No description provided by the author
RunJobWithMessageChannel runs a job and pumps progress details into the messageChannel.
SFTPConnect returns an sftp connection or an error.
SFTPUpload uploads a file to the SFTP server described in the StorageService param.
SSHConnect returns an ssh connection or an error.
StandardProfileFromJson converts the JSON in jsonBytes into a StandardProfile object.
StartEvent creates a new EventMessage with EventType start.
StdinHasData returns true if STDIN is a pipe with data waiting to be read.
UserSettableTagsForProfile returns a list of tags defined in the BagIt profile with the specified ID.
WarningEvent creates a new EventMessage with EventType warning.
WorkflowFromJob creates a new workflow based on param job.
No description provided by the author
No description provided by the author
# Constants
MaxErrors is the maximum number of errors the validator will collect before quitting and returning the error list.
# Variables
No description provided by the author
No description provided by the author
ErrFileMissingFromBag indicates that a file present in a payload manifest is not present in the bag's data directory.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TitleTags is a list of BagItProfile tags to check to try to find a meaningful title for this job.
# Structs
AppSetting represents an application-wide setting that can be configured by the user.
APTrustClientV3 is a remote repository client that can talk to the APTrust Registry API.
No description provided by the author
No description provided by the author
BagItProfile represents a DART-type BagItProfile, as described at https://aptrust.github.io/dart/BagItProfile.html.
BagItProfileImport represents a URL or JSON blob to be imported as a DART BagIt profile.
Checksum records information about a file's checksum.
Choice represents a choice on an HTML form.
No description provided by the author
No description provided by the author
EventMessage contains info to send back to the front end UI about the progress of a job, so the user can see that things are moving along.
ExportOptions returns options to populate lists on the export settings page.
No description provided by the author
ExportSettings are settings that users can export as JSON to share with other users.
Field represents a field in an HTML form.
FileMap contains a map of FileRecord objects and some methods to help validate those records.
FileRecord contains a collection of checksums for a single file.
Form represents an HTML form.
InternalSetting is set by DART and cannot be edited by user.
No description provided by the author
No description provided by the author
JobParams describes what we need to assemble to create a Job for the JobRunner.
JobResult collects the results of an attempted job for reporting purposes.
JobSummary contains info about a job to be displayed in the front end.
LOCKSSClientV2 is a remote repository client that can talk to the LOCKSS API.
LOCOrderedProfile represents a Library of Congress BagIt profile containing an ordered list of tags.
LOCTagDef represents a Library of Congress tag definition.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProfileInfo contains meta info about the profile.
No description provided by the author
RemoteRepository contains config settings describing how to connect to a remote repository, such as APTrust.
No description provided by the author
StandardProfile represents a BagIt Profile in BagIt Profile Spec version 1.3.0.
StandardProfileInfo is structurally identical to BagItProfileInfo, but it serializes to and from JSON differently.
StandardProfileTagDef represents a tag definition in BagIt Profile Spec version 1.3.0.
No description provided by the author
StreamProgress sends info from an upload/download stream into a message channel so we can report upload/download progress to the user.
Tag describes a tag parsed from a BagIt file such as bag-info.txt.
TagDefinition describes a tag in a BagItProfile, whether it's required, what values are allowed, etc.
TarredBagReader reads a tarred BagIt file to collect metadata for bagit and ingest processing.
No description provided by the author
UploadJob represents an upload-only job, in which we may be sending multiple files to multiple targets.
No description provided by the author
ValidationJob is a job that only validates bags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WorkflowCSVEntry represents a single entry from a workflow CSV file.
WorkflowCSVFile reads a CSV file that describes what items should be run through a workflow.
WorkflowRunner runs all jobs in CSVFile through Workflow.
# Interfaces
BagReader describes the interface that bag readers must implement, whether reading from a file system, tar file, zip file, etc.
BagWriter describes the interface that bag writers must implement, whether writing to a file system, tar file, zip file, etc.
No description provided by the author
RemoteRepoClient interface defines the basics for talking to a remote repository.