rest

Documentation

Overview

Package rest is a service for serving specific requests directly to frontend

Index

• Constants
• Variables
• type FrontendHandler
  • func NewFrontendHandler() *FrontendHandler
  • func (a *FrontendHandler) Filter() func(string) string
  • func (a *FrontendHandler) FrontBootConf(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontEnrollAuth(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontMessages(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontPlugins(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontPutBinary(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontServeBinary(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontSession(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontSessionDel(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontSessionGet(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) FrontState(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) SettingsMenu(req *restful.Request, rsp *restful.Response) error
  • func (a *FrontendHandler) SwaggerTags() []string

Constants

const (
	RouteMain      = "collabora-main"
	RouteWs        = "collabora-websocket"
	RouteDiscovery = "collabora-discovery"
)

const LibreOffice = "libreoffice"

const LiveKit = "livekit"

Variables

var BasePluginsBox = service.PluginBox{
	Box: front.FrontendAssets,
	Exposes: []string{
		"access.directory",
		"access.gateway",
		"access.homepage",
		"access.settings",
		"action.compression",
		"action.migration",
		"action.share",
		"action.user",
		"auth.pydio",
		"authfront.session_login",
		"core.activitystreams",
		"core.auth",
		"core.authfront",
		"core.conf",
		"core.mailer",
		"core.pydio",
		"core.uploader",
		"editor.browser",
		"editor.ckeditor",
		"editor.codemirror",
		"editor.diaporama",
		"editor.exif",
		"editor.infopanel",
		"editor.libreoffice",
		"editor.openlayer",
		"editor.pdfjs",
		"editor.soundmanager",
		"editor.text",
		"editor.video",
		"gui.ajax",
		"gui.mobile",
		"meta.comments",
		"meta.exif",
		"meta.simple_lock",
		"meta.user",
		"meta.versions",
		"uploader.html",
		"uploader.http",
		"uploader.uppy",
	},
}

Types

type FrontendHandler

type FrontendHandler struct {
	resources.ResourceProviderHandler
}

func NewFrontendHandler

func NewFrontendHandler() *FrontendHandler

func (*FrontendHandler) Filter

func (a *FrontendHandler) Filter() func(string) string

Filter returns a function to filter the swagger path

func (*FrontendHandler) FrontBootConf

func (a *FrontendHandler) FrontBootConf(req *restful.Request, rsp *restful.Response) error

FrontBootConf loads an open JSON struct for start configuration. As it can be called directly as a simple GET /a/frontend/bootconf, this endpoint can rely on Cookie for authentication

func (*FrontendHandler) FrontEnrollAuth

func (a *FrontendHandler) FrontEnrollAuth(req *restful.Request, rsp *restful.Response) error

FrontEnrollAuth is a generic endpoint that can be handled by specific 2FA plugins

func (*FrontendHandler) FrontMessages

func (a *FrontendHandler) FrontMessages(req *restful.Request, rsp *restful.Response) error

FrontMessages loads all i18n messages for a given language

func (*FrontendHandler) FrontPlugins

func (a *FrontendHandler) FrontPlugins(req *restful.Request, rsp *restful.Response) error

FrontPlugins dumps a full list of available frontend plugins

func (*FrontendHandler) FrontPutBinary

func (a *FrontendHandler) FrontPutBinary(req *restful.Request, rsp *restful.Response) error

FrontPutBinary receives an upload to store a binary.

func (*FrontendHandler) FrontServeBinary

func (a *FrontendHandler) FrontServeBinary(req *restful.Request, rsp *restful.Response) error

FrontServeBinary triggers the download of a stored binary. As it can be used directly in <img url="/a/frontend/binary">, this endpoint can rely on the cookie to authenticate user

func (*FrontendHandler) FrontSession

func (a *FrontendHandler) FrontSession(req *restful.Request, rsp *restful.Response) error

FrontSession initiate a cookie-based session based on a LoginRequest

func (*FrontendHandler) FrontSessionDel

func (a *FrontendHandler) FrontSessionDel(req *restful.Request, rsp *restful.Response) error

FrontSessionDel logs out user by clearing the associated cookie session.

func (*FrontendHandler) FrontSessionGet

func (a *FrontendHandler) FrontSessionGet(req *restful.Request, rsp *restful.Response) error

FrontSessionGet loads a cookie-based session to get info about an access token

func (*FrontendHandler) FrontState

func (a *FrontendHandler) FrontState(req *restful.Request, rsp *restful.Response) error

func (*FrontendHandler) SettingsMenu

func (a *FrontendHandler) SettingsMenu(req *restful.Request, rsp *restful.Response) error

SettingsMenu builds the list of available page for the Cells Console left menu

func (*FrontendHandler) SwaggerTags

func (a *FrontendHandler) SwaggerTags() []string

SwaggerTags list the names of the service tags declared in the swagger json implemented by this service