stormpathweb

Documentation

Index

• Constants
• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func IsForgotPasswordEnabled(application *stormpath.Application) bool
• func IsVerifyEnabled(application *stormpath.Application) bool
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type StormpathMiddleware
  • func NewStormpathMiddleware(next http.Handler, publicPaths []string) *StormpathMiddleware
  • func (h *StormpathMiddleware) GetAuthenticatedAccount(w http.ResponseWriter, r *http.Request) *stormpath.Account
  • func (h *StormpathMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type UserHandler
  • func EmptyUserHandler() UserHandler

Constants

const (
	ResolvedContentType   = "X-Go-SDK-Resolved-Content-Type"
	TextCSS               = "text/css"
	ApplicationJavascript = "application/javascript"
	AccountKey            = "account"
	ApplicationKey        = "applicaiton"
	NextKey               = "next"
)

Variables

var Config = &webConfig{}

Config is holds the load configuration from the different locations and files

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func IsForgotPasswordEnabled

func IsForgotPasswordEnabled(application *stormpath.Application) bool

func IsVerifyEnabled

func IsVerifyEnabled(application *stormpath.Application) bool

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type StormpathMiddleware

type StormpathMiddleware struct {
	//User configured handler and public paths define by user
	Next        http.Handler
	PublicPaths []string
	//Configured application
	Application *stormpath.Application
	//Integration handlers
	FilterChainHandler      handlerFunc
	LoginHandler            loginHandler
	LogoutHandler           logoutHandler
	RegisterHandler         registerHandler
	ForgotPasswordHandler   forgotPassordHandler
	ChangePasswordHandler   changePasswordHandler
	EmailVerifyHandler      emailVerifyHandler
	FacebookCallbackHandler facebookCallbackHandler
	GoogleCallbackHandler   googleCallbackHandler
	LinkedinCallbackHandler linkedinCallbackHandler
	GithubCallbackHandler   githubCallbackHandler
	CallbackHandler         callbackHandler
	OAuthHandler            oauthHandler
	MeHandler               meHandler
	//User handlers
	PreLoginHandler     UserHandler
	PostLoginHandler    UserHandler
	PreRegisterHandler  UserHandler
	PostRegisterHandler UserHandler
}

StormpathMiddleware the base http.Handler as the base Stormpath web integration

func NewStormpathMiddleware

func NewStormpathMiddleware(next http.Handler, publicPaths []string) *StormpathMiddleware

NewStormpathMiddleware initialize the StormpathMiddleware with the actual user application as a http.Handler

func (*StormpathMiddleware) GetAuthenticatedAccount

func (h *StormpathMiddleware) GetAuthenticatedAccount(w http.ResponseWriter, r *http.Request) *stormpath.Account

func (*StormpathMiddleware) ServeHTTP

func (h *StormpathMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

type UserHandler

type UserHandler func(http.ResponseWriter, *http.Request, context.Context) context.Context

UserHandler type to handle pre/post register or pre/post login define by the user

func EmptyUserHandler

func EmptyUserHandler() UserHandler

EmptyUserHandler use as default user handler for pre/post register and pre/post login user handlers