Documentation
¶
Index ¶
- type Controller
- func (c *Controller) Close() error
- func (c *Controller) Execute(ctx context.Context) error
- func (c *Controller) GetAuthMethod(ctx context.Context) (auth_method.Method, error)
- func (c *Controller) GetControllerID() string
- func (c *Controller) GetControllerInfo() *controller.Info
- func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
- type MethodConstructor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller implements a common auth method controller.
The controller contains an authentication method and provides it on a bus.
func NewController ¶
func NewController( le *logrus.Entry, bus bus.Bus, ctor MethodConstructor, methodID string, methodVersion semver.Version, ) *Controller
NewController constructs a new transport controller.
func (*Controller) Close ¶
func (c *Controller) Close() error
Close releases any resources used by the controller. Error indicates any issue encountered releasing.
func (*Controller) Execute ¶
func (c *Controller) Execute(ctx context.Context) error
Execute executes the auth method controller. Returning nil ends execution. Returning an error triggers a retry with backoff.
func (*Controller) GetAuthMethod ¶
func (c *Controller) GetAuthMethod(ctx context.Context) (auth_method.Method, error)
GetAuthMethod returns the controlled method.
func (*Controller) GetControllerID ¶
func (c *Controller) GetControllerID() string
GetControllerID returns the controller ID.
func (*Controller) GetControllerInfo ¶
func (c *Controller) GetControllerInfo() *controller.Info
GetControllerInfo returns information about the controller.
func (*Controller) HandleDirective ¶
func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any unexpected errors are returned for logging. It is safe to add a reference to the directive during this call.
type MethodConstructor ¶
type MethodConstructor = auth_method.Constructor
MethodConstructor constructs an authentication method.
Source Files