Documentation ¶
Index ¶
- type McsAPI
- func (o *McsAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *McsAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *McsAPI) Authorizer() runtime.Authorizer
- func (o *McsAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *McsAPI) Context() *middleware.Context
- func (o *McsAPI) DefaultConsumes() string
- func (o *McsAPI) DefaultProduces() string
- func (o *McsAPI) Formats() strfmt.Registry
- func (o *McsAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *McsAPI) Init()
- func (o *McsAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *McsAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *McsAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *McsAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *McsAPI) Serve(builder middleware.Builder) http.Handler
- func (o *McsAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *McsAPI) SetDefaultConsumes(mediaType string)
- func (o *McsAPI) SetDefaultProduces(mediaType string)
- func (o *McsAPI) SetSpec(spec *loads.Document)
- func (o *McsAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type McsAPI ¶
type McsAPI struct { Middleware func(middleware.Builder) http.Handler // BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function. // It has a default implementation 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 implementation 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 implementation 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 the following mime types: // - application/json JSONConsumer runtime.Consumer // BinProducer registers a producer for the following mime types: // - application/octet-stream BinProducer runtime.Producer // JSONProducer registers a producer for the following mime types: // - application/json JSONProducer runtime.Producer // KeyAuth registers a function that takes an access token and a collection of required scopes and returns a principal // it performs authentication based on an oauth2 bearer token provided in the request KeyAuth func(string, []string) (interface{}, error) // APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal APIAuthorizer runtime.Authorizer // AdminAPIAddGroupHandler sets the operation handler for the add group operation AdminAPIAddGroupHandler admin_api.AddGroupHandler // AdminAPIAddPolicyHandler sets the operation handler for the add policy operation AdminAPIAddPolicyHandler admin_api.AddPolicyHandler // AdminAPIAddUserHandler sets the operation handler for the add user operation AdminAPIAddUserHandler admin_api.AddUserHandler // UserAPIBucketInfoHandler sets the operation handler for the bucket info operation UserAPIBucketInfoHandler user_api.BucketInfoHandler // UserAPIBucketSetPolicyHandler sets the operation handler for the bucket set policy operation UserAPIBucketSetPolicyHandler user_api.BucketSetPolicyHandler // AdminAPIConfigInfoHandler sets the operation handler for the config info operation AdminAPIConfigInfoHandler admin_api.ConfigInfoHandler // UserAPIDeleteBucketHandler sets the operation handler for the delete bucket operation UserAPIDeleteBucketHandler user_api.DeleteBucketHandler // AdminAPIGroupInfoHandler sets the operation handler for the group info operation AdminAPIGroupInfoHandler admin_api.GroupInfoHandler // UserAPIListBucketEventsHandler sets the operation handler for the list bucket events operation UserAPIListBucketEventsHandler user_api.ListBucketEventsHandler // UserAPIListBucketsHandler sets the operation handler for the list buckets operation UserAPIListBucketsHandler user_api.ListBucketsHandler // AdminAPIListConfigHandler sets the operation handler for the list config operation AdminAPIListConfigHandler admin_api.ListConfigHandler // AdminAPIListGroupsHandler sets the operation handler for the list groups operation AdminAPIListGroupsHandler admin_api.ListGroupsHandler // AdminAPIListPoliciesHandler sets the operation handler for the list policies operation AdminAPIListPoliciesHandler admin_api.ListPoliciesHandler // AdminAPIListUsersHandler sets the operation handler for the list users operation AdminAPIListUsersHandler admin_api.ListUsersHandler // UserAPILoginHandler sets the operation handler for the login operation UserAPILoginHandler user_api.LoginHandler // UserAPILoginDetailHandler sets the operation handler for the login detail operation UserAPILoginDetailHandler user_api.LoginDetailHandler // UserAPIMakeBucketHandler sets the operation handler for the make bucket operation UserAPIMakeBucketHandler user_api.MakeBucketHandler // AdminAPIPolicyInfoHandler sets the operation handler for the policy info operation AdminAPIPolicyInfoHandler admin_api.PolicyInfoHandler // AdminAPIProfilingStartHandler sets the operation handler for the profiling start operation AdminAPIProfilingStartHandler admin_api.ProfilingStartHandler // AdminAPIProfilingStopHandler sets the operation handler for the profiling stop operation AdminAPIProfilingStopHandler admin_api.ProfilingStopHandler // AdminAPIRemoveGroupHandler sets the operation handler for the remove group operation AdminAPIRemoveGroupHandler admin_api.RemoveGroupHandler // AdminAPIRemovePolicyHandler sets the operation handler for the remove policy operation AdminAPIRemovePolicyHandler admin_api.RemovePolicyHandler // AdminAPIRestartServiceHandler sets the operation handler for the restart service operation AdminAPIRestartServiceHandler admin_api.RestartServiceHandler // AdminAPISetConfigHandler sets the operation handler for the set config operation AdminAPISetConfigHandler admin_api.SetConfigHandler // AdminAPISetPolicyHandler sets the operation handler for the set policy operation AdminAPISetPolicyHandler admin_api.SetPolicyHandler // AdminAPIUpdateGroupHandler sets the operation handler for the update group operation AdminAPIUpdateGroupHandler admin_api.UpdateGroupHandler // 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) // PreServerShutdown is called before the HTTP(S) server is shutdown // This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic PreServerShutdown func() // 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 }
McsAPI the mcs API
func (*McsAPI) AddMiddlewareFor ¶
func (o *McsAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*McsAPI) AuthenticatorsFor ¶
func (o *McsAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*McsAPI) Authorizer ¶
func (o *McsAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*McsAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*McsAPI) Context ¶
func (o *McsAPI) Context() *middleware.Context
Context returns the middleware context for the mcs API
func (*McsAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*McsAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*McsAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*McsAPI) Init ¶
func (o *McsAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*McsAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*McsAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*McsAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*McsAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*McsAPI) Serve ¶
func (o *McsAPI) 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 (*McsAPI) ServeErrorFor ¶
ServeErrorFor gets a error handler for a given operation id
func (*McsAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*McsAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type