constants

package

v1.0.2 Latest Latest Go to latest Published: Jan 27, 2026 License: BSD-2-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/APTrust/dart-runner

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	AlgMd5                        = "md5"
	AlgSha1                       = "sha1"
	AlgSha256                     = "sha256"
	AlgSha512                     = "sha512"
	BaggingDirectory              = "Bagging Directory"
	BagItProfileBTR               = "btr-v1.0.json"
	BagItProfileDefault           = "aptrust-v2.2.json"
	BagReaderTypeFileSystem       = "filesystem"
	BagReaderTypeTar              = "tar"
	BagWriterTypeTar              = "tar"
	BagWriterTypeFileSystem       = "filesystem"
	BTRProfileIdentifier          = "https://github.com/dpscollaborative/btr_bagit_profile/releases/download/1.0/btr-bagit-profile.json"
	ControlCharactersInFileNames  = "Control Characters in File Names"
	ControlCharFailValidation     = "Fail Validation"
	ControlCharIgnore             = "Ignore"
	ControlCharRefuseToBag        = "Refuse to Bag"
	ControlCharWarn               = "Warn"
	DefaultProfileIdentifier      = "https://raw.githubusercontent.com/APTrust/preservation-services/master/profiles/aptrust-v2.2.json"
	EmptyProfileID                = "73d1b307-4d6b-494b-b0c9-a8595222ae5a"
	EmptyProfileIdentifier        = "https://raw.githubusercontent.com/APTrust/dart/tree/master/profiles/empty_profile.json"
	EmptyUUID                     = "00000000-0000-0000-0000-000000000000"
	EventTypeBatchCompleted       = "batch completed"
	EventTypeDisconnect           = "disconnect"
	EventTypeError                = "error"
	EventTypeFinish               = "finish"
	EventTypeInfo                 = "info"
	EventTypeInit                 = "init"
	EventTypeStart                = "start"
	EventTypeWarning              = "warning"
	ExitOK                        = 0
	ExitRuntimeErr                = 1
	ExitUsageErr                  = 2
	FileTypeFetchTxt              = "fetch.txt"
	FileTypeJsonData              = "json data"
	FileTypeManifest              = "manifest"
	FileTypePayload               = "payload file"
	FileTypeTag                   = "tag file"
	FileTypeTagManifest           = "tag manifest"
	FlashCookieName               = "dart-flash-message"
	ImportSourceJson              = "json"
	ImportSourceUrl               = "url"
	ItemTypeFile                  = "file"
	ItemTypeJobResult             = "job result"
	ItemTypeManifest              = "manifest"
	ItemTypeTagFile               = "tag file"
	MaxLogFileSize                = int64(10 * 1024 * 1024) // 10 MB
	MaxS3ObjectSize               = int64(5497558138880)    // 5TB
	MaxServerSideCopySize         = int64(5368709120)       // 5GB
	MaxValidationErrors           = 30
	ModeAptCmd                    = "apt-cmd"
	ModeDartGUI                   = "dart-gui"
	ModeDartRunner                = "dart-runner"
	PackageFormatBagIt            = "BagIt"
	PackageFormatNone             = "None" // Used when a job or workflow has no package operation.
	PluginIdAPTrustClientv3       = "c5a6b7db-5a5f-4ca5-a8f8-31b2e60c84bd"
	PluginIdLOCKSSClientv2        = "0dabdd1d-6227-4ad5-8a48-add1c699f8ab"
	PluginNameAPTrustClientv3     = "APTrust Registry Client (API Version 3)"
	PluginNameLOCKSSClientv2      = "LOCKSS Client (API Version 2)"
	PostValidateCommandTypeGo     = "go"
	PostValidateCommandTypeSystem = "system"
	PostValidateGzipCommand       = "DART.gzip"
	ProfileIDAPTrust              = "043f1c22-c9ff-4112-86f8-8f8f1e6a2dca"
	ProfileIDBTR                  = "a4e95eae-9b93-4ebb-895e-d2ab23fd2c7c"
	ProfileIDEmpty                = "73d1b307-4d6b-494b-b0c9-a8595222ae5a"
	ProfileTypeDart               = "dart"
	ProfileTypeLOCOrdered         = "loc-ordered"
	ProfileTypeLOCUnordered       = "loc-unordered"
	ProfileTypeStandard           = "standard"
	ProfileTypeUnknown            = "unknown"
	ProtocolS3                    = "s3"
	ProtocolSFTP                  = "sftp"
	ResultTypeList                = "list"
	ResultTypeSingle              = "single"
	ResultTypeUnitialized         = "unintialized"
	SerialFormatNone              = "none (bag as directory)"
	SerialFormatTar               = "application/tar"
	SerializationForbidden        = "forbidden"
	SerializationOptional         = "optional"
	SerializationRequired         = "required"
	StageFinish                   = "finish"
	StagePackage                  = "package"
	StagePostValidation           = "post validation"
	StagePreRun                   = "pre-run"
	StageUpload                   = "upload"
	StageValidation               = "validation"
	StatusFailed                  = "failed"
	StatusRunning                 = "running"
	StatusStarting                = "starting"
	StatusSuccess                 = "success"
	TypeAppSetting                = "AppSetting"
	TypeBagItProfile              = "BagItProfile"
	TypeBagItProfileImport        = "BagItProfileImport"
	TypeExportQuestion            = "ExportQuestion"
	TypeExportSettings            = "ExportSettings"
	TypeInternalSetting           = "InternalSetting"
	TypeJob                       = "Job"
	TypeRemoteRepository          = "RemoteRepository"
	TypeStorageService            = "StorageService"
	TypeTagDefinition             = "TagDefinition"
	TypeUploadJob                 = "UploadJob"
	TypeValidationJob             = "ValidationJob"
	TypeWorkflow                  = "Workflow"
	TypeWorkflowBatch             = "WorkflowBatch"
)

Variables ¶

View Source

var AcceptBagItVersion = []string{
	"0.97",
	"1.0",
}

View Source

var AcceptSerialization = []string{
	"application/tar",
	"application/gzip",
}

View Source

var AllItemTypes = []string{
	TypeAppSetting,
	TypeBagItProfile,
	TypeInternalSetting,
	TypeRemoteRepository,
	TypeStorageService,
	TypeTagDefinition,
}

View Source

var AppVersion string

AppVersion is the version of DART Runner. This is set by the linker at compile time in main.Version, which then sets this var before it runs a job or workflow. This isn't really a constant, since it changes from build to build, but then didn't Heraclitus say "The only constant in life is change?"

View Source

var BagReaderTypeFor = map[string]string{
	"":               BagReaderTypeFileSystem,
	".tar":           BagReaderTypeTar,
	".tar.gz":        BagReaderTypeTar,
	".gz":            BagReaderTypeTar,
	".tgz":           BagReaderTypeTar,
	SerialFormatNone: BagReaderTypeFileSystem,
	SerialFormatTar:  BagReaderTypeTar,
}

BagReaderTypeFor maps a BagIt serialization format to the type of reader that can write that format.

View Source

var BagWriterTypeFor = map[string]string{
	"":               BagWriterTypeFileSystem,
	".tar":           BagWriterTypeTar,
	".tar.gz":        BagWriterTypeTar,
	".gz":            BagWriterTypeTar,
	".tgz":           BagWriterTypeTar,
	SerialFormatNone: BagWriterTypeFileSystem,
	SerialFormatTar:  BagWriterTypeTar,
}

BagWriterTypeFor maps a BagIt serialization format to the type of writer that can write that format.

View Source

var ErrInvalidOperation = errors.New("this operation is invalid or forbidden")

View Source

var ErrNoSuchClient = errors.New("no client exists for this repository type")

View Source

var ErrNoSuchField = errors.New("field does not exist")

View Source

var ErrNotAPointer = errors.New("argument is not a pointer")

View Source

var ErrNotDeletable = errors.New("object cannot be deleted because it is required by dart")

View Source

var ErrObjecValidation = errors.New("object contains validation errors")

View Source

var ErrRepoUnauthorized = errors.New("access unauthorized or forbidden - be sure your user id and api token are correct")

View Source

var ErrUniqueConstraint = errors.New("An object of this type already exists with the same name. Choose a new name.")

View Source

var ErrUnknownReport = errors.New("unknown report")

View Source

var ErrUnknownType = errors.New("unknown type")

View Source

var ErrWrongTypeForForm = errors.New("cannot create form from result: query result is either a list or empty")

View Source

var ExportableSettingTypes = []string{
	TypeAppSetting,
	TypeBagItProfile,
	TypeRemoteRepository,
	TypeStorageService,
}

View Source

var PackageFormats = []string{
	PackageFormatBagIt,
}

We have only one format at the moment, but in future we may add OCFL and others.

View Source

var PreferredAlgsInOrder = []string{
	AlgSha512,
	AlgSha256,
	AlgMd5,
	AlgSha1,
}

View Source

var SavableItemTypes = []string{
	TypeAppSetting,
	TypeBagItProfile,
	TypeInternalSetting,
	TypeRemoteRepository,
	TypeStorageService,
}

View Source

var SerializationOptions = []string{
	SerializationForbidden,
	SerializationOptional,
	SerializationRequired,
}

View Source

var Version string

Version value is injected at build time.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL