response

Documentation

Index

• Constants
• func AddHeaders(rc *RequestContext)
• func AddSessionHeaders(rc *RequestContext)
• func Respond(w http.ResponseWriter, path, requestId string, producer runtime.Producer, ...)
• func RespondWithApiError(w http.ResponseWriter, r *http.Request, requestId string, ...)
• func RespondWithError(w http.ResponseWriter, r *http.Request, requestId string, ...)
• type EventLogger
• type IdType
• type RequestContext
  • func (rc *RequestContext) GetEntityId() (string, error)
  • func (rc *RequestContext) GetEntitySubId() (string, error)
  • func (rc *RequestContext) SetEntityId(id string)
  • func (rc *RequestContext) SetEntitySubId(id string)
• type Responder
• type ResponderImpl
  • func NewResponder(rc *RequestContext) *ResponderImpl
  • func (responder *ResponderImpl) GetProducer() runtime.Producer
  • func (responder *ResponderImpl) Respond(data interface{}, httpStatus int)
  • func (responder *ResponderImpl) RespondWithApiError(apiError *errorz.ApiError)
  • func (responder *ResponderImpl) RespondWithCouldNotParseBody(err error)
  • func (responder *ResponderImpl) RespondWithCouldNotReadBody(err error)
  • func (responder *ResponderImpl) RespondWithCreatedId(id string, link rest_model.Link)
  • func (responder *ResponderImpl) RespondWithEmptyOk()
  • func (responder *ResponderImpl) RespondWithError(err error)
  • func (responder *ResponderImpl) RespondWithFieldError(fe *errorz.FieldError)
  • func (responder *ResponderImpl) RespondWithNotFound()
  • func (responder *ResponderImpl) RespondWithNotFoundWithCause(cause error)
  • func (responder *ResponderImpl) RespondWithOk(data interface{}, meta *rest_model.Meta)
  • func (responder *ResponderImpl) RespondWithValidationErrors(errors *schema.ValidationErrors)
  • func (responder *ResponderImpl) SetProducer(producer runtime.Producer)

Constants

const (
	IdPropertyName    = "id"
	SubIdPropertyName = "subId"
)

const (
	ApiSessionExpirationSecondsHeader = "expiration-seconds"
	ApiSessionExpiresAtHeader         = "expires-at"
	ServerHeader                      = "server"
)

Functions

func AddHeaders

func AddHeaders(rc *RequestContext)

func AddSessionHeaders

func AddSessionHeaders(rc *RequestContext)

func Respond

func Respond(w http.ResponseWriter, path, requestId string, producer runtime.Producer, data interface{}, httpStatus int)

func RespondWithApiError

func RespondWithApiError(w http.ResponseWriter, r *http.Request, requestId string, producer runtime.Producer, apiError *errorz.ApiError)

func RespondWithError

func RespondWithError(w http.ResponseWriter, r *http.Request, requestId string, producer runtime.Producer, err error)

Types

type EventLogger

type EventLogger interface {
	Log(actorType, actorId, eventType, entityType, entityId, formatString string, formatData []string, data map[interface{}]interface{})
}

type IdType

type IdType int

type RequestContext

type RequestContext struct {
	Responder
	Id                string
	ApiSession        *model.ApiSession
	Identity          *model.Identity
	ActivePermissions []string
	ResponseWriter    http.ResponseWriter
	Request           *http.Request
	EventLogger       EventLogger
	SessionToken      string

	Body []byte
	// contains filtered or unexported fields
}

func (*RequestContext) GetEntityId

func (rc *RequestContext) GetEntityId() (string, error)

func (*RequestContext) GetEntitySubId

func (rc *RequestContext) GetEntitySubId() (string, error)

func (*RequestContext) SetEntityId

func (rc *RequestContext) SetEntityId(id string)

func (*RequestContext) SetEntitySubId

func (rc *RequestContext) SetEntitySubId(id string)

type Responder

type Responder interface {
	Respond(data interface{}, httpStatus int)
	RespondWithOk(data interface{}, meta *rest_model.Meta)
	RespondWithEmptyOk()
	RespondWithError(err error)
	RespondWithApiError(apiError *errorz.ApiError)
	SetProducer(producer runtime.Producer)
	GetProducer() runtime.Producer
	RespondWithCouldNotReadBody(err error)
	RespondWithCouldNotParseBody(err error)
	RespondWithValidationErrors(errors *schema.ValidationErrors)
	RespondWithNotFound()
	RespondWithNotFoundWithCause(cause error)
	RespondWithFieldError(fe *errorz.FieldError)
	RespondWithCreatedId(id string, link rest_model.Link)
}

todo: rename to Responder, remove old Responder and RequestResponder

type ResponderImpl

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

func NewResponder

func NewResponder(rc *RequestContext) *ResponderImpl

func (*ResponderImpl) GetProducer

func (responder *ResponderImpl) GetProducer() runtime.Producer

func (*ResponderImpl) Respond

func (responder *ResponderImpl) Respond(data interface{}, httpStatus int)

func (*ResponderImpl) RespondWithApiError

func (responder *ResponderImpl) RespondWithApiError(apiError *errorz.ApiError)

func (*ResponderImpl) RespondWithCouldNotParseBody

func (responder *ResponderImpl) RespondWithCouldNotParseBody(err error)

func (*ResponderImpl) RespondWithCouldNotReadBody

func (responder *ResponderImpl) RespondWithCouldNotReadBody(err error)

func (*ResponderImpl) RespondWithCreatedId

func (responder *ResponderImpl) RespondWithCreatedId(id string, link rest_model.Link)

func (*ResponderImpl) RespondWithEmptyOk

func (responder *ResponderImpl) RespondWithEmptyOk()

func (*ResponderImpl) RespondWithError

func (responder *ResponderImpl) RespondWithError(err error)

func (*ResponderImpl) RespondWithFieldError

func (responder *ResponderImpl) RespondWithFieldError(fe *errorz.FieldError)

func (*ResponderImpl) RespondWithNotFound

func (responder *ResponderImpl) RespondWithNotFound()

func (*ResponderImpl) RespondWithNotFoundWithCause

func (responder *ResponderImpl) RespondWithNotFoundWithCause(cause error)

func (*ResponderImpl) RespondWithOk

func (responder *ResponderImpl) RespondWithOk(data interface{}, meta *rest_model.Meta)

func (*ResponderImpl) RespondWithValidationErrors

func (responder *ResponderImpl) RespondWithValidationErrors(errors *schema.ValidationErrors)

func (*ResponderImpl) SetProducer

func (responder *ResponderImpl) SetProducer(producer runtime.Producer)