gateway

Documentation

Index

• type AuthenticationDetailsReader
• type Gateway
  • func New(storageInstancesSelector string, storageBucket string, ...) (*Gateway, error)
  • func (s *Gateway) Read(ctx context.Context, id string) (io.ReadCloser, bool, error)
  • func (s *Gateway) Write(ctx context.Context, id string, reader io.Reader, objectSizeBytes int64) error
• type ObjectReadWriteFinder
• type ServiceRegistryScanner
• type StorageConnectionFn

Types

type AuthenticationDetailsReader

type AuthenticationDetailsReader interface {
	// Read reads the authentication details to connect to the instance.
	Read(ctx context.Context, instanceID string) (accessKeyID, secretAccessKey string, err error)
}

AuthenticationDetailsReader defines the port to read auth details to connect to the storage instance.

type Gateway

type Gateway struct {
	Logger *slog.Logger
	// contains filtered or unexported fields
}

func New

func New(
	storageInstancesSelector string,
	storageBucket string,
	serviceRegistryClient ServiceRegistryScanner,
	connectionDetailsReader AuthenticationDetailsReader,
	newStorageConnectionFn StorageConnectionFn,
	logger *slog.Logger,
) (*Gateway, error)

New initializes a Gateway.

func (*Gateway) Read

func (s *Gateway) Read(ctx context.Context, id string) (io.ReadCloser, bool, error)

Read reads the object given its ID.

func (*Gateway) Write

func (s *Gateway) Write(ctx context.Context, id string, reader io.Reader, objectSizeBytes int64) error

Write writes object to the storage.

type ObjectReadWriteFinder

type ObjectReadWriteFinder interface {
	// Read reads the object.
	Read(ctx context.Context, bucketName, objectName string) (io.ReadCloser, bool, error)

	// Write writes the object.
	Write(ctx context.Context, bucketName, objectName string, reader io.Reader, objectSizeBytes int64) error

	// Find identifies if the object can be found in the instance.
	Find(ctx context.Context, bucketName, objectName string) (bool, error)
}

ObjectReadWriteFinder defines the port to the storage instance.

type ServiceRegistryScanner

type ServiceRegistryScanner interface {
	// Scan scans the "service discovery" records to find instances and return the map ID -> IP address.
	Scan(ctx context.Context, serviceLabelFilter string) (map[string]string, error)
}

ServiceRegistryScanner defines the port to query the service registry.

type StorageConnectionFn

type StorageConnectionFn func(endpoint, accessKeyID, secretAccessKey string) (ObjectReadWriteFinder, error)

StorageConnectionFn defines the factory of ObjectReadWriteFinder.