a3m

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(ctx context.Context, tp trace.TracerProvider, addr string) (*Client, error)
• type Config
  • func (c *Config) Validate() error
• type CreateAIPActivity
  • func NewCreateAIPActivity(tracer trace.Tracer, client transferservicev1beta1grpc.TransferServiceClient, ...) *CreateAIPActivity
  • func (a *CreateAIPActivity) Execute(ctx context.Context, opts *CreateAIPActivityParams) (*CreateAIPActivityResult, error)
• type CreateAIPActivityParams
• type CreateAIPActivityResult
• type Processing

Constants

const CreateAIPActivityName = "create-aip-activity"

Variables

var ProcessingDefault = Processing{
	AssignUuidsToDirectories:                     true,
	ExamineContents:                              false,
	GenerateTransferStructureReport:              true,
	DocumentEmptyDirectories:                     true,
	ExtractPackages:                              true,
	DeletePackagesAfterExtraction:                false,
	IdentifyTransfer:                             true,
	IdentifySubmissionAndMetadata:                true,
	IdentifyBeforeNormalization:                  true,
	Normalize:                                    true,
	TranscribeFiles:                              true,
	PerformPolicyChecksOnOriginals:               true,
	PerformPolicyChecksOnPreservationDerivatives: true,
	AipCompressionLevel:                          1,
	AipCompressionAlgorithm:                      transferservice.ProcessingConfig_AIP_COMPRESSION_ALGORITHM_S7_BZIP2,
}

Set the defaults for the a3m transfer service.

Types

type Client

type Client struct {
	TransferClient transferservicev1beta1grpc.TransferServiceClient
}

Client of a3m using the gRPC API.

func NewClient

func NewClient(ctx context.Context, tp trace.TracerProvider, addr string) (*Client, error)

type Config

type Config struct {
	Name     string
	ShareDir string
	Address  string

	// Capacity sets the maximum number of worker sessions the worker can
	// handle at one time (default: 1).
	Capacity int

	Processing
}

func (*Config) Validate

func (c *Config) Validate() error

type CreateAIPActivity

type CreateAIPActivity struct {
	// contains filtered or unexported fields
}

func NewCreateAIPActivity

func NewCreateAIPActivity(
	tracer trace.Tracer,
	client transferservicev1beta1grpc.TransferServiceClient,
	cfg *Config,
	pkgsvc package_.Service,
) *CreateAIPActivity

func (*CreateAIPActivity) Execute

func (a *CreateAIPActivity) Execute(
	ctx context.Context,
	opts *CreateAIPActivityParams,
) (*CreateAIPActivityResult, error)

type CreateAIPActivityParams

type CreateAIPActivityParams struct {
	Name                 string
	Path                 string
	PreservationActionID int
}

type CreateAIPActivityResult

type CreateAIPActivityResult struct {
	Path string
	UUID string
}

type Processing

type Processing struct {
	AssignUuidsToDirectories                     bool
	ExamineContents                              bool
	GenerateTransferStructureReport              bool
	DocumentEmptyDirectories                     bool
	ExtractPackages                              bool
	DeletePackagesAfterExtraction                bool
	IdentifyTransfer                             bool
	IdentifySubmissionAndMetadata                bool
	IdentifyBeforeNormalization                  bool
	Normalize                                    bool
	TranscribeFiles                              bool
	PerformPolicyChecksOnOriginals               bool
	PerformPolicyChecksOnPreservationDerivatives bool
	AipCompressionLevel                          int32
	AipCompressionAlgorithm                      transferservice.ProcessingConfig_AIPCompressionAlgorithm
}

The `Processing` struct represents a configuration for processing various tasks in the transferservice. It mirrors the processing configuration fields in transferservice.ProcessingConfig.