controllerspi

type EventFilter interface {
	// HandlePredicateEvent is the predicate event handler filter that returns true if the object should be reconciled.
	// This is needed to use same CR for multiple controllers
	HandlePredicateEvent(cli client.Client, object client.Object) bool
}

type Finalizer interface {
	// GetName returns the name of the finalizer
	GetName() string

	// PreRemoveFinalizer is called when the resource is being deleted, before the finalizer
	// is removed.  Use this method to delete Kubernetes resources, etc.
	PreRemoveFinalizer(ReconcileContext, *unstructured.Unstructured) result.Result

	// PostRemoveFinalizer is called after the finalizer is successfully removed.
	// This method does garbage collection and other tasks that can never return an error
	PostRemoveFinalizer(ReconcileContext, *unstructured.Unstructured)
}

type FuncControllerEventFilter func(cli client.Client, object client.Object) bool

type FuncShouldReconcile func(cli client.Client, event WatchEvent) bool

type ReconcileContext struct {
	// Log is the VerrazzanoLogger
	Log vzlog.VerrazzanoLogger

	// ClientCtx is the context used to make controller runtime client API calls
	ClientCtx context.Context
}

type Reconciler interface {
	// Reconcile reconciles the resource
	Reconcile(ReconcileContext, *unstructured.Unstructured) result.Result

	// GetReconcileObject returns the client object being reconciled
	GetReconcileObject() client.Object
}

type WatchDescriptor struct {
	// WatchedResourceKind is the kind of resource being watched
	WatchedResourceKind source.Kind

	// FuncShouldReconcile is called when watch event occurs to determine if CR should be reconciled
	FuncShouldReconcile
}

type WatchEvent struct {
	// WatchEventType is the type of watched event
	WatchEventType

	// EventTime is the time the event occurred
	EventTime time.Time

	// NewWatchedObject is the new object that caused the event
	NewWatchedObject client.Object

	// OldWatchedObject is the old object that caused the event. Only valid for update event
	OldWatchedObject client.Object

	// ReconcilingResource is the resource that is potentially being reconciled
	ReconcilingResource types.NamespacedName
}

type WatchEventType int

type Watcher interface {
	// GetWatchDescriptors returns the list of WatchDescriptor for objects being watched
	GetWatchDescriptors() []WatchDescriptor
}