Documentation
¶
Index ¶
- type EventManagerAPI
- func (o *EventManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *EventManagerAPI) Authorizer() runtime.Authorizer
- func (o *EventManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *EventManagerAPI) Context() *middleware.Context
- func (o *EventManagerAPI) DefaultConsumes() string
- func (o *EventManagerAPI) DefaultProduces() string
- func (o *EventManagerAPI) Formats() strfmt.Registry
- func (o *EventManagerAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *EventManagerAPI) Init()
- func (o *EventManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *EventManagerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *EventManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *EventManagerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *EventManagerAPI) Serve(builder middleware.Builder) http.Handler
- func (o *EventManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *EventManagerAPI) SetDefaultConsumes(mediaType string)
- func (o *EventManagerAPI) SetDefaultProduces(mediaType string)
- func (o *EventManagerAPI) SetSpec(spec *loads.Document)
- func (o *EventManagerAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EventManagerAPI ¶
type EventManagerAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implemention in the security package, however you can replace it for your particular usage.
BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
// It has a default implemention in the security package, however you can replace it for your particular usage.
APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
// It has a default implemention in the security package, however you can replace it for your particular usage.
BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
// JSONConsumer registers a consumer for a "application/json" mime type
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for a "application/json" mime type
JSONProducer runtime.Producer
// BearerAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key Authorization provided in the header
BearerAuth func(string) (interface{}, error)
// CookieAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key Cookie provided in the header
CookieAuth func(string) (interface{}, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// DriversAddDriverHandler sets the operation handler for the add driver operation
DriversAddDriverHandler drivers.AddDriverHandler
// DriversAddDriverTypeHandler sets the operation handler for the add driver type operation
DriversAddDriverTypeHandler drivers.AddDriverTypeHandler
// SubscriptionsAddSubscriptionHandler sets the operation handler for the add subscription operation
SubscriptionsAddSubscriptionHandler subscriptions.AddSubscriptionHandler
// DriversDeleteDriverHandler sets the operation handler for the delete driver operation
DriversDeleteDriverHandler drivers.DeleteDriverHandler
// DriversDeleteDriverTypeHandler sets the operation handler for the delete driver type operation
DriversDeleteDriverTypeHandler drivers.DeleteDriverTypeHandler
// SubscriptionsDeleteSubscriptionHandler sets the operation handler for the delete subscription operation
SubscriptionsDeleteSubscriptionHandler subscriptions.DeleteSubscriptionHandler
// EventsEmitEventHandler sets the operation handler for the emit event operation
EventsEmitEventHandler events.EmitEventHandler
// DriversGetDriverHandler sets the operation handler for the get driver operation
DriversGetDriverHandler drivers.GetDriverHandler
// DriversGetDriverTypeHandler sets the operation handler for the get driver type operation
DriversGetDriverTypeHandler drivers.GetDriverTypeHandler
// DriversGetDriverTypesHandler sets the operation handler for the get driver types operation
DriversGetDriverTypesHandler drivers.GetDriverTypesHandler
// DriversGetDriversHandler sets the operation handler for the get drivers operation
DriversGetDriversHandler drivers.GetDriversHandler
// SubscriptionsGetSubscriptionHandler sets the operation handler for the get subscription operation
SubscriptionsGetSubscriptionHandler subscriptions.GetSubscriptionHandler
// SubscriptionsGetSubscriptionsHandler sets the operation handler for the get subscriptions operation
SubscriptionsGetSubscriptionsHandler subscriptions.GetSubscriptionsHandler
// DriversUpdateDriverHandler sets the operation handler for the update driver operation
DriversUpdateDriverHandler drivers.UpdateDriverHandler
// DriversUpdateDriverTypeHandler sets the operation handler for the update driver type operation
DriversUpdateDriverTypeHandler drivers.UpdateDriverTypeHandler
// SubscriptionsUpdateSubscriptionHandler sets the operation handler for the update subscription operation
SubscriptionsUpdateSubscriptionHandler subscriptions.UpdateSubscriptionHandler
// ServeError is called when an error is received, there is a default handler
// but you can set your own with this
ServeError func(http.ResponseWriter, *http.Request, error)
// ServerShutdown is called when the HTTP(S) server is shut down and done
// handling all active connections and does not accept connections any more
ServerShutdown func()
// Custom command line argument groups with their descriptions
CommandLineOptionsGroups []swag.CommandLineOptionsGroup
// User defined logger function.
Logger func(string, ...interface{})
// contains filtered or unexported fields
}
EventManagerAPI VMware Dispatch Event Manager
func NewEventManagerAPI ¶
func NewEventManagerAPI(spec *loads.Document) *EventManagerAPI
NewEventManagerAPI creates a new EventManager instance
func (*EventManagerAPI) AuthenticatorsFor ¶
func (o *EventManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*EventManagerAPI) Authorizer ¶
func (o *EventManagerAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*EventManagerAPI) ConsumersFor ¶
func (o *EventManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types
func (*EventManagerAPI) Context ¶
func (o *EventManagerAPI) Context() *middleware.Context
Context returns the middleware context for the event manager API
func (*EventManagerAPI) DefaultConsumes ¶
func (o *EventManagerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*EventManagerAPI) DefaultProduces ¶
func (o *EventManagerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*EventManagerAPI) Formats ¶
func (o *EventManagerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*EventManagerAPI) HandlerFor ¶
func (o *EventManagerAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*EventManagerAPI) Init ¶
func (o *EventManagerAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*EventManagerAPI) ProducersFor ¶
func (o *EventManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types
func (*EventManagerAPI) RegisterConsumer ¶ added in v0.1.13
func (o *EventManagerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*EventManagerAPI) RegisterFormat ¶
func (o *EventManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*EventManagerAPI) RegisterProducer ¶ added in v0.1.13
func (o *EventManagerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*EventManagerAPI) Serve ¶
func (o *EventManagerAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*EventManagerAPI) ServeErrorFor ¶
func (o *EventManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*EventManagerAPI) SetDefaultConsumes ¶
func (o *EventManagerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*EventManagerAPI) SetDefaultProduces ¶
func (o *EventManagerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*EventManagerAPI) SetSpec ¶
func (o *EventManagerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*EventManagerAPI) Validate ¶
func (o *EventManagerAPI) Validate() error
Validate validates the registrations in the EventManagerAPI