objectresolver

Documentation

Index

• Variables
• func MustGetOrCreateByName[T any](t *testing.T, resolver *Resolver[T], name string) T
• type CorrespondentClient
• type CorrespondentResolver
  • func NewCorrespondentResolver(opts CorrespondentResolverOptions) *CorrespondentResolver
  • func NewMemCorrespondentResolver() *CorrespondentResolver
• type CorrespondentResolverOptions
• type DocumentTypeClient
• type DocumentTypeResolver
  • func NewDocumentTypeResolver(opts DocumentTypeResolverOptions) *DocumentTypeResolver
  • func NewMemDocumentTypeResolver() *DocumentTypeResolver
• type DocumentTypeResolverOptions
• type GroupClient
• type GroupResolver
  • func NewGroupResolver(opts GroupResolverOptions) *GroupResolver
  • func NewMemGroupResolver() *GroupResolver
• type GroupResolverOptions
• type NamedObjectPermissionPrincipals
• type NamedObjectPermissions
  • func (p *NamedObjectPermissions) RegisterFlags(app *kingpin.Application)
• type ObjectResolverClient
• type ObjectResolvers
  • func NewMemObjectResolvers() *ObjectResolvers
  • func NewObjectResolvers(ctx context.Context, cl ObjectResolverClient, ...) (*ObjectResolvers, error)
• type PermissionOptions
• type ResolveOwnerClient
• type Resolver
  • func (r *Resolver[T]) GetByName(ctx context.Context, name string) (T, error)
  • func (r *Resolver[T]) GetOrCreateByName(ctx context.Context, name string) (T, error)
• type StoragePathClient
• type StoragePathResolver
  • func NewMemStoragePathResolver() *StoragePathResolver
  • func NewStoragePathResolver(opts StoragePathResolverOptions) *StoragePathResolver
• type StoragePathResolverOptions
• type TagClient
• type TagResolver
  • func NewMemTagResolver() *TagResolver
  • func NewTagResolver(opts TagResolverOptions) *TagResolver
• type TagResolverOptions
• type UserClient
• type UserResolver
  • func NewMemUserResolver() *UserResolver
  • func NewUserResolver(opts UserResolverOptions) *UserResolver
• type UserResolverOptions

Variables

var (
	ErrAmbiguous         = errors.New("ambiguous object list result")
	ErrCreateUnsupported = errors.New("object creation not supported")
	ErrNotFound          = errors.New("object not found")
)

Functions

func MustGetOrCreateByName

func MustGetOrCreateByName[T any](t *testing.T, resolver *Resolver[T], name string) T

Types

type CorrespondentClient

type CorrespondentClient interface {
	ListCorrespondents(context.Context, plclient.ListCorrespondentsOptions) ([]plclient.Correspondent, *plclient.Response, error)
	CreateCorrespondent(context.Context, *plclient.CorrespondentFields) (*plclient.Correspondent, *plclient.Response, error)
}

type CorrespondentResolver

type CorrespondentResolver = Resolver[plclient.Correspondent]

func NewCorrespondentResolver

func NewCorrespondentResolver(opts CorrespondentResolverOptions) *CorrespondentResolver

func NewMemCorrespondentResolver

func NewMemCorrespondentResolver() *CorrespondentResolver

type CorrespondentResolverOptions

type CorrespondentResolverOptions struct {
	PermissionOptions

	Client CorrespondentClient
}

type DocumentTypeClient

type DocumentTypeClient interface {
	ListDocumentTypes(context.Context, plclient.ListDocumentTypesOptions) ([]plclient.DocumentType, *plclient.Response, error)
	CreateDocumentType(context.Context, *plclient.DocumentTypeFields) (*plclient.DocumentType, *plclient.Response, error)
}

type DocumentTypeResolver

type DocumentTypeResolver = Resolver[plclient.DocumentType]

func NewDocumentTypeResolver

func NewDocumentTypeResolver(opts DocumentTypeResolverOptions) *DocumentTypeResolver

func NewMemDocumentTypeResolver

func NewMemDocumentTypeResolver() *DocumentTypeResolver

type DocumentTypeResolverOptions

type DocumentTypeResolverOptions struct {
	PermissionOptions

	Client DocumentTypeClient
}

type GroupClient

type GroupClient interface {
	ListGroups(context.Context, plclient.ListGroupsOptions) ([]plclient.Group, *plclient.Response, error)
}

type GroupResolver

type GroupResolver = Resolver[plclient.Group]

func NewGroupResolver

func NewGroupResolver(opts GroupResolverOptions) *GroupResolver

func NewMemGroupResolver

func NewMemGroupResolver() *GroupResolver

type GroupResolverOptions

type GroupResolverOptions struct {
	Client GroupClient
}

type NamedObjectPermissionPrincipals

type NamedObjectPermissionPrincipals struct {
	Users  []string
	Groups []string
}

type NamedObjectPermissions

type NamedObjectPermissions struct {
	Owner  string
	View   NamedObjectPermissionPrincipals
	Change NamedObjectPermissionPrincipals
}

func (*NamedObjectPermissions) RegisterFlags

func (p *NamedObjectPermissions) RegisterFlags(app *kingpin.Application)

type ObjectResolverClient

type ObjectResolverClient interface {
	ResolveOwnerClient
	UserClient
	GroupClient
	TagClient
	CorrespondentClient
	DocumentTypeClient
	StoragePathClient
}

type ObjectResolvers

type ObjectResolvers struct {
	User          *UserResolver
	Group         *GroupResolver
	Tag           *TagResolver
	Correspondent *CorrespondentResolver
	DocumentType  *DocumentTypeResolver
	StoragePath   *StoragePathResolver
}

func NewMemObjectResolvers

func NewMemObjectResolvers() *ObjectResolvers

func NewObjectResolvers

func NewObjectResolvers(ctx context.Context, cl ObjectResolverClient, defaultPerm NamedObjectPermissions) (*ObjectResolvers, error)

type PermissionOptions

type PermissionOptions struct {
	DefaultOwner       *int64
	DefaultPermissions *plclient.ObjectPermissions
}

type ResolveOwnerClient

type ResolveOwnerClient interface {
	GetCurrentUser(context.Context) (*plclient.User, *plclient.Response, error)
}

type Resolver

type Resolver[T any] struct {
	// contains filtered or unexported fields
}

func (*Resolver[T]) GetByName

func (r *Resolver[T]) GetByName(ctx context.Context, name string) (T, error)

func (*Resolver[T]) GetOrCreateByName

func (r *Resolver[T]) GetOrCreateByName(ctx context.Context, name string) (T, error)

type StoragePathClient

type StoragePathClient interface {
	ListStoragePaths(context.Context, plclient.ListStoragePathsOptions) ([]plclient.StoragePath, *plclient.Response, error)
	CreateStoragePath(context.Context, *plclient.StoragePathFields) (*plclient.StoragePath, *plclient.Response, error)
}

type StoragePathResolver

type StoragePathResolver = Resolver[plclient.StoragePath]

func NewMemStoragePathResolver

func NewMemStoragePathResolver() *StoragePathResolver

func NewStoragePathResolver

func NewStoragePathResolver(opts StoragePathResolverOptions) *StoragePathResolver

type StoragePathResolverOptions

type StoragePathResolverOptions struct {
	PermissionOptions

	Client StoragePathClient
}

type TagClient

type TagClient interface {
	ListTags(context.Context, plclient.ListTagsOptions) ([]plclient.Tag, *plclient.Response, error)
	CreateTag(context.Context, *plclient.TagFields) (*plclient.Tag, *plclient.Response, error)
}

type TagResolver

type TagResolver = Resolver[plclient.Tag]

func NewMemTagResolver

func NewMemTagResolver() *TagResolver

func NewTagResolver

func NewTagResolver(opts TagResolverOptions) *TagResolver

type TagResolverOptions

type TagResolverOptions struct {
	PermissionOptions

	Client TagClient
}

type UserClient

type UserClient interface {
	ListUsers(context.Context, plclient.ListUsersOptions) ([]plclient.User, *plclient.Response, error)
}

type UserResolver

type UserResolver = Resolver[plclient.User]

func NewMemUserResolver

func NewMemUserResolver() *UserResolver

func NewUserResolver

func NewUserResolver(opts UserResolverOptions) *UserResolver

type UserResolverOptions

type UserResolverOptions struct {
	Client UserClient
}