router

type Manager interface {
	// Routes return all defined routes.
	Routes() []Route
	// RouteByPattern will return an error if the pattern does not exist.
	RouteByPattern(pattern string) (Route, error)
	// ActionByPatternMethod will return the action by the pattern and HTTP method.
	ActionByPatternMethod(pattern string, method string) string
	// AllowHTTPMethod allows to globally allow/disallow a HTTP Method.
	AllowHTTPMethod(method string, allow bool) error
	// SetSecureMiddleware for the secure routes.
	SetSecureMiddleware(*middleware)
	// SetFavicon for the server. The pattern will be "/favicon.ico".
	SetFavicon(source string) error
	// AddPublicFile to the router. If the source does not exist, an error will return.
	AddPublicFile(pattern string, source string) error
	// AddPublicDir to the router. Directories are not allowed on pattern root level "/".
	AddPublicDir(pattern string, source string) error
	// AddSecureRoute will add a route with all the secure middlewares to the router provider.
	AddSecureRoute(Route) error
	// AddPublicRoute to the router provider.
	AddPublicRoute(Route) error
	// Handler
	Handler() http.Handler
	// SetNotFound - a custom not found Handler can be added.
	SetNotFound(handler http.Handler)
}

type Mapping interface {
	// Action for the mapping.
	Action() string
	// Methods for the mapping.
	Methods() []string
	SetMethods([]string)
	// Middleware(s) of the mapping
	Middleware() *middleware
}

type Provider interface {
	// HTTPHandler must return the mux for http/server.
	HTTPHandler() http.Handler
	// custom NotFound handler can be set.
	SetNotFound(http.Handler)
	// AddRoute to the router.
	AddRoute(Route) error
	// AddPublicDir to the router.
	// The source is already checked if it exists.
	AddPublicDir(url string, path string) error
	// AddPublicFile to the router
	// The source is already checked if it exists.
	AddPublicFile(url string, path string) error
}

type Route interface {
	// Pattern of the route.
	Pattern() string
	// Handler of the route.
	// May be nil, Handler or HandlerFunc has a value.
	Handler() http.Handler
	// HandlerFunc of the route.
	// May be nil, Handler or HandlerFunc has a value.
	HandlerFunc() http.HandlerFunc
	// Mapping of the route.
	Mapping() []Mapping
	// Secure identifies if the rout was added with a secured middleware.
	Secure() bool
	// Error message.
	Error() error
}