handler

type ErrorTemplate interface {
	//ErrorTemplateName returns the unique name of a template to use to render response output.
	ErrorTemplateName() string
}

type Templated interface {
	// TemplateName returns the unique name of a template to use to render response output.
	TemplateName() string

	// UseWhenError returns true if the template returned by TemplateName should be used errors are present in the response.
	UseWhenError() bool
}

type WsHandler struct {

	// A component able to examine a request and see if the caller is allowed to access this endpoint.
	AccessChecker ws.WsAccessChecker

	// Whether or not the underlying HTTP request and response writer should be made available to request Logic.
	AllowDirectHTTPAccess bool

	// Whether or not query parameters should be automatically injected into the request body.
	AutoBindQuery bool

	// A component able to use a set of user-defined rules to validate a request.
	AutoValidator *validate.RuleValidator

	// A list of field names on the target object into which path parameters (groups in the request regex) should be bound to.
	BindPathParams []string

	// Check caller's permissions after request has been parsed (true) or before parsing (false).
	CheckAccessAfterParse bool

	// A function able to create an empty initialised struct to use as a target for request binding
	CreateTarget ioc.StructFactory

	// If true, do not automatically return an error response if errors are found during the parsing and binding phases of request processing.
	DeferFrameworkErrors bool

	// If true, do not automatically return an error response if errors are found during auto validation.
	DeferAutoErrors bool

	// If true, discard the request's query parameters.
	DisableQueryParsing bool

	// If true, discard any path parameters found by match the request URI against the PathMatchPattern regex.
	DisablePathParsing bool

	// An object that provides access to application defined error messages for use during validation.
	ErrorFinder ws.ServiceErrorFinder

	// A map of fields on the request body object and the names of query parameters that should be used to populate them
	FieldQueryParam map[string]string

	// An object that provides access to built-in error messages to use when an error is found during the automated phases of request processing.
	FrameworkErrors *ws.FrameworkErrorGenerator

	// The HTTP method (GET, POST etc) that this handler supports.
	HttpMethod string

	// A logger injected by the Granitic framework. Note this will be an application logger rather than a framework logger
	// as instances of WsHandler are considered application components.
	Log logging.Logger

	// The object representing the 'logic' behind this handler.
	Logic interface{}

	// A component injected by the Granitic framework that can map text representations of query and path parameters to Go
	// and Granitic types.
	ParamBinder *ws.ParamBinder

	// A regex that will be matched against inbound request paths to check if this handler should be used to service the request.
	PathPattern string

	// A component that might want to modify a response after it has been processed by the supplied Logic component.
	PostProcessor WsPostProcessor

	// A compponent that might want to modify a request after it has been parsed, but before it has been validated.
	PreValidateManipulator WsPreValidateManipulator

	// Stop the framework automatically adding this handler to an HTTP server.
	PreventAutoWiring bool

	// A component injected by the Granitic framework that writes the response from this handler to an HTTP response.
	ResponseWriter ws.WsResponseWriter

	// Whether on not the caller needs to be authenticated (using a ws.WsIdentifier) in order to access the logic behind this handler.
	RequireAuthentication bool

	// A component injected by the Granitic framework that can extract the body of the incoming HTTP request into a Go struct.
	Unmarshaller ws.WsUnmarshaller

	// A component that can examine a request to determine the calling user/service's identity.
	UserIdentifier ws.WsIdentifier

	// A component that can check if this handler supports the version of functionality required by the caller.
	VersionAssessor WsVersionAssessor
	// contains filtered or unexported fields
}

type WsPostProcessor interface {
	//PostProcess may modify the supplied response object if required.
	PostProcess(ctx context.Context, handlerName string, request *ws.WsRequest, response *ws.WsResponse)
}

type WsPreValidateManipulator interface {
	// PreValidate returns true if the supplied request is in a suitable state for processing to continue.
	PreValidate(ctx context.Context, request *ws.WsRequest, errors *ws.ServiceErrors) (proceed bool)
}

type WsRequestProcessor interface {
	// Process performs the actual 'work' of a web service request. The reponse parameter will be modified according to
	// the output or errors that the web service caller should see.
	Process(ctx context.Context, request *ws.WsRequest, response *ws.WsResponse)
}

type WsRequestValidator interface {
	// Validate will add one or more CategorisedServiceError objects to the supplied errors parameter if the request is not suitable for further processing.
	Validate(ctx context.Context, errors *ws.ServiceErrors, request *ws.WsRequest)
}

type WsUnmarshallTarget interface {
	// UnmarshallTarget returns a pointer to a struct. That struct can be used by the called to parse or map request data (body, query parameters etc) into.
	UnmarshallTarget() interface{}
}

type WsVersionAssessor interface {
	// SupportsVersion returns true if the named handle is able to support the requested version.
	SupportsVersion(handlerName string, version httpendpoint.RequiredVersion) bool
}