package v2

import (
	"context"
)

// AuthProvider represents an abstracted authentication provider
type AuthProvider interface {
	// Authenticate attempts to authenticate a user with its username and password
	Authenticate(ctx context.Context, username, password string) (*Claims, error)
	// Refresh renews the user claims with the provider claims
	Refresh(ctx context.Context, providerClaims AuthProviderClaims) (*Claims, error)

	// GetObjectMeta returns the object metadata for the provider
	GetObjectMeta() ObjectMeta
	// Name returns the provider name (e.g. default)
	Name() string
	// StorePrefix gives the path prefix to this resource in the store
	StorePrefix() string
	// Type returns the provider type (e.g. ldap)
	Type() string
	// URIPath gives the path to the provider
	URIPath() string
	// Validate checks if the fields in the provider are valid
	Validate() error
	// SetNamespace sets the namespace of the resource.
	SetNamespace(string)
}