operations

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 20, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const HomeOKCode int = 200

HomeOKCode is the HTTP code returned for type HomeOK

View Source 
const RedirectFoundCode int = 302

RedirectFoundCode is the HTTP code returned for type RedirectFound

View Source 
const RootOKCode int = 200

RootOKCode is the HTTP code returned for type RootOK

Variables

This section is empty.

Functions

This section is empty.

Types

type Home 

type Home struct {
	Context *middleware.Context
	Handler HomeHandler
}

Home swagger:route GET /v1/iam/home home

an placehold home page

func NewHome 

func NewHome(ctx *middleware.Context, handler HomeHandler) *Home

NewHome creates a new http.Handler for the home operation

func (*Home) ServeHTTP 

func (o *Home) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type HomeDefault 

type HomeDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

HomeDefault error

swagger:response homeDefault

func NewHomeDefault 

func NewHomeDefault(code int) *HomeDefault

NewHomeDefault creates HomeDefault with default headers values

func (*HomeDefault) SetPayload 

func (o *HomeDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the home default response

func (*HomeDefault) SetStatusCode 

func (o *HomeDefault) SetStatusCode(code int)

SetStatusCode sets the status to the home default response

func (*HomeDefault) WithPayload 

func (o *HomeDefault) WithPayload(payload *models.Error) *HomeDefault

WithPayload adds the payload to the home default response

func (*HomeDefault) WithStatusCode 

func (o *HomeDefault) WithStatusCode(code int) *HomeDefault

WithStatusCode adds the status to the home default response

func (*HomeDefault) WriteResponse 

func (o *HomeDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type HomeHandler 

type HomeHandler interface {
	Handle(HomeParams, interface{}) middleware.Responder
}

HomeHandler interface for that can handle valid home params

type HomeHandlerFunc 

type HomeHandlerFunc func(HomeParams, interface{}) middleware.Responder

HomeHandlerFunc turns a function with the right signature into a home handler

func (HomeHandlerFunc) Handle 

func (fn HomeHandlerFunc) Handle(params HomeParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type HomeOK 

type HomeOK struct {

	/*
	  In: Body
	*/
	Payload *models.Message `json:"body,omitempty"`
}

HomeOK home page

swagger:response homeOK

func NewHomeOK 

func NewHomeOK() *HomeOK

NewHomeOK creates HomeOK with default headers values

func (*HomeOK) SetPayload 

func (o *HomeOK) SetPayload(payload *models.Message)

SetPayload sets the payload to the home o k response

func (*HomeOK) WithPayload 

func (o *HomeOK) WithPayload(payload *models.Message) *HomeOK

WithPayload adds the payload to the home o k response

func (*HomeOK) WriteResponse 

func (o *HomeOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type HomeParams 

type HomeParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request
}

HomeParams contains all the bound params for the home operation typically these are obtained from a http.Request

swagger:parameters home

func NewHomeParams 

func NewHomeParams() HomeParams

NewHomeParams creates a new HomeParams object with the default values initialized.

func (*HomeParams) BindRequest 

func (o *HomeParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls

type HomeURL 

type HomeURL struct {
	// contains filtered or unexported fields
}

HomeURL generates an URL for the home operation

func (*HomeURL) Build 

func (o *HomeURL) Build() (*url.URL, error)

Build a url path and query string

func (*HomeURL) BuildFull 

func (o *HomeURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*HomeURL) Must 

func (o *HomeURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*HomeURL) SetBasePath 

func (o *HomeURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*HomeURL) String 

func (o *HomeURL) String() string

String returns the string representation of the path with query string

func (*HomeURL) StringFull 

func (o *HomeURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*HomeURL) WithBasePath 

func (o *HomeURL) WithBasePath(bp string) *HomeURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type IdentityManagerAPI 

type IdentityManagerAPI 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

	// 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

	// HomeHandler sets the operation handler for the home operation
	HomeHandler HomeHandler
	// RedirectHandler sets the operation handler for the redirect operation
	RedirectHandler RedirectHandler
	// RootHandler sets the operation handler for the root operation
	RootHandler RootHandler

	// 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
}

IdentityManagerAPI VMware Dispatch Identity Manager

func NewIdentityManagerAPI 

func NewIdentityManagerAPI(spec *loads.Document) *IdentityManagerAPI

NewIdentityManagerAPI creates a new IdentityManager instance

func (*IdentityManagerAPI) AuthenticatorsFor 

func (o *IdentityManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*IdentityManagerAPI) Authorizer 

func (o *IdentityManagerAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*IdentityManagerAPI) ConsumersFor 

func (o *IdentityManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types

func (*IdentityManagerAPI) Context 

func (o *IdentityManagerAPI) Context() *middleware.Context

Context returns the middleware context for the identity manager API

func (*IdentityManagerAPI) DefaultConsumes 

func (o *IdentityManagerAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*IdentityManagerAPI) DefaultProduces 

func (o *IdentityManagerAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*IdentityManagerAPI) Formats 

func (o *IdentityManagerAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*IdentityManagerAPI) HandlerFor 

func (o *IdentityManagerAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*IdentityManagerAPI) Init 

func (o *IdentityManagerAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middelware as you see fit

func (*IdentityManagerAPI) ProducersFor 

func (o *IdentityManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types

func (*IdentityManagerAPI) RegisterFormat 

func (o *IdentityManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*IdentityManagerAPI) Serve 

func (o *IdentityManagerAPI) 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 (*IdentityManagerAPI) ServeErrorFor 

func (o *IdentityManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*IdentityManagerAPI) SetDefaultConsumes 

func (o *IdentityManagerAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*IdentityManagerAPI) SetDefaultProduces 

func (o *IdentityManagerAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*IdentityManagerAPI) SetSpec 

func (o *IdentityManagerAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*IdentityManagerAPI) Validate 

func (o *IdentityManagerAPI) Validate() error

Validate validates the registrations in the IdentityManagerAPI

type Redirect 

type Redirect struct {
	Context *middleware.Context
	Handler RedirectHandler
}

Redirect swagger:route GET /v1/iam/redirect redirect

redirect to localhost for vs-cli login (testing)

func NewRedirect 

func NewRedirect(ctx *middleware.Context, handler RedirectHandler) *Redirect

NewRedirect creates a new http.Handler for the redirect operation

func (*Redirect) ServeHTTP 

func (o *Redirect) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type RedirectDefault 

type RedirectDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

RedirectDefault error

swagger:response redirectDefault

func NewRedirectDefault 

func NewRedirectDefault(code int) *RedirectDefault

NewRedirectDefault creates RedirectDefault with default headers values

func (*RedirectDefault) SetPayload 

func (o *RedirectDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the redirect default response

func (*RedirectDefault) SetStatusCode 

func (o *RedirectDefault) SetStatusCode(code int)

SetStatusCode sets the status to the redirect default response

func (*RedirectDefault) WithPayload 

func (o *RedirectDefault) WithPayload(payload *models.Error) *RedirectDefault

WithPayload adds the payload to the redirect default response

func (*RedirectDefault) WithStatusCode 

func (o *RedirectDefault) WithStatusCode(code int) *RedirectDefault

WithStatusCode adds the status to the redirect default response

func (*RedirectDefault) WriteResponse 

func (o *RedirectDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type RedirectFound 

type RedirectFound struct {
	/*redirect location
	  Required: true
	*/
	Location string `json:"Location"`
}

RedirectFound redirect

swagger:response redirectFound

func NewRedirectFound 

func NewRedirectFound() *RedirectFound

NewRedirectFound creates RedirectFound with default headers values

func (*RedirectFound) SetLocation 

func (o *RedirectFound) SetLocation(location string)

SetLocation sets the location to the redirect found response

func (*RedirectFound) WithLocation 

func (o *RedirectFound) WithLocation(location string) *RedirectFound

WithLocation adds the location to the redirect found response

func (*RedirectFound) WriteResponse 

func (o *RedirectFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type RedirectHandler 

type RedirectHandler interface {
	Handle(RedirectParams, interface{}) middleware.Responder
}

RedirectHandler interface for that can handle valid redirect params

type RedirectHandlerFunc 

type RedirectHandlerFunc func(RedirectParams, interface{}) middleware.Responder

RedirectHandlerFunc turns a function with the right signature into a redirect handler

func (RedirectHandlerFunc) Handle 

func (fn RedirectHandlerFunc) Handle(params RedirectParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type RedirectParams 

type RedirectParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request

	/*the local server url redirecting to
	  In: query
	*/
	Redirect *string
}

RedirectParams contains all the bound params for the redirect operation typically these are obtained from a http.Request

swagger:parameters redirect

func NewRedirectParams 

func NewRedirectParams() RedirectParams

NewRedirectParams creates a new RedirectParams object with the default values initialized.

func (*RedirectParams) BindRequest 

func (o *RedirectParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls

type RedirectURL 

type RedirectURL struct {
	Redirect *string
	// contains filtered or unexported fields
}

RedirectURL generates an URL for the redirect operation

func (*RedirectURL) Build 

func (o *RedirectURL) Build() (*url.URL, error)

Build a url path and query string

func (*RedirectURL) BuildFull 

func (o *RedirectURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*RedirectURL) Must 

func (o *RedirectURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*RedirectURL) SetBasePath 

func (o *RedirectURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*RedirectURL) String 

func (o *RedirectURL) String() string

String returns the string representation of the path with query string

func (*RedirectURL) StringFull 

func (o *RedirectURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*RedirectURL) WithBasePath 

func (o *RedirectURL) WithBasePath(bp string) *RedirectURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type Root 

type Root struct {
	Context *middleware.Context
	Handler RootHandler
}

Root swagger:route GET / root

an placehold root page, no authentication is required at this point

func NewRoot 

func NewRoot(ctx *middleware.Context, handler RootHandler) *Root

NewRoot creates a new http.Handler for the root operation

func (*Root) ServeHTTP 

func (o *Root) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type RootDefault 

type RootDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

RootDefault error

swagger:response rootDefault

func NewRootDefault 

func NewRootDefault(code int) *RootDefault

NewRootDefault creates RootDefault with default headers values

func (*RootDefault) SetPayload 

func (o *RootDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the root default response

func (*RootDefault) SetStatusCode 

func (o *RootDefault) SetStatusCode(code int)

SetStatusCode sets the status to the root default response

func (*RootDefault) WithPayload 

func (o *RootDefault) WithPayload(payload *models.Error) *RootDefault

WithPayload adds the payload to the root default response

func (*RootDefault) WithStatusCode 

func (o *RootDefault) WithStatusCode(code int) *RootDefault

WithStatusCode adds the status to the root default response

func (*RootDefault) WriteResponse 

func (o *RootDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type RootHandler 

type RootHandler interface {
	Handle(RootParams) middleware.Responder
}

RootHandler interface for that can handle valid root params

type RootHandlerFunc 

type RootHandlerFunc func(RootParams) middleware.Responder

RootHandlerFunc turns a function with the right signature into a root handler

func (RootHandlerFunc) Handle 

func (fn RootHandlerFunc) Handle(params RootParams) middleware.Responder

Handle executing the request and returning a response

type RootOK 

type RootOK struct {

	/*
	  In: Body
	*/
	Payload *models.Message `json:"body,omitempty"`
}

RootOK home page

swagger:response rootOK

func NewRootOK 

func NewRootOK() *RootOK

NewRootOK creates RootOK with default headers values

func (*RootOK) SetPayload 

func (o *RootOK) SetPayload(payload *models.Message)

SetPayload sets the payload to the root o k response

func (*RootOK) WithPayload 

func (o *RootOK) WithPayload(payload *models.Message) *RootOK

WithPayload adds the payload to the root o k response

func (*RootOK) WriteResponse 

func (o *RootOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type RootParams 

type RootParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request
}

RootParams contains all the bound params for the root operation typically these are obtained from a http.Request

swagger:parameters root

func NewRootParams 

func NewRootParams() RootParams

NewRootParams creates a new RootParams object with the default values initialized.

func (*RootParams) BindRequest 

func (o *RootParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls

type RootURL 

type RootURL struct {
	// contains filtered or unexported fields
}

RootURL generates an URL for the root operation

func (*RootURL) Build 

func (o *RootURL) Build() (*url.URL, error)

Build a url path and query string

func (*RootURL) BuildFull 

func (o *RootURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*RootURL) Must 

func (o *RootURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*RootURL) SetBasePath 

func (o *RootURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*RootURL) String 

func (o *RootURL) String() string

String returns the string representation of the path with query string

func (*RootURL) StringFull 

func (o *RootURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*RootURL) WithBasePath 

func (o *RootURL) WithBasePath(bp string) *RootURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.