constants

Documentation

Index

• Constants
• Variables

Constants

const (
	AlgMd5                    = "md5"
	AlgSha1                   = "sha1"
	AlgSha256                 = "sha256"
	AlgSha512                 = "sha512"
	BagItProfileBTR           = "btr-v1.0.json"
	BagItProfileDefault       = "aptrust-v2.2.json"
	BTRProfileIdentifier      = "https://github.com/dpscollaborative/btr_bagit_profile/releases/download/1.0/btr-bagit-profile.json"
	DefaultProfileIdentifier  = "https://raw.githubusercontent.com/APTrust/preservation-services/master/profiles/aptrust-v2.2.json"
	EmptyProfileIdentifier    = "https://raw.githubusercontent.com/APTrust/dart/tree/master/profiles/empty_profile.json"
	EmptyProfileID            = "73d1b307-4d6b-494b-b0c9-a8595222ae5a"
	EmptyUUID                 = "00000000-0000-0000-0000-000000000000"
	EventTypeBatchCompleted   = "batch completed"
	EventTypeDisconnect       = "disconnect"
	EventTypeInfo             = "info"
	EventTypeInit             = "init"
	EventTypeStart            = "start"
	EventTypeWarning          = "warning"
	EventTypeError            = "error"
	EventTypeFinish           = "finish"
	ExitOK                    = 0
	ExitRuntimeErr            = 1
	ExitUsageErr              = 2
	FileTypeFetchTxt          = "fetch.txt"
	FileTypeManifest          = "manifest"
	FileTypePayload           = "payload file"
	FileTypeTag               = "tag file"
	FileTypeTagManifest       = "tag manifest"
	FileTypeJsonData          = "json data"
	FlashCookieName           = "dart-flash-message"
	ImportSourceUrl           = "url"
	ImportSourceJson          = "json"
	ItemTypeFile              = "file"
	ItemTypeJobResult         = "job result"
	ItemTypeManifest          = "manifest"
	ItemTypeTagFile           = "tag file"
	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)"
	ProtocolS3                = "s3"
	ProtocolSFTP              = "sftp"
	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"
	ResultTypeList            = "list"
	ResultTypeSingle          = "single"
	ResultTypeUnitialized     = "unintialized"
	SerializationForbidden    = "forbidden"
	SerializationOptional     = "optional"
	SerializationRequired     = "required"
	StageFinish               = "finish"
	StagePackage              = "package"
	StagePreRun               = "pre-run"
	StageValidation           = "validation"
	StageUpload               = "upload"
	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"
)

const BaseHelpUrl = "https://aptrust.github.io/dart-docs/"

Variables

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

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

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

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?"

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

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

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

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

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

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

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

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

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

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

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

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

var HelpUrlFor = map[string]string{
	"AboutShow":                      "",
	"AppSettingDelete":               "users/settings/app_settings/",
	"AppSettingEdit":                 "users/settings/app_settings/",
	"AppSettingIndex":                "users/settings/app_settings/",
	"AppSettingNew":                  "users/settings/app_settings/",
	"AppSettingSave":                 "users/settings/app_settings/",
	"BagItProfileCreate":             "users/bagit/creating/",
	"BagItProfileCreateTagFile":      "users/bagit/customizing/#adding-a-new-tag-file",
	"BagItProfileDelete":             "users/bagit/",
	"BagItProfileDeleteTag":          "users/bagit/customizing/#deleting-a-tag",
	"BagItProfileDeleteTagFile":      "users/bagit/customizing/#deleting-a-tag-file",
	"BagItProfileEdit":               "users/bagit/customizing/",
	"BagItProfileEditTag":            "users/bagit/customizing/#editing-a-tag",
	"BagItProfileExport":             "users/bagit/exporting/",
	"BagItProfileImport":             "users/bagit/importing/",
	"BagItProfileImportStart":        "users/bagit/importing/",
	"BagItProfileIndex":              "users/bagit/",
	"BagItProfileNew":                "users/bagit/creating/",
	"BagItProfileNewTag":             "users/bagit/customizing/#adding-a-new-tag-file",
	"BagItProfileNewTagFile":         "users/bagit/customizing/#adding-a-new-tag-file",
	"BagItProfileSave":               "users/bagit/customizing/",
	"BagItProfileSaveTag":            "users/bagit/customizing/#adding-a-tag",
	"DashboardGetReport":             "users/dashboard/",
	"DashboardShow":                  "users/dashboard/",
	"ExportSettingsIndex":            "users/settings/export/",
	"InternalSettingIndex":           "users/settings/internal_settings/",
	"JobAddFile":                     "users/jobs/files/",
	"JobAddTag":                      "users/jobs/metadata/#adding-custom-tags",
	"JobArtifactShow":                "",
	"JobDelete":                      "users/jobs/delete/",
	"JobDeleteFile":                  "users/jobs/files/#removing-files",
	"JobDeleteTag":                   "users/jobs/metadata/#adding-custom-tags",
	"JobIndex":                       "users/jobs/list/",
	"JobNew":                         "users/jobs/",
	"JobRunExecute":                  "users/jobs/run/",
	"JobRunShow":                     "users/jobs/run/",
	"JobSaveMetadata":                "users/jobs/metadata/",
	"JobSavePackaging":               "users/jobs/packaging/",
	"JobSaveTag":                     "users/jobs/metadata/#adding-custom-tags",
	"JobSaveUpload":                  "users/jobs/upload/",
	"JobShowFiles":                   "users/jobs/files/",
	"JobShowMetadata":                "users/jobs/metadata/",
	"JobShowPackaging":               "users/jobs/packaging/",
	"JobShowUpload":                  "users/jobs/upload/",
	"OpenDataFolder":                 "",
	"OpenExternalUrl":                "",
	"OpenLog":                        "users/logs/",
	"OpenLogFolder":                  "users/logs/",
	"RemoteRepositoryDelete":         "users/settings/remote_repositories/",
	"RemoteRepositoryEdit":           "users/settings/remote_repositories/#editing-remote-repositories",
	"RemoteRepositoryIndex":          "users/settings/remote_repositories/",
	"RemoteRepositoryNew":            "users/settings/remote_repositories/",
	"RemoteRepositorySave":           "users/settings/remote_repositories/",
	"RemoteRepositoryTestConnection": "users/settings/remote_repositories/",
	"SettingsExportDelete":           "users/settings/export/",
	"SettingsExportDeleteQuestion":   "users/settings/export/#export-questions",
	"SettingsExportEdit":             "users/settings/export/",
	"SettingsExportEditQuestion":     "users/settings/export/#export-questions",
	"SettingsExportNew":              "users/settings/export/",
	"SettingsExportNewQuestion":      "users/settings/export/#export-questions",
	"SettingsExportSave":             "users/settings/export/",
	"SettingsExportSaveQuestion":     "users/settings/export/#export-questions",
	"SettingsExportShowJson":         "users/settings/export/",
	"SettingsImportAnswers":          "users/settings/import/",
	"SettingsImportRun":              "users/settings/import/",
	"SettingsImportShow":             "users/settings/import/",
	"SettingsProfileTagList":         "",
	"StorageServiceDelete":           "users/settings/storage_services/",
	"StorageServiceEdit":             "users/settings/storage_services/#editing-storage-services",
	"StorageServiceIndex":            "users/settings/storage_services/",
	"StorageServiceNew":              "users/settings/storage_services/",
	"StorageServiceSave":             "users/settings/storage_services/#editing-storage-services",
	"StorageServiceTestConnection":   "users/settings/storage_services/",
	"UploadJobAddFile":               "",
	"UploadJobDeleteFile":            "",
	"UploadJobNew":                   "",
	"UploadJobReview":                "",
	"UploadJobRun":                   "",
	"UploadJobSaveTarget":            "",
	"UploadJobShowFiles":             "",
	"UploadJobShowTargets":           "",
	"ValidationJobAddFile":           "",
	"ValidationJobDeleteFile":        "",
	"ValidationJobNew":               "",
	"ValidationJobReview":            "",
	"ValidationJobRun":               "",
	"ValidationJobSaveProfile":       "",
	"ValidationJobShowFiles":         "",
	"ValidationJobShowProfiles":      "",
	"WorkflowBatchValidate":          "users/workflows/batch_jobs/",
	"WorkflowCreateFromJob":          "users/workflows/#creating-a-workflow-from-a-job",
	"WorkflowDelete":                 "users/workflows/",
	"WorkflowEdit":                   "users/workflows/#creating-a-workflow-from-scratch",
	"WorkflowExport":                 "",
	"WorkflowIndex":                  "users/workflows/",
	"WorkflowNew":                    "users/workflows/#creating-a-workflow-from-a-job",
	"WorkflowRun":                    "users/workflows/batch_jobs/",
	"WorkflowRunBatch":               "users/workflows/batch_jobs/",
	"WorkflowSave":                   "users/workflows/",
	"WorkflowShowBatchForm":          "users/workflows/batch_jobs/",
}

HelpUrlFor maps DART http handlers to context-specific help pages. There should be one entry here for each handler. If an entry is an empty string, we'll use the BaseHelpUrl.

var PackageFormats = []string{
	PackageFormatBagIt,
}

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

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

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

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

var Version string

Version value is injected at build time.