httpendpoint

type HttpEndPoint struct {
	// A map of HTTP method names to a regular expression pattern (eg GET=^/health-check$)
	MethodPatterns map[string]string

	// A handler implementing Go's built-in http.Handler interface
	Handler http.Handler
}

type HttpEndpointProvider interface {
	//SupportedHttpMethods returns the HTTP methods (GET, POST, PUT etc) that the endpoint supports.
	SupportedHttpMethods() []string

	// RegexPattern returns an un-compiled regular expression that will be applied to the path element (e.g excluding scheme, domain and query parameters)
	// to potentially match the request to this endpoint.
	RegexPattern() string

	// ServeHttp handles an HTTP request, including writing normal and abnormal responses. Returns a context that may have
	// been modified.
	ServeHttp(ctx context.Context, w *HttpResponseWriter, req *http.Request) context.Context

	// VersionAware returns true if this endpoint supports request version matching.
	VersionAware() bool

	// SupportsVersion returns true if this endpoint supports the version of functionality required by the requester. Behaviour is undefined if
	// VersionAware is false. Version matching is application-specific and not defined by Granitic.
	SupportsVersion(version RequiredVersion) bool

	// AutoWireable returns false if this endpoint should not automatically be registered with HTTP servers.
	AutoWireable() bool
}

type HttpResponseWriter struct {

	// Whether or not any data has already been sent to the underlying http.ResponseWriter.
	DataSent bool

	// The HTTP status code sent to the response or zero if no code yet sent.
	Status int

	// How many bytes have been sent to the response so far (excluding headers).
	BytesServed int
	// contains filtered or unexported fields
}

type RequestedVersionExtractor interface {
	// Extract examines an HTTP request to determine what version of functionality is required.
	Extract(*http.Request) RequiredVersion
}

type RequiredVersion map[string]interface{}