Documentation
¶
Overview ¶
Package aah is A secure, flexible, rapid Go web framework.
Visit: https://aahframework.org to know more.
Index ¶
- Constants
- Variables
- func ActionMiddleware(ctx *Context, m *Middleware)
- func AddController(c interface{}, methods []*ainsp.Method)
- func AddLoggerHook(name string, hook log.HookFunc) error
- func AddPasswordAlgorithm(name string, encoder acrypto.PasswordEncoder) error
- func AddSessionStore(name string, store session.Storer) error
- func AddTemplateFunc(funcs template.FuncMap)
- func AddValueParser(typ reflect.Type, parser valpar.Parser) error
- func AddViewEngine(name string, engine view.Enginer) error
- func AddWebSocket(w interface{}, methods []*ainsp.Method)
- func AllAppProfiles() []string
- func AntiCSRFMiddleware(ctx *Context, m *Middleware)
- func AppBaseDir() string
- func AppConfig() *config.Config
- func AppDefaultI18nLang() string
- func AppDesc() string
- func AppHTTPAddress() string
- func AppHTTPPort() string
- func AppI18n() *i18n.I18n
- func AppI18nLocales() []string
- func AppImportPath() string
- func AppInstanceName() string
- func AppIsSSLEnabled() bool
- func AppLog() log.Loggerer
- func AppName() string
- func AppProfile() string
- func AppRouter() *router.Router
- func AppSSLCert() string
- func AppSSLKey() string
- func AppSecurityManager() *security.Manager
- func AppSessionManager() *session.Manager
- func AppVFS() *vfs.VFS
- func AppViewEngine() view.Enginer
- func AppVirtualBaseDir() string
- func AppWSEngine() *ws.Engine
- func AuthcAuthzMiddleware(ctx *Context, m *Middleware)
- func BindMiddleware(ctx *Context, m *Middleware)
- func CORSMiddleware(ctx *Context, m *Middleware)
- func Init(importPath string) error
- func NewChildLogger(fields log.Fields) log.Loggerer
- func OnInit(ecb EventCallbackFunc, priority ...int)
- func OnPostShutdown(ecb EventCallbackFunc, priority ...int)
- func OnPreShutdown(ecb EventCallbackFunc, priority ...int)
- func OnStart(ecb EventCallbackFunc, priority ...int)
- func PublishEvent(eventName string, data interface{})
- func PublishEventSync(eventName string, data interface{})
- func RouteMiddleware(ctx *Context, m *Middleware)
- func SetAppBuildInfo(bi *BuildInfo)
- func SetAppPackaged(pack bool)
- func SetAppProfile(profile string) error
- func SetErrorHandler(handlerFunc ErrorHandlerFunc)
- func SetMinifier(fn MinifierFunc)
- func SetTLSConfig(tlsCfg *tls.Config)
- func Shutdown()
- func Start()
- func SubscribeEvent(eventName string, ec EventCallback)
- func SubscribeEventFunc(eventName string, ecf EventCallbackFunc)
- func UnsubscribeEvent(eventName string, ec EventCallback)
- func UnsubscribeEventFunc(eventName string, ecf EventCallbackFunc)
- func Validate(s interface{}) (validator.ValidationErrors, error)
- func ValidateValue(v interface{}, rules string) bool
- func Validator() *validator.Validate
- type BuildInfo
- type Context
- func (ctx *Context) Abort()
- func (ctx *Context) AddViewArg(key string, value interface{}) *Context
- func (ctx *Context) Get(key string) interface{}
- func (ctx *Context) IsStaticRoute() bool
- func (ctx *Context) Log() log.Loggerer
- func (ctx *Context) Msg(key string, args ...interface{}) string
- func (ctx *Context) Msgl(locale *ahttp.Locale, key string, args ...interface{}) string
- func (ctx *Context) Reply() *Reply
- func (ctx *Context) RouteURL(routeName string, args ...interface{}) string
- func (ctx *Context) RouteURLNamedArgs(routeName string, args map[string]interface{}) string
- func (ctx *Context) Session() *session.Session
- func (ctx *Context) Set(key string, value interface{})
- func (ctx *Context) SetMethod(method string)
- func (ctx *Context) SetURL(pathURL string)
- func (ctx *Context) Subdomain() string
- func (ctx *Context) Subject() *security.Subject
- func (ctx *Context) ViewArgs() map[string]interface{}
- type Data
- type Error
- type ErrorHandler
- type ErrorHandlerFunc
- type Event
- type EventCallback
- type EventCallbackFunc
- type EventCallbacks
- type EventStore
- func (es *EventStore) IsEventExists(eventName string) bool
- func (es *EventStore) Publish(e *Event)
- func (es *EventStore) PublishSync(e *Event)
- func (es *EventStore) Subscribe(event string, ec EventCallback)
- func (es *EventStore) SubscriberCount(eventName string) int
- func (es *EventStore) Unsubscribe(event string, callback EventCallbackFunc)
- type HTTPEngine
- func (e *HTTPEngine) Handle(w http.ResponseWriter, r *http.Request)
- func (e *HTTPEngine) Log() log.Loggerer
- func (e *HTTPEngine) Middlewares(middlewares ...MiddlewareFunc)
- func (e *HTTPEngine) OnHeaderReply(sef EventCallbackFunc)
- func (e *HTTPEngine) OnPostAuth(sef EventCallbackFunc)
- func (e *HTTPEngine) OnPostReply(sef EventCallbackFunc)
- func (e *HTTPEngine) OnPreAuth(sef EventCallbackFunc)
- func (e *HTTPEngine) OnPreReply(sef EventCallbackFunc)
- func (e *HTTPEngine) OnRequest(sef EventCallbackFunc)
- type Middleware
- type MiddlewareFunc
- type MinifierFunc
- type Render
- type RenderFunc
- type Reply
- func (r *Reply) Accepted() *Reply
- func (r *Reply) BadRequest() *Reply
- func (r *Reply) Binary(b []byte) *Reply
- func (r *Reply) Body() *bytes.Buffer
- func (r *Reply) Conflict() *Reply
- func (r *Reply) ContentType(contentType string) *Reply
- func (r *Reply) Cookie(cookie *http.Cookie) *Reply
- func (r *Reply) Created() *Reply
- func (r *Reply) DisableGzip() *Reply
- func (r *Reply) Done() *Reply
- func (r *Reply) Error(err *Error) *Reply
- func (r *Reply) File(file string) *Reply
- func (r *Reply) FileDownload(file, targetName string) *Reply
- func (r *Reply) FileInline(file, targetName string) *Reply
- func (r *Reply) Forbidden() *Reply
- func (r *Reply) Found() *Reply
- func (r *Reply) FromReader(reader io.Reader) *Reply
- func (r *Reply) HTML(data Data) *Reply
- func (r *Reply) HTMLf(filename string, data Data) *Reply
- func (r *Reply) HTMLl(layout string, data Data) *Reply
- func (r *Reply) HTMLlf(layout, filename string, data Data) *Reply
- func (r *Reply) Header(key, value string) *Reply
- func (r *Reply) HeaderAppend(key, value string) *Reply
- func (r *Reply) InternalServerError() *Reply
- func (r *Reply) IsContentTypeSet() bool
- func (r *Reply) JSON(data interface{}) *Reply
- func (r *Reply) JSONP(data interface{}, callback string) *Reply
- func (r *Reply) JSONSecure(data interface{}) *Reply
- func (r *Reply) MethodNotAllowed() *Reply
- func (r *Reply) MovedPermanently() *Reply
- func (r *Reply) NoContent() *Reply
- func (r *Reply) NotAcceptable() *Reply
- func (r *Reply) NotFound() *Reply
- func (r *Reply) Ok() *Reply
- func (r *Reply) Redirect(redirectURL string) *Reply
- func (r *Reply) RedirectWithStatus(redirectURL string, code int) *Reply
- func (r *Reply) Render(rdr Render) *Reply
- func (r *Reply) ServiceUnavailable() *Reply
- func (r *Reply) Status(code int) *Reply
- func (r *Reply) TemporaryRedirect() *Reply
- func (r *Reply) Text(format string, values ...interface{}) *Reply
- func (r *Reply) Unauthorized() *Reply
- func (r *Reply) UnsupportedMediaType() *Reply
- func (r *Reply) XML(data interface{}) *Reply
Constants ¶
const ( // EventOnInit is published once the aah.AppConfig() is loaded. At this stage, // only aah.conf config is initialized. App Variables, Routes, i18n, Security, // View Engine, Logs and so on will be initialized after this event. EventOnInit = "OnInit" // EventOnStart is published just before the start of aah Server. // The application is completely initialized at this stage. The server // is yet to be started. EventOnStart = "OnStart" // EventOnPreShutdown is published when application receives OS Signals // `SIGINT` or `SIGTERM` and before the triggering graceful shutdown. After this // event, aah triggers graceful shutdown with config value of // `server.timeout.grace_shutdown`. EventOnPreShutdown = "OnPreShutdown" // EventOnPostShutdown is published just after the successful grace shutdown // of aah server and then application does clean exit. EventOnPostShutdown = "OnPostShutdown" // EventOnRequest is published on each incoming request to the aah server. EventOnRequest = "OnRequest" // EventOnPreReply is published just before writing a reply/response on the wire. // At this point, the response writer is clean. i.e. Headers, Cookies, Redirects, // Status Code and Response Body are not written. event is published when // before server writes the reply on the wire. // // Except when // // 1) `Reply().Done()`, // // 2) `Reply().Redirect(...)` is called. // // Refer `aah.Reply().Done()` godoc for more info. EventOnPreReply = "OnPreReply" // EventOnHeaderReply is published before writing HTTP header Status. // At this point, all the headers except the header Status get written on // the http.ResponseWriter. // // Except when // // 1) `Reply().Done()`, // // 2) `Reply().Redirect(...)` is called. // // Refer `aah.Reply().Done()` godoc for more info. EventOnHeaderReply = "OnHeaderReply" // EventOnPostReply is published right after the response gets written on the // wire. We can do nothing about the response, however the context has valuable // information such as response bytes size, response status code, etc. // // Except when // // 1) `Reply().Done()`, // // 2) `Reply().Redirect(...)` is called. // // Refer `aah.Reply().Done()` godoc for more info. EventOnPostReply = "OnPostReply" // EventOnPreAuth is published just before the Authentication and Authorization. EventOnPreAuth = "OnPreAuth" // EventOnPostAuth is published once the Authentication and Authorization // info gets populated into Subject. EventOnPostAuth = "OnPostAuth" )
const ( // KeyViewArgAuthcInfo key name is used to store `AuthenticationInfo` instance into `ViewArgs`. KeyViewArgAuthcInfo = "_aahAuthcInfo" // KeyViewArgSubject key name is used to store `Subject` instance into `ViewArgs`. KeyViewArgSubject = "_aahSubject" // KeyOAuth2Token key name is used to store OAuth2 Access Token into `aah.Context`. KeyOAuth2Token = "_aahOAuth2Token" )
const ( // KeyViewArgRequest key name is used to store HTTP Request instance // into `ViewArgs`. KeyViewArgRequest = "_aahRequest" )
const Version = "0.11.4"
Version no. of aah framework
Variables ¶
var ( ErrPanicRecovery = errors.New("aah: panic recovery") ErrDomainNotFound = errors.New("aah: domain not found") ErrRouteNotFound = errors.New("aah: route not found") ErrStaticFileNotFound = errors.New("aah: static file not found") ErrControllerOrActionNotFound = errors.New("aah: controller or action not found") ErrInvalidRequestParameter = errors.New("aah: invalid request parameter") ErrContentTypeNotAccepted = errors.New("aah: content type not accepted") ErrContentTypeNotOffered = errors.New("aah: content type not offered") ErrHTTPMethodNotAllowed = errors.New("aah: http method not allowed") ErrNotAuthenticated = errors.New("aah: not authenticated") ErrAccessDenied = errors.New("aah: access denied") ErrAuthenticationFailed = errors.New("aah: authentication failed") ErrAuthorizationFailed = errors.New("aah: authorization failed") ErrSessionAuthenticationInfo = errors.New("aah: session authentication info") ErrUnableToGetPrincipal = errors.New("aah: unable to get principal") ErrGeneric = errors.New("aah: generic error") ErrValidation = errors.New("aah: validation error") ErrRenderResponse = errors.New("aah: render response error") ErrWriteResponse = errors.New("aah: write response error") )
aah errors
var ( // JSONMarshal is used to register external JSON library for Marshalling. JSONMarshal func(v interface{}) ([]byte, error) // JSONMarshalIndent is used to register external JSON library for Marshal indent. JSONMarshalIndent func(v interface{}, prefix, indent string) ([]byte, error) )
Functions ¶
func ActionMiddleware ¶ added in v0.10.1
func ActionMiddleware(ctx *Context, m *Middleware)
ActionMiddleware performs
- Executes Interceptors (Before, Before<ActionName>, After, After<ActionName>, Panic, Panic<ActionName>, Finally, Finally<ActionName>)
- Invokes Controller Action
func AddController ¶
func AddController(c interface{}, methods []*ainsp.Method)
AddController method adds given controller into controller registory.
func AddLoggerHook ¶ added in v0.10.1
AddLoggerHook method adds given logger into aah application default logger.
func AddPasswordAlgorithm ¶ added in v0.10.1
func AddPasswordAlgorithm(name string, encoder acrypto.PasswordEncoder) error
AddPasswordAlgorithm method adds given password algorithm to encoders list. Implementation have to implement interface `PasswordEncoder`.
Then you can use it `security.auth_schemes.*`.
func AddSessionStore ¶
AddSessionStore method allows you to add custom session store which implements `session.Storer` interface. The `name` parameter is used in aah.conf on `session.store.type = "name"`.
func AddTemplateFunc ¶
AddTemplateFunc method adds template func map into view engine.
func AddValueParser ¶ added in v0.10.1
AddValueParser method adds given custom value parser for the `reflect.Type`
func AddViewEngine ¶
AddViewEngine method adds the given name and view engine to view store.
func AddWebSocket ¶ added in v0.11.0
func AddWebSocket(w interface{}, methods []*ainsp.Method)
AddWebSocket method adds given WebSocket into WebSocket registry.
func AllAppProfiles ¶
func AllAppProfiles() []string
AllAppProfiles method returns all the aah application environment profile names.
func AntiCSRFMiddleware ¶ added in v0.10.1
func AntiCSRFMiddleware(ctx *Context, m *Middleware)
AntiCSRFMiddleware provides feature to prevent Cross-Site Request Forgery (CSRF) attacks.
func AppBaseDir ¶
func AppBaseDir() string
AppBaseDir method returns the application base or binary's base directory
For e.g.: $GOPATH/src/github.com/user/myproject <app/binary/path/base/directory>
func AppConfig ¶
func AppConfig() *config.Config
AppConfig method returns aah application configuration instance.
func AppDefaultI18nLang ¶
func AppDefaultI18nLang() string
AppDefaultI18nLang method returns aah application i18n default language if configured other framework defaults to "en".
func AppDesc ¶ added in v0.5.1
func AppDesc() string
AppDesc method returns aah application friendly description from app config otherwise empty string.
func AppHTTPAddress ¶
func AppHTTPAddress() string
AppHTTPAddress method returns aah application HTTP address otherwise empty string
func AppHTTPPort ¶
func AppHTTPPort() string
AppHTTPPort method returns aah application HTTP port number based on `server.port` value. Possible outcomes are user-defined port, `80`, `443` and `8080`.
func AppI18n ¶
func AppI18n() *i18n.I18n
AppI18n method returns aah application I18n store instance.
func AppI18nLocales ¶
func AppI18nLocales() []string
AppI18nLocales returns all the loaded locales from i18n store
func AppImportPath ¶
func AppImportPath() string
AppImportPath method returns the application Go import path.
func AppInstanceName ¶ added in v0.10.1
func AppInstanceName() string
AppInstanceName method returns aah application instane name from app config `instance_name` otherwise empty string.
func AppIsSSLEnabled ¶
func AppIsSSLEnabled() bool
AppIsSSLEnabled method returns true if aah application is enabled with SSL otherwise false.
func AppLog ¶ added in v0.11.0
func AppLog() log.Loggerer
AppLog method return the aah application logger instance.
func AppName ¶
func AppName() string
AppName method returns aah application name from app config `name` otherwise app name of the base directory.
func AppProfile ¶
func AppProfile() string
AppProfile returns aah application configuration profile name For e.g.: dev, prod, etc. Default is `dev`
func AppRouter ¶
func AppRouter() *router.Router
AppRouter method returns aah application router instance.
func AppSSLCert ¶ added in v0.11.0
func AppSSLCert() string
AppSSLCert method returns SSL cert filpath if its configured in aah.conf otherwise empty string.
func AppSSLKey ¶ added in v0.11.0
func AppSSLKey() string
AppSSLKey method returns SSL key filepath if its configured in aah.conf otherwise empty string.
func AppSecurityManager ¶ added in v0.10.1
func AppSecurityManager() *security.Manager
AppSecurityManager method returns the application security instance, which manages the Session, CORS, CSRF, Security Headers, etc.
func AppSessionManager ¶
AppSessionManager method returns the application session manager. By default session is stateless.
func AppVFS ¶ added in v0.11.0
func AppVFS() *vfs.VFS
AppVFS method returns aah Virtual FileSystem instance.
func AppViewEngine ¶
func AppViewEngine() view.Enginer
AppViewEngine method returns aah application view Engine instance.
func AppVirtualBaseDir ¶ added in v0.11.0
func AppVirtualBaseDir() string
AppVirtualBaseDir method returns "/app". In `v0.11.0` Virtual FileSystem (VFS) introduced in aah to provide single binary build packaging and provides seamless experience of Read-Only access to application directory and its sub-tree across OS platforms via `aah.AppVFS()`.
func AppWSEngine ¶ added in v0.11.0
func AppWSEngine() *ws.Engine
AppWSEngine method returns aah WebSocket engine.
Note: It could be nil if WebSocket is not enabled.
func AuthcAuthzMiddleware ¶ added in v0.10.1
func AuthcAuthzMiddleware(ctx *Context, m *Middleware)
AuthcAuthzMiddleware is aah Authentication and Authorization Middleware.
func BindMiddleware ¶ added in v0.10.1
func BindMiddleware(ctx *Context, m *Middleware)
BindMiddleware method parses the incoming HTTP request to collects request parameters (Path, Form, Query, Multipart) stores into context. Request params are made available in View via template functions.
func CORSMiddleware ¶ added in v0.10.1
func CORSMiddleware(ctx *Context, m *Middleware)
CORSMiddleware provides Cross-Origin Resource Sharing (CORS) access control feature.
func Init ¶
Init method initializes `aah` application, if anything goes wrong during initialize process, it will log it as fatal msg and exit.
func NewChildLogger ¶ added in v0.10.1
func NewChildLogger(fields log.Fields) log.Loggerer
NewChildLogger method create a child logger from aah application default logger.
func OnInit ¶
func OnInit(ecb EventCallbackFunc, priority ...int)
OnInit method is to subscribe to aah application `OnInit` event. `OnInit` event published right after the aah application configuration `aah.conf` initialized.
func OnPostShutdown ¶ added in v0.11.0
func OnPostShutdown(ecb EventCallbackFunc, priority ...int)
OnPostShutdown method is to subscribe to aah application `OnPostShutdown` event. `OnPostShutdown` event pubished right the successful grace shutdown of aah server.
func OnPreShutdown ¶ added in v0.11.0
func OnPreShutdown(ecb EventCallbackFunc, priority ...int)
OnPreShutdown method is to subscribe to aah application `OnPreShutdown` event. `OnPreShutdown` event pubished right before the triggering aah server graceful shutdown.
func OnStart ¶
func OnStart(ecb EventCallbackFunc, priority ...int)
OnStart method is to subscribe to aah application `OnStart` event. `OnStart` event pubished right before the aah server starts listening to the request.
func PublishEvent ¶
func PublishEvent(eventName string, data interface{})
PublishEvent method publishes events to subscribed callbacks asynchronously. It means each subscribed callback executed via goroutine.
func PublishEventSync ¶
func PublishEventSync(eventName string, data interface{})
PublishEventSync method publishes events to subscribed callbacks synchronously.
func RouteMiddleware ¶ added in v0.10.1
func RouteMiddleware(ctx *Context, m *Middleware)
RouteMiddleware method performs the routing logic.
func SetAppBuildInfo ¶
func SetAppBuildInfo(bi *BuildInfo)
SetAppBuildInfo method sets the user application build info into aah instance.
func SetAppPackaged ¶ added in v0.5.1
func SetAppPackaged(pack bool)
SetAppPackaged method sets the info of binary is packaged or not.
It is used by framework during application startup. IT'S NOT FOR AAH USER(S).
func SetAppProfile ¶
SetAppProfile method sets given profile as current aah application profile.
For Example: aah.SetAppProfile("prod")
func SetErrorHandler ¶ added in v0.10.1
func SetErrorHandler(handlerFunc ErrorHandlerFunc)
SetErrorHandler method is used to register custom centralized application error handler. If custom handler is not then default error handler takes place.
func SetMinifier ¶ added in v0.10.1
func SetMinifier(fn MinifierFunc)
SetMinifier method sets the given minifier func into aah framework. Note: currently minifier is called only for HTML contentType.
func SetTLSConfig ¶ added in v0.10.1
SetTLSConfig method is used to set custom TLS config for aah server. Note: if `server.ssl.lets_encrypt.enable=true` then framework sets the `GetCertificate` from autocert manager.
Use `aah.OnInit` or `func init() {...}` to assign your custom TLS Config.
func Shutdown ¶
func Shutdown()
Shutdown method allows aah server to shutdown gracefully with given timeout in seconds. It's invoked on OS signal `SIGINT` and `SIGTERM`.
Method performs:
- Graceful server shutdown with timeout by `server.timeout.grace_shutdown`
- Publishes `OnPostShutdown` event
- Exits program with code 0
func SubscribeEvent ¶
func SubscribeEvent(eventName string, ec EventCallback)
SubscribeEvent method is to subscribe to new or existing event.
func SubscribeEventFunc ¶ added in v0.11.0
func SubscribeEventFunc(eventName string, ecf EventCallbackFunc)
SubscribeEventFunc method is to subscribe to new or existing event by `EventCallbackFunc`.
func UnsubscribeEvent ¶
func UnsubscribeEvent(eventName string, ec EventCallback)
UnsubscribeEvent method is to unsubscribe by event name and `EventCallback` from app event store.
func UnsubscribeEventFunc ¶ added in v0.11.0
func UnsubscribeEventFunc(eventName string, ecf EventCallbackFunc)
UnsubscribeEventFunc method is to unsubscribe by event name and `EventCallbackFunc` from app event store.
func Validate ¶ added in v0.10.1
func Validate(s interface{}) (validator.ValidationErrors, error)
Validate method is to validate struct via underneath validator.
Returns:
For validation errors: returns `validator.ValidationErrors` and nil
For invalid input: returns nil, error (invalid input such as nil, non-struct, etc.)
For no validation errors: nil, nil
func ValidateValue ¶ added in v0.10.1
ValidateValue method is to validate individual value on demand.
Returns -
true: validation passed
false: validation failed
For example:
i := 15 result := valpar.ValidateValue(i, "gt=1,lt=10") emailAddress := "sample@sample" result := valpar.ValidateValue(emailAddress, "email") numbers := []int{23, 67, 87, 23, 90} result := valpar.ValidateValue(numbers, "unique")
func Validator ¶ added in v0.10.1
func Validator() *validator.Validate
Validator method return the default validator of aah framework.
Refer to https://godoc.org/gopkg.in/go-playground/validator.v9 for detailed documentation.
Types ¶
type BuildInfo ¶
BuildInfo holds the aah application build information; such as BinaryName, Version and Date.
func AppBuildInfo ¶
func AppBuildInfo() *BuildInfo
AppBuildInfo method return user application version no.
type Context ¶
type Context struct { // Req is HTTP request instance Req *ahttp.Request // Res is HTTP response writer compliant. // // Note 1: It is highly recommended to use `Reply()` builder for // composing your response. // // Note 2: If you're using `cxt.Res` directly, don't forget to call // `Reply().Done()`; so that aah will not intervene with your // response. Res ahttp.ResponseWriter // contains filtered or unexported fields }
Context type for aah framework, gets embedded in application controller.
Note: this is not standard package `context.Context`.
func (*Context) Abort ¶
func (ctx *Context) Abort()
Abort method sets the abort to true. It means framework will not proceed with next middleware, next interceptor or action based on context it being used. Contexts:
- If it's called in the middleware, then middleware chain stops; framework starts processing response.
- If it's called in Before interceptor then Before<Action> interceptor, mapped <Action>, After<Action> interceptor and After interceptor will not execute; framework starts processing response.
- If it's called in Mapped <Action> then After<Action> interceptor and After interceptor will not execute; framework starts processing response.
func (*Context) AddViewArg ¶
AddViewArg method adds given key and value into `viewArgs`. These view args values accessible on templates. Chained call is possible.
func (*Context) Get ¶ added in v0.10.1
Get method returns the value for the given key, otherwise it returns nil.
func (*Context) IsStaticRoute ¶ added in v0.5.1
IsStaticRoute method returns true if it's static route otherwise false.
func (*Context) Log ¶ added in v0.10.1
func (ctx *Context) Log() log.Loggerer
Log method adds field `Request ID` into current log context and returns the logger.
func (*Context) Msg ¶
Msg method returns the i18n value for given key otherwise empty string returned.
func (*Context) Msgl ¶
Msgl method returns the i18n value for given local and key otherwise empty string returned.
func (*Context) Reply ¶
Reply method gives you control and convenient way to write a response effectively.
func (*Context) RouteURL ¶ added in v0.11.0
RouteURL method returns the URL for given route name and args. See `router.Domain.RouteURL` for more information.
func (*Context) RouteURLNamedArgs ¶ added in v0.11.0
RouteURLNamedArgs method returns the URL for given route name and key-value paris. See `router.Domain.RouteURLNamedArgs` for more information.
func (*Context) Session ¶
Session method always returns `session.Session` object. Use `Session.IsNew` to identify whether sesison is newly created or restored from the request which was already created.
func (*Context) Set ¶ added in v0.10.1
Set method is used to set value for the given key in the current request flow.
func (*Context) SetMethod ¶
SetMethod method is to set the request `Method` to change the behaviour of request routing. Ideal for URL rewrting.
Note: This method only takes effect on `OnRequest` HTTP server event.
func (*Context) SetURL ¶
SetURL method is to set the request URL to change the behaviour of request routing. Ideal for URL rewrting. URL can be relative or absolute URL.
Note: This method only takes effect on `OnRequest` HTTP server event.
func (*Context) Subdomain ¶ added in v0.10.1
Subdomain method returns the subdomain from the incoming request if available as per routes.conf. Otherwise empty string.
type Data ¶
type Data map[string]interface{}
Data type used for convenient data type of map[string]interface{}
func (Data) MarshalXML ¶ added in v0.10.1
MarshalXML method is to marshal `aah.Data` into XML.
type Error ¶ added in v0.10.1
type Error struct { Reason error `json:"-" xml:"-"` Code int `json:"code,omitempty" xml:"code,omitempty"` Message string `json:"message,omitempty" xml:"message,omitempty"` Data interface{} `json:"data,omitempty" xml:"data,omitempty"` }
Error structure is used to represent the error information in aah framework.
type ErrorHandler ¶ added in v0.10.1
type ErrorHandler interface { // HandleError method is to handle controller specific errors // // - Returns `true` if one or more errors are handled. aah just writes the reply on the wire. // // - Return `false` if one or more errors could not be handled. aah propagates the error(s) // further onto centralized error handler. If not handled, then finally default // error handler takes control. HandleError(err *Error) bool }
ErrorHandler is an interface to implement controller level error handling
type ErrorHandlerFunc ¶ added in v0.10.1
ErrorHandlerFunc is a function type. It is used to define a centralized error handler for an application.
Returns `true` when one or more errors are handled. aah just writes the reply on the wire.
Returns `false' when one or more errors could not be handled. aah propagates the error(s)
to default error handler.
type Event ¶
type Event struct { Name string Data interface{} }
Event type holds the details of single event.
type EventCallback ¶
type EventCallback struct { Callback EventCallbackFunc CallOnce bool // contains filtered or unexported fields }
EventCallback type is store particular callback in priority for calling sequance.
type EventCallbackFunc ¶
type EventCallbackFunc func(e *Event)
EventCallbackFunc is signature of event callback function.
type EventCallbacks ¶
type EventCallbacks []EventCallback
EventCallbacks type is slice of `EventCallback` type.
func (EventCallbacks) Less ¶
func (ec EventCallbacks) Less(i, j int) bool
func (EventCallbacks) Swap ¶
func (ec EventCallbacks) Swap(i, j int)
type EventStore ¶
type EventStore struct {
// contains filtered or unexported fields
}
EventStore type holds all the events belongs to aah application.
func AppEventStore ¶
func AppEventStore() *EventStore
AppEventStore method returns aah application event store.
func (*EventStore) IsEventExists ¶
func (es *EventStore) IsEventExists(eventName string) bool
IsEventExists method returns true if given event is exists in the event store otherwise false.
func (*EventStore) Publish ¶
func (es *EventStore) Publish(e *Event)
Publish method publishes events to subscribed callbacks asynchronously. It means each subscribed callback executed via goroutine.
func (*EventStore) PublishSync ¶
func (es *EventStore) PublishSync(e *Event)
PublishSync method publishes events to subscribed callbacks synchronously.
func (*EventStore) Subscribe ¶
func (es *EventStore) Subscribe(event string, ec EventCallback)
Subscribe method is to subscribe any event with event callback info.
func (*EventStore) SubscriberCount ¶
func (es *EventStore) SubscriberCount(eventName string) int
SubscriberCount method returns subscriber count for given event name.
func (*EventStore) Unsubscribe ¶
func (es *EventStore) Unsubscribe(event string, callback EventCallbackFunc)
Unsubscribe method is to unsubscribe any callback from event store by event.
type HTTPEngine ¶ added in v0.11.0
type HTTPEngine struct {
// contains filtered or unexported fields
}
HTTPEngine holds the implementation handling HTTP request, response, middlewares, interceptors, etc.
func AppHTTPEngine ¶ added in v0.11.0
func AppHTTPEngine() *HTTPEngine
AppHTTPEngine method returns aah HTTP engine.
func (*HTTPEngine) Handle ¶ added in v0.11.0
func (e *HTTPEngine) Handle(w http.ResponseWriter, r *http.Request)
Handle method is HTTP handler for aah application.
func (*HTTPEngine) Log ¶ added in v0.11.0
func (e *HTTPEngine) Log() log.Loggerer
Log method returns HTTP engine logger.
func (*HTTPEngine) Middlewares ¶ added in v0.11.0
func (e *HTTPEngine) Middlewares(middlewares ...MiddlewareFunc)
Middlewares method adds given middleware into middleware stack
func (*HTTPEngine) OnHeaderReply ¶ added in v0.11.0
func (e *HTTPEngine) OnHeaderReply(sef EventCallbackFunc)
OnHeaderReply method is to subscribe to aah HTTP engine `OnHeaderReply` extension point. `OnHeaderReply` called for every reply from aah server.
Except when 1) `Reply().Done()`, 2) `Reply().Redirect(...)` is called.
Refer `aah.Reply().Done()` godoc for more info.
func (*HTTPEngine) OnPostAuth ¶ added in v0.11.0
func (e *HTTPEngine) OnPostAuth(sef EventCallbackFunc)
OnPostAuth method is to subscribe to aah application `OnPreAuth` event. `OnPostAuth` event pubished right after the aah server authenticates & authorizes an incoming request.
func (*HTTPEngine) OnPostReply ¶ added in v0.11.0
func (e *HTTPEngine) OnPostReply(sef EventCallbackFunc)
OnPostReply method is to subscribe to aah HTTP engine `OnPostReply` extension point. `OnPostReply` called for every reply from aah server.
Except when 1) `Reply().Done()`, 2) `Reply().Redirect(...)` is called.
Refer `aah.Reply().Done()` godoc for more info.
func (*HTTPEngine) OnPreAuth ¶ added in v0.11.0
func (e *HTTPEngine) OnPreAuth(sef EventCallbackFunc)
OnPreAuth method is to subscribe to aah application `OnPreAuth` event. `OnPreAuth` event pubished right before the aah server authenticates & authorizes an incoming request.
func (*HTTPEngine) OnPreReply ¶ added in v0.11.0
func (e *HTTPEngine) OnPreReply(sef EventCallbackFunc)
OnPreReply method is to subscribe to aah HTTP engine `OnPreReply` extension point. `OnPreReply` called for every reply from aah server.
Except when 1) `Reply().Done()`, 2) `Reply().Redirect(...)` is called.
Refer `aah.Reply().Done()` godoc for more info.
func (*HTTPEngine) OnRequest ¶ added in v0.11.0
func (e *HTTPEngine) OnRequest(sef EventCallbackFunc)
OnRequest method is to subscribe to aah HTTP engine `OnRequest` extension point. `OnRequest` called for every incoming HTTP request.
The `aah.Context` object passed to the extension functions is decorated with the `ctx.SetURL()` and `ctx.SetMethod()` methods. Calls to these methods will impact how the request is routed and can be used for rewrite rules.
Note: Route is not yet populated/evaluated at this point.
type Middleware ¶
type Middleware struct {
// contains filtered or unexported fields
}
Middleware struct is to implement aah framework middleware chain.
func (*Middleware) Next ¶
func (mw *Middleware) Next(ctx *Context)
Next method calls next middleware in the chain if available.
type MiddlewareFunc ¶
type MiddlewareFunc func(ctx *Context, m *Middleware)
MiddlewareFunc func type is aah framework middleware signature.
func ToMiddleware ¶
func ToMiddleware(handler interface{}) MiddlewareFunc
ToMiddleware method expands the possibilities. It helps aah users to register the third-party or your own net/http middleware into `aah.MiddlewareFunc`.
It is highly recommened refactored to `aah.MiddlewareFunc`.
You can register below handler types: 1) aah.ToMiddleware(h http.Handler) 2) aah.ToMiddleware(h http.HandlerFunc) 3) aah.ToMiddleware(func(w http.ResponseWriter, r *http.Request))
type MinifierFunc ¶ added in v0.10.1
MinifierFunc is to minify the HTML buffer and write the response into writer.
type RenderFunc ¶ added in v0.10.1
RenderFunc type is an adapter to allow the use of regular function as custom Render.
type Reply ¶
Reply gives you control and convenient way to write a response effectively.
func (*Reply) BadRequest ¶
BadRequest method sets the HTTP Code as 400 RFC 7231, 6.5.1.
func (*Reply) Binary ¶ added in v0.5.1
Binary method writes given bytes into response. It auto-detects the content type of the given bytes if header `Content-Type` is not set.
func (*Reply) Body ¶ added in v0.5.1
Body method returns the response body buffer.
It might be nil if the - 1) Response was written successfully on the wire 2) Response is not yet rendered 3) Static files, since response is written via `http.ServeContent`
func (*Reply) ContentType ¶
ContentType method sets given Content-Type string for the response. Also Reply instance provides easy to use method for very frequently used Content-Type(s).
By default aah framework try to determine response 'Content-Type' from 'ahttp.Request.AcceptContentType()'.
func (*Reply) DisableGzip ¶ added in v0.5.1
DisableGzip method allows you disable Gzip for the reply. By default every response is gzip compressed if the client supports it and gzip enabled in app config.
func (*Reply) Done ¶
Done method is used to indicate response has already been written using `aah.Context.Res` so no further action is needed from framework.
Note: Framework doesn't intervene with response if this method called by aah user.
func (*Reply) Error ¶ added in v0.10.1
Error method is used send an error reply, which is handled by aah error handling mechanism.
More Info: https://docs.aahframework.org/error-handling.html
func (*Reply) File ¶
File method send the given as file to client. It auto-detects the content type of the file if `Content-Type` is not set.
Note: If give filepath is relative path then application base directory is used as prefix.
func (*Reply) FileDownload ¶ added in v0.5.1
FileDownload method send the given as file to client as a download. It sets the `Content-Disposition` as `attachment` with given target name and auto-detects the content type of the file if `Content-Type` is not set.
func (*Reply) FileInline ¶
FileInline method send the given as file to client to display. For e.g.: display within the browser. It sets the `Content-Disposition` as `inline` with given target name and auto-detects the content type of the file if `Content-Type` is not set.
func (*Reply) FromReader ¶ added in v0.11.0
FromReader method reads the data from given reader and writes into response. It auto-detects the content type of the file if `Content-Type` is not set.
Note: Method will close the reader after serving if it's satisfies the `io.Closer`.
func (*Reply) HTML ¶
HTML method renders given data with auto mapped template name and layout by framework. Also it sets HTTP 'Content-Type' as 'text/html; charset=utf-8'.
aah renders the view template based on -
1) path 'Namespace/Sub-package' of Controller,
2) path 'Controller.Action',
3) view extension 'view.ext' and
4) case sensitive 'view.case_sensitive' from aah.conf
5) default layout is 'master.html'
For e.g.: Namespace/Sub-package: frontend Controller: App Action: Login view.ext: html Outcome view template path => /views/pages/frontend/app/login.html
func (*Reply) HTMLf ¶ added in v0.5.1
HTMLf method renders based on given filename and data. Refer `Reply.HTML(...)` method.
func (*Reply) HTMLl ¶
HTMLl method renders based on given layout and data. Refer `Reply.HTML(...)` method.
func (*Reply) HTMLlf ¶
HTMLlf method renders based on given layout, filename and data. Refer `Reply.HTML(...)` method.
func (*Reply) Header ¶
Header method sets the given header and value for the response. If value == "", then this method deletes the header.
Note: It overwrites existing header value if it's present.
func (*Reply) HeaderAppend ¶
HeaderAppend method appends the given header and value for the response.
Note: It just appends to it. It does not overwrite existing header.
func (*Reply) InternalServerError ¶
InternalServerError method sets the HTTP Code as 500 RFC 7231, 6.6.1.
func (*Reply) IsContentTypeSet ¶
IsContentTypeSet method returns true if Content-Type is set otherwise false.
func (*Reply) JSON ¶
JSON method renders given data as JSON response and it sets HTTP 'Content-Type' as 'application/json; charset=utf-8'.
func (*Reply) JSONP ¶
JSONP method renders given data as JSONP response with callback and it sets HTTP 'Content-Type' as 'application/javascript; charset=utf-8'.
func (*Reply) JSONSecure ¶ added in v0.11.0
JSONSecure method renders given data as Secure JSON into response. and it sets HTTP 'Content-Type' as 'application/json; charset=utf-8'.
See config `render.secure_json.prefix`.
func (*Reply) MethodNotAllowed ¶
MethodNotAllowed method sets the HTTP Code as 405 RFC 7231, 6.5.5.
func (*Reply) MovedPermanently ¶
MovedPermanently method sets the HTTP Code as 301 RFC 7231, 6.4.2.
func (*Reply) NotAcceptable ¶ added in v0.11.0
NotAcceptable method sets the HTTP Code as 406 RFC 7231, 6.5.6
func (*Reply) RedirectWithStatus ¶ added in v0.11.0
RedirectWithStatus method redirects to given redirect URL and status code.
func (*Reply) Render ¶ added in v0.10.1
Render method is used render custom implementation using interface `aah.Render`.
func (*Reply) ServiceUnavailable ¶
ServiceUnavailable method sets the HTTP Code as 503 RFC 7231, 6.6.4.
func (*Reply) Status ¶
Status method sets the HTTP Code code for the response. Also Reply instance provides easy to use method for very frequently used HTTP Status Codes reference: http://www.restapitutorial.com/httpCodecodes.html
func (*Reply) TemporaryRedirect ¶
TemporaryRedirect method sets the HTTP Code as 307 RFC 7231, 6.4.7.
func (*Reply) Text ¶
Text method renders given data as Plain Text response with given values and it sets HTTP Content-Type as 'text/plain; charset=utf-8'.
func (*Reply) Unauthorized ¶
Unauthorized method sets the HTTP Code as 401 RFC 7235, 3.1.
func (*Reply) UnsupportedMediaType ¶ added in v0.11.0
UnsupportedMediaType method sets the HTTP Code as 415 RFC 7231, 6.5.13
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
cache
|
|
provider/inmemory
Module
|
|
provider/memcache
Module
|
|
provider/redis
Module
|
|
cli
module
|
|
aah
Module
|
|
ec
|
|
health
Module
|
|
minify
|
|
html
Module
|