rest

Documentation

Overview

Package rest implements the REST api for managing configurations

Index

• type Handler
  • func (s *Handler) ConfigFormsDiscovery(req *restful.Request, rsp *restful.Response)
  • func (h *Handler) ControlService(req *restful.Request, resp *restful.Response)
  • func (s *Handler) CreateEncryptionKey(req *restful.Request, resp *restful.Response)
  • func (h *Handler) CreatePeerFolder(req *restful.Request, resp *restful.Response)
  • func (s *Handler) DeleteDataSource(req *restful.Request, resp *restful.Response)
  • func (s *Handler) DeleteEncryptionKey(req *restful.Request, resp *restful.Response)
  • func (s *Handler) EndpointsDiscovery(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ExportEncryptionKey(req *restful.Request, resp *restful.Response)
  • func (a *Handler) Filter() func(string) string
  • func (s *Handler) GetConfig(req *restful.Request, resp *restful.Response)
  • func (s *Handler) GetDataSource(req *restful.Request, resp *restful.Response)
  • func (s *Handler) GetVersioningPolicy(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ImportEncryptionKey(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ListDataSources(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ListEncryptionKeys(req *restful.Request, resp *restful.Response)
  • func (h *Handler) ListPeerFolders(req *restful.Request, resp *restful.Response)
  • func (h *Handler) ListPeersAddresses(req *restful.Request, resp *restful.Response)
  • func (h *Handler) ListProcesses(req *restful.Request, resp *restful.Response)
  • func (h *Handler) ListServices(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ListStorageBuckets(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ListVersioningPolicies(req *restful.Request, resp *restful.Response)
  • func (s *Handler) ListVirtualNodes(req *restful.Request, resp *restful.Response)
  • func (s *Handler) OpenApiDiscovery(req *restful.Request, resp *restful.Response)
  • func (s *Handler) PutConfig(req *restful.Request, resp *restful.Response)
  • func (s *Handler) PutDataSource(req *restful.Request, resp *restful.Response)
  • func (s *Handler) SchedulerActionFormDiscovery(req *restful.Request, rsp *restful.Response)
  • func (s *Handler) SchedulerActionsDiscovery(req *restful.Request, rsp *restful.Response)
  • func (a *Handler) SwaggerTags() []string
  • func (h *Handler) ValidateLocalDSFolderOnPeer(ctx context.Context, newSource *object.DataSource) error

Types

type Handler

type Handler struct{}

func (*Handler) ConfigFormsDiscovery

func (s *Handler) ConfigFormsDiscovery(req *restful.Request, rsp *restful.Response)

ConfigFormsDiscovery serves an XML description for building a form

func (*Handler) ControlService

func (h *Handler) ControlService(req *restful.Request, resp *restful.Response)

ControlService is a leagcy method that does not do anything. Should be removed.

func (*Handler) CreateEncryptionKey

func (s *Handler) CreateEncryptionKey(req *restful.Request, resp *restful.Response)

CreateEncryptionKey simply forwards to underlying key service

func (*Handler) CreatePeerFolder

func (h *Handler) CreatePeerFolder(req *restful.Request, resp *restful.Response)

CreatePeerFolder forwards folder creation call to specific peer

func (*Handler) DeleteDataSource

func (s *Handler) DeleteDataSource(req *restful.Request, resp *restful.Response)

func (*Handler) DeleteEncryptionKey

func (s *Handler) DeleteEncryptionKey(req *restful.Request, resp *restful.Response)

DeleteEncryptionKey simply forwards to underlying key service

func (*Handler) EndpointsDiscovery

func (s *Handler) EndpointsDiscovery(req *restful.Request, resp *restful.Response)

**************************** PUBLIC ENDPOINTS FOR DISCOVERY ***************************** Publish a list of available endpoints

func (*Handler) ExportEncryptionKey

func (s *Handler) ExportEncryptionKey(req *restful.Request, resp *restful.Response)

ExportEncryptionKey simply forwards to underlying key service

func (*Handler) Filter

func (a *Handler) Filter() func(string) string

Filter returns a function to filter the swagger path

func (*Handler) GetConfig

func (s *Handler) GetConfig(req *restful.Request, resp *restful.Response)

func (*Handler) GetDataSource

func (s *Handler) GetDataSource(req *restful.Request, resp *restful.Response)

GetDataSource retrieves a datasource given its name.

func (*Handler) GetVersioningPolicy

func (s *Handler) GetVersioningPolicy(req *restful.Request, resp *restful.Response)

GetVersioningPolicy returns a specific policy

func (*Handler) ImportEncryptionKey

func (s *Handler) ImportEncryptionKey(req *restful.Request, resp *restful.Response)

ImportEncryptionKey forwards call to underlying key service

func (*Handler) ListDataSources

func (s *Handler) ListDataSources(req *restful.Request, resp *restful.Response)

func (*Handler) ListEncryptionKeys

func (s *Handler) ListEncryptionKeys(req *restful.Request, resp *restful.Response)

***************************

MASTER KEYS MANAGEMENT

**************************** ListEncryptionKeys simply forwards to underlying key service

func (*Handler) ListPeerFolders

func (h *Handler) ListPeerFolders(req *restful.Request, resp *restful.Response)

ListPeerFolders lists folders on a given peer to configure a local folder datasource.

func (*Handler) ListPeersAddresses

func (h *Handler) ListPeersAddresses(req *restful.Request, resp *restful.Response)

List all Peers (servers) on which any pydio service is running

func (*Handler) ListProcesses

func (h *Handler) ListProcesses(req *restful.Request, resp *restful.Response)

ListProcesses lists running Processes from registry, with option PeerId or ServiceName filter.

func (*Handler) ListServices

func (h *Handler) ListServices(req *restful.Request, resp *restful.Response)

******************** SERVICES MANAGEMENT ******************** List all services with their status

func (*Handler) ListStorageBuckets

func (s *Handler) ListStorageBuckets(req *restful.Request, resp *restful.Response)

ListStorageBuckets implements corresponding API. Lists available buckets on a remote object storage. Currently only supports S3 type storages.

func (*Handler) ListVersioningPolicies

func (s *Handler) ListVersioningPolicies(req *restful.Request, resp *restful.Response)

ListVersioningPolicies list all defined policies.

func (*Handler) ListVirtualNodes

func (s *Handler) ListVirtualNodes(req *restful.Request, resp *restful.Response)

ListVersioningPolicies list all defined policies.

func (*Handler) OpenApiDiscovery

func (s *Handler) OpenApiDiscovery(req *restful.Request, resp *restful.Response)

OpenApiDiscovery prints out the Swagger Spec in JSON format

func (*Handler) PutConfig

func (s *Handler) PutConfig(req *restful.Request, resp *restful.Response)

******************** GENERIC GET/PUT CALLS ********************

func (*Handler) PutDataSource

func (s *Handler) PutDataSource(req *restful.Request, resp *restful.Response)

func (*Handler) SchedulerActionFormDiscovery

func (s *Handler) SchedulerActionFormDiscovery(req *restful.Request, rsp *restful.Response)

SchedulerActionFormDiscovery sends an XML-serialized form for building parameters for a given action

func (*Handler) SchedulerActionsDiscovery

func (s *Handler) SchedulerActionsDiscovery(req *restful.Request, rsp *restful.Response)

SchedulerActionsDiscovery lists all registered actions

func (*Handler) SwaggerTags

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

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

func (*Handler) ValidateLocalDSFolderOnPeer

func (h *Handler) ValidateLocalDSFolderOnPeer(ctx context.Context, newSource *object.DataSource) error

ValidateLocalDSFolderOnPeer sends a couple of stat/create requests to the target Peer to make sure folder is valid