http

Documentation

Index

• Constants
• func CompressionHandler(enableCompression bool, handler libhttp.HandlerFunc) libhttp.HandlerFunc
• func CorsAndCompressionHeaderHandler(handler libhttp.HandlerFunc) libhttp.HandlerFunc
• func CorsHeaderHandler(handler libhttp.HandlerFunc) libhttp.HandlerFunc
• func TimePrecisionFromString(s string) (TimePrecision, error)
• type AllPointsWriter
• type ApiUser
• type ChunkWriter
• type CompressedResponseWriter
  • func NewCompressionResponseWriter(useCompression bool, rw libhttp.ResponseWriter, req *libhttp.Request) *CompressedResponseWriter
  • func (self *CompressedResponseWriter) Header() libhttp.Header
  • func (self *CompressedResponseWriter) Write(bs []byte) (int, error)
  • func (self *CompressedResponseWriter) WriteHeader(responseCode int)
• type ContinuousQuery
• type HttpServer
  • func NewHttpServer(httpPort string, readTimeout time.Duration, adminAssetsDir string, ...) *HttpServer
  • func (self *HttpServer) Close()
  • func (self *HttpServer) EnableSsl(addr, certPath string)
  • func (self *HttpServer) ListenAndServe()
  • func (self *HttpServer) Serve(listener net.Listener)
• type NewContinuousQuery
• type NewUser
• type Point
• type SeriesWriter
  • func NewSeriesWriter(yield func(*protocol.Series) error) *SeriesWriter
  • func (self *SeriesWriter) Close()
  • func (self *SeriesWriter) Write(series *protocol.Series) error
• type UpdateClusterAdminUser
• type UserDetail
• type UserManager
• type Writer

Constants

const (
	INVALID_CREDENTIALS_MSG = "Invalid database/username/password"
)

Functions

func CompressionHandler

func CompressionHandler(enableCompression bool, handler libhttp.HandlerFunc) libhttp.HandlerFunc

func CorsAndCompressionHeaderHandler

func CorsAndCompressionHeaderHandler(handler libhttp.HandlerFunc) libhttp.HandlerFunc

func CorsHeaderHandler

func CorsHeaderHandler(handler libhttp.HandlerFunc) libhttp.HandlerFunc

func TimePrecisionFromString

func TimePrecisionFromString(s string) (TimePrecision, error)

Types

type AllPointsWriter

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

type ApiUser

type ApiUser struct {
	Name string `json:"username"`
}

type ChunkWriter

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

type CompressedResponseWriter

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

func NewCompressionResponseWriter

func NewCompressionResponseWriter(useCompression bool, rw libhttp.ResponseWriter, req *libhttp.Request) *CompressedResponseWriter

func (*CompressedResponseWriter) Header

func (self *CompressedResponseWriter) Header() libhttp.Header

func (*CompressedResponseWriter) Write

func (self *CompressedResponseWriter) Write(bs []byte) (int, error)

func (*CompressedResponseWriter) WriteHeader

func (self *CompressedResponseWriter) WriteHeader(responseCode int)

type ContinuousQuery

type ContinuousQuery struct {
	Id    int64  `json:"id"`
	Query string `json:"query"`
}

type HttpServer

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

func NewHttpServer

func NewHttpServer(httpPort string, readTimeout time.Duration, adminAssetsDir string, theCoordinator coordinator.Coordinator, userManager UserManager, clusterConfig *cluster.ClusterConfiguration, raftServer *coordinator.RaftServer) *HttpServer

func (*HttpServer) Close

func (self *HttpServer) Close()

func (*HttpServer) EnableSsl

func (self *HttpServer) EnableSsl(addr, certPath string)

func (*HttpServer) ListenAndServe

func (self *HttpServer) ListenAndServe()

func (*HttpServer) Serve

func (self *HttpServer) Serve(listener net.Listener)

type NewContinuousQuery

type NewContinuousQuery struct {
	Query string `json:"query"`
}

type NewUser

type NewUser struct {
	Name     string `json:"name"`
	Password string `json:"password"`
	IsAdmin  bool   `json:"isAdmin"`
	ReadFrom string `json:"readFrom"`
	WriteTo  string `json:"writeTo"`
}

type Point

type Point struct {
	Timestamp      int64         `json:"timestamp"`
	SequenceNumber uint32        `json:"sequenceNumber"`
	Values         []interface{} `json:"values"`
}

type SeriesWriter

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

func NewSeriesWriter

func NewSeriesWriter(yield func(*protocol.Series) error) *SeriesWriter

func (*SeriesWriter) Close

func (self *SeriesWriter) Close()

func (*SeriesWriter) Write

func (self *SeriesWriter) Write(series *protocol.Series) error

type UpdateClusterAdminUser

type UpdateClusterAdminUser struct {
	Password string `json:"password"`
}

type UserDetail

type UserDetail struct {
	Name    string `json:"name"`
	IsAdmin bool   `json:"isAdmin"`
}

type UserManager

type UserManager interface {
	// Returns the user for the given db and that has the given
	// credentials, falling back to cluster admins
	AuthenticateDbUser(db, username, password string) (common.User, error)
	// Returns the cluster admin with the given credentials
	AuthenticateClusterAdmin(username, password string) (common.User, error)
	// Create a cluster admin user, it's an error if requester isn't a cluster admin
	CreateClusterAdminUser(request common.User, username, password string) error
	// Delete a cluster admin. Same restrictions as CreateClusterAdminUser
	DeleteClusterAdminUser(requester common.User, username string) error
	// Change cluster admin's password. It's an error if requester isn't a cluster admin
	ChangeClusterAdminPassword(requester common.User, username, password string) error
	// list cluster admins. only a cluster admin can list the other cluster admins
	ListClusterAdmins(requester common.User) ([]string, error)
	// Create a db user, it's an error if requester isn't a db admin or cluster admin
	CreateDbUser(request common.User, db, username, password string, permissions ...string) error
	// Delete a db user. Same restrictions apply as in CreateDbUser
	DeleteDbUser(requester common.User, db, username string) error
	// Change db user's password. It's an error if requester isn't a cluster admin or db admin
	ChangeDbUserPassword(requester common.User, db, username, password string) error
	ChangeDbUserPermissions(requester common.User, db, username, readPermissions, writePermissions string) error
	// list cluster admins. only a cluster admin or the db admin can list the db users
	ListDbUsers(requester common.User, db string) ([]common.User, error)
	GetDbUser(requester common.User, db, username string) (common.User, error)
	// make user a db admin for 'db'. It's an error if the requester
	// isn't a db admin or cluster admin or if user isn't a db user
	// for the given db
	SetDbAdmin(requester common.User, db, username string, isAdmin bool) error
}

type Writer

type Writer interface {
	// contains filtered or unexported methods
}