project

Documentation

Index

• Variables
• type AuthnService
• type Filter
• type GroupService
• type PolicyService
• type Project
• type RelationService
• type Repository
• type Service
  • func NewService(repository Repository, relationService RelationService, ...) *Service
  • func (s Service) Create(ctx context.Context, prj Project) (Project, error)
  • func (s Service) DeleteModel(ctx context.Context, id string) error
  • func (s Service) Disable(ctx context.Context, id string) error
  • func (s Service) Enable(ctx context.Context, id string) error
  • func (s Service) Get(ctx context.Context, idOrName string) (Project, error)
  • func (s Service) List(ctx context.Context, f Filter) ([]Project, error)
  • func (s Service) ListByUser(ctx context.Context, principalID, principalType string, flt Filter) ([]Project, error)
  • func (s Service) ListGroups(ctx context.Context, id string) ([]group.Group, error)
  • func (s Service) ListServiceUsers(ctx context.Context, id string, permissionFilter string) ([]serviceuser.ServiceUser, error)
  • func (s Service) ListUsers(ctx context.Context, id string, permissionFilter string) ([]user.User, error)
  • func (s Service) Update(ctx context.Context, prj Project) (Project, error)
• type ServiceuserService
• type State
  • func (s State) String() string
• type UserService

Variables

var (
	ErrNotExist      = errors.New("project or its relations doesn't exist")
	ErrInvalidUUID   = errors.New("invalid syntax of uuid")
	ErrInvalidID     = errors.New("project id is invalid")
	ErrConflict      = errors.New("project already exist")
	ErrInvalidDetail = errors.New("invalid project detail")
)

var AdminPermission = schema.DeletePermission

var MemberPermission = schema.GetPermission

var OwnerRole = schema.RoleProjectOwner

Types

type AuthnService

type AuthnService interface {
	GetPrincipal(ctx context.Context, via ...authenticate.ClientAssertion) (authenticate.Principal, error)
}

type Filter

type Filter struct {
	OrgID           string
	WithMemberCount bool
	ProjectIDs      []string
	State           State
	// NonInherited filters out projects that are inherited from access given through an organization
	NonInherited bool
}

type GroupService

type GroupService interface {
	GetByIDs(ctx context.Context, ids []string) ([]group.Group, error)
	ListByUser(ctx context.Context, principalID, principalType string, flt group.Filter) ([]group.Group, error)
}

type PolicyService

type PolicyService interface {
	Create(ctx context.Context, policy policy.Policy) (policy.Policy, error)
	List(ctx context.Context, flt policy.Filter) ([]policy.Policy, error)
	ProjectMemberCount(ctx context.Context, ids []string) ([]policy.MemberCount, error)
}

type Project

type Project struct {
	ID           string
	Name         string
	Title        string
	Organization organization.Organization
	State        State
	Metadata     metadata.Metadata

	CreatedAt time.Time
	UpdatedAt time.Time

	// Transient fields
	MemberCount int
}

type RelationService

type RelationService interface {
	Create(ctx context.Context, rel relation.Relation) (relation.Relation, error)
	LookupSubjects(ctx context.Context, rel relation.Relation) ([]string, error)
	LookupResources(ctx context.Context, rel relation.Relation) ([]string, error)
	Delete(ctx context.Context, rel relation.Relation) error
}

type Repository

type Repository interface {
	GetByID(ctx context.Context, id string) (Project, error)
	GetByName(ctx context.Context, slug string) (Project, error)
	Create(ctx context.Context, org Project) (Project, error)
	List(ctx context.Context, f Filter) ([]Project, error)
	UpdateByID(ctx context.Context, toUpdate Project) (Project, error)
	UpdateByName(ctx context.Context, toUpdate Project) (Project, error)
	Delete(ctx context.Context, id string) error
	SetState(ctx context.Context, id string, state State) error
}

type Service

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

func NewService

func NewService(repository Repository, relationService RelationService, userService UserService,
	policyService PolicyService, authnService AuthnService, suserService ServiceuserService,
	groupService GroupService) *Service

func (Service) Create

func (s Service) Create(ctx context.Context, prj Project) (Project, error)

func (Service) DeleteModel

func (s Service) DeleteModel(ctx context.Context, id string) error

DeleteModel doesn't delete the nested resource, only itself

func (Service) Disable

func (s Service) Disable(ctx context.Context, id string) error

func (Service) Enable

func (s Service) Enable(ctx context.Context, id string) error

func (Service) Get

func (s Service) Get(ctx context.Context, idOrName string) (Project, error)

func (Service) List

func (s Service) List(ctx context.Context, f Filter) ([]Project, error)

func (Service) ListByUser

func (s Service) ListByUser(ctx context.Context, principalID, principalType string,
	flt Filter) ([]Project, error)

func (Service) ListGroups

func (s Service) ListGroups(ctx context.Context, id string) ([]group.Group, error)

func (Service) ListServiceUsers

func (s Service) ListServiceUsers(ctx context.Context, id string, permissionFilter string) ([]serviceuser.ServiceUser, error)

func (Service) ListUsers

func (s Service) ListUsers(ctx context.Context, id string, permissionFilter string) ([]user.User, error)

func (Service) Update

func (s Service) Update(ctx context.Context, prj Project) (Project, error)

type ServiceuserService

type ServiceuserService interface {
	GetByIDs(ctx context.Context, ids []string) ([]serviceuser.ServiceUser, error)
}

type State

type State string

const (
	Enabled  State = "enabled"
	Disabled State = "disabled"
)

func (State) String

func (s State) String() string

type UserService

type UserService interface {
	GetByID(ctx context.Context, id string) (user.User, error)
	GetByIDs(ctx context.Context, userIDs []string) ([]user.User, error)
}