sessions

Documentation

Index

• func InitSessionManagement(s sessions.Store, us userDAO)
• type Store
  • func GetSessionStore() *Store
  • func (s *Store) EndFor(w http.ResponseWriter, r *http.Request, u *user.User) error
  • func (s *Store) GetCurrent(r *http.Request) (*user.User, error)
  • func (s *Store) GetCurrentCaseProtocol(r *http.Request) (*test.CaseExecutionProtocol, error)
  • func (s *Store) GetCurrentSequenceProtocol(r *http.Request) (*test.SequenceExecutionProtocol, error)
  • func (s *Store) GetDuration(r *http.Request) (*duration.Duration, error)
  • func (s *Store) RemoveCurrentCaseProtocol(w http.ResponseWriter, r *http.Request) error
  • func (s *Store) RemoveCurrentSequenceProtocol(w http.ResponseWriter, r *http.Request) error
  • func (s *Store) SetCurrentCaseProtocol(w http.ResponseWriter, r *http.Request, protocol *test.CaseExecutionProtocol) error
  • func (s *Store) SetCurrentSequenceProtocol(w http.ResponseWriter, r *http.Request, ...) error
  • func (s *Store) SetDuration(w http.ResponseWriter, r *http.Request, duration *duration.Duration) error
  • func (s *Store) StartFor(w http.ResponseWriter, r *http.Request, user *user.User) error
• type TestStore
  • func (s *TestStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (s *TestStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (s *TestStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Functions

func InitSessionManagement

func InitSessionManagement(s sessions.Store, us userDAO)

InitSessionManagement initialize the global Store. Default parameters are nil, anything else is just for testing

Types

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store provides functions to store and get data to the session of a request Don't create your own Store! Better get the global Store via the corresponding function

func GetSessionStore

func GetSessionStore() *Store

GetSessionStore returns a pointer to the session-store

func (*Store) EndFor

func (s *Store) EndFor(w http.ResponseWriter, r *http.Request, u *user.User) error

EndFor removes the user from the session User parameter is not used by now, just for future

func (*Store) GetCurrent

func (s *Store) GetCurrent(r *http.Request) (*user.User, error)

GetCurrent returns the current signed in user to the given request. If the current user is not signed in, the function will return nil, nil If an error occurs nil and the error will be returned

func (*Store) GetCurrentCaseProtocol

func (s *Store) GetCurrentCaseProtocol(r *http.Request) (*test.CaseExecutionProtocol, error)

GetCurrentCaseProtocol returns the protocol to the currently running case execution to the given request. If there is no case execution running, the function will return nil, nil If an error occurs nil and the error will be returned

func (*Store) GetCurrentSequenceProtocol

func (s *Store) GetCurrentSequenceProtocol(r *http.Request) (*test.SequenceExecutionProtocol, error)

GetCurrentSequenceProtocol returns the protocol to the currently running sequence execution to the given request. If there is no sequence execution running, the function will return nil, nil If an error occurs nil and the error will be returned

func (*Store) GetDuration

func (s *Store) GetDuration(r *http.Request) (*duration.Duration, error)

GetDuration returns the duration needed in this execution til now. If there is no sequence execution running, the function will return nil, nil If an error occurs nil and the error will be returned

func (*Store) RemoveCurrentCaseProtocol

func (s *Store) RemoveCurrentCaseProtocol(w http.ResponseWriter, r *http.Request) error

RemoveCurrentCaseProtocol removes the current case protocol from the session.

func (*Store) RemoveCurrentSequenceProtocol

func (s *Store) RemoveCurrentSequenceProtocol(w http.ResponseWriter, r *http.Request) error

RemoveCurrentSequenceProtocol removes the current sequence protocol from the session.

func (*Store) SetCurrentCaseProtocol

func (s *Store) SetCurrentCaseProtocol(w http.ResponseWriter, r *http.Request,
	protocol *test.CaseExecutionProtocol) error

SetCurrentCaseProtocol saves the given protocol to the session. After this call, you can get the current case protocol via the GetCurrentCaseProtocol-function

func (*Store) SetCurrentSequenceProtocol

func (s *Store) SetCurrentSequenceProtocol(w http.ResponseWriter, r *http.Request,
	protocol *test.SequenceExecutionProtocol) error

SetCurrentSequenceProtocol saves the given protocol to the session. After this call, you can get the current sequence protocol via the GetCurrentSequenceProtocol-function

func (*Store) SetDuration

func (s *Store) SetDuration(w http.ResponseWriter, r *http.Request, duration *duration.Duration) error

SetDuration saves the given duration to the session. After this call, you can get the current duration via the GetDuration-function

func (*Store) StartFor

func (s *Store) StartFor(w http.ResponseWriter, r *http.Request, user *user.User) error

StartFor connects the session of the request with an user. After this call, you can get the user via the GetCurrent-function

type TestStore

type TestStore struct {
	// contains filtered or unexported fields
}

TestStore is a Test-Stub of Session-Store

func (*TestStore) Get

func (s *TestStore) Get(r *http.Request, name string) (*sessions.Session, error)

Get gets the session with given name from given request.

func (*TestStore) New

func (s *TestStore) New(r *http.Request, name string) (*sessions.Session, error)

New creates a new session with given name for given request.

func (*TestStore) Save

func (s *TestStore) Save(r *http.Request, w http.ResponseWriter,
	session *sessions.Session) error

Save saves a session and writes into the response writer.