grpc

Documentation

Overview

• Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
• This file is part of Pydio Cells. *
• Pydio Cells is free software: you can redistribute it and/or modify
• it under the terms of the GNU Affero General Public License as published by
• the Free Software Foundation, either version 3 of the License, or
• (at your option) any later version. *
• Pydio Cells is distributed in the hope that it will be useful,
• but WITHOUT ANY WARRANTY; without even the implied warranty of
• MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
• GNU Affero General Public License for more details. *
• You should have received a copy of the GNU Affero General Public License
• along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>. *
• The latest code can be found at <https://pydio.com>.

Package grpc provides the gRPC service to communicate with the Pydio's user persistence layer.

Index

• Constants
• Variables
• func CreateIfNotExists(ctx context.Context, dao user.DAO, user *idm.User) (*idm.User, error)
• func InitDefaults(ctx context.Context) error
• type ByOverride
  • func (a ByOverride) Len() int
  • func (a ByOverride) Less(i, j int) bool
  • func (a ByOverride) Swap(i, j int)
• type DeleteUsersAction
  • func (a *DeleteUsersAction) GetDescription(lang ...string) actions.ActionDescription
  • func (a *DeleteUsersAction) GetName() string
  • func (a *DeleteUsersAction) GetParametersForm() *forms.Form
  • func (a *DeleteUsersAction) Init(job *jobs.Job, cl client.Client, action *jobs.Action) error
  • func (a *DeleteUsersAction) ProvidesProgress() bool
  • func (a *DeleteUsersAction) Run(ctx context.Context, channels *actions.RunnableChannels, ...) (jobs.ActionMessage, error)
  • func (a *DeleteUsersAction) SetTask(task *jobs.Task)
• type Handler
  • func (h *Handler) BindUser(ctx context.Context, req *idm.BindUserRequest, resp *idm.BindUserResponse) error
  • func (h *Handler) CountUser(ctx context.Context, request *idm.SearchUserRequest, ...) error
  • func (h *Handler) CreateUser(ctx context.Context, req *idm.CreateUserRequest, resp *idm.CreateUserResponse) error
  • func (h *Handler) DeleteUser(ctx context.Context, req *idm.DeleteUserRequest, ...) error
  • func (h *Handler) SearchUser(ctx context.Context, request *idm.SearchUserRequest, ...) error
  • func (h *Handler) StreamUser(ctx context.Context, streamer idm.UserService_StreamUserStream) error
• type RolesCleaner
  • func (c *RolesCleaner) Handle(ctx context.Context, msg *idm.ChangeEvent) error

Constants

const (
	ENV_PYDIO_ADMIN_USER_LOGIN    = "PYDIO_ADMIN_USER_LOGIN"
	ENV_PYDIO_ADMIN_USER_PASSWORD = "PYDIO_ADMIN_USER_PASSWORD"
)

Variables

var (
	DeleteUsersActionName = "actions.idm.users.delete"
)

Functions

func CreateIfNotExists

func CreateIfNotExists(ctx context.Context, dao user.DAO, user *idm.User) (*idm.User, error)

CreateIfNotExists creates a user if DAO.Bind() call returns a 404 error.

func InitDefaults

func InitDefaults(ctx context.Context) error

Types

type ByOverride

type ByOverride []*idm.Role

ByOverride implements sort.Interface for []Role based on the ForceOverride field.

func (ByOverride) Len

func (a ByOverride) Len() int

func (ByOverride) Less

func (a ByOverride) Less(i, j int) bool

func (ByOverride) Swap

func (a ByOverride) Swap(i, j int)

type DeleteUsersAction

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

func (*DeleteUsersAction) GetDescription

func (a *DeleteUsersAction) GetDescription(lang ...string) actions.ActionDescription

func (*DeleteUsersAction) GetName

func (a *DeleteUsersAction) GetName() string

func (*DeleteUsersAction) GetParametersForm

func (a *DeleteUsersAction) GetParametersForm() *forms.Form

func (*DeleteUsersAction) Init

func (a *DeleteUsersAction) Init(job *jobs.Job, cl client.Client, action *jobs.Action) error

func (*DeleteUsersAction) ProvidesProgress

func (a *DeleteUsersAction) ProvidesProgress() bool

func (*DeleteUsersAction) Run

func (a *DeleteUsersAction) Run(ctx context.Context, channels *actions.RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)

func (*DeleteUsersAction) SetTask

func (a *DeleteUsersAction) SetTask(task *jobs.Task)

SetTask implements TaskUpdaterDelegateAction as the target service will update the task status on its side.

type Handler

type Handler struct{}

Handler definition

func (*Handler) BindUser

func (h *Handler) BindUser(ctx context.Context, req *idm.BindUserRequest, resp *idm.BindUserResponse) error

BindUser binds a user with login/password

func (*Handler) CountUser

func (h *Handler) CountUser(ctx context.Context, request *idm.SearchUserRequest, response *idm.CountUserResponse) error

CountUser in database

func (*Handler) CreateUser

func (h *Handler) CreateUser(ctx context.Context, req *idm.CreateUserRequest, resp *idm.CreateUserResponse) error

CreateUser adds or creates a user or a group in the underlying database.

func (*Handler) DeleteUser

func (h *Handler) DeleteUser(ctx context.Context, req *idm.DeleteUserRequest, response *idm.DeleteUserResponse) error

DeleteUser from database

func (*Handler) SearchUser

func (h *Handler) SearchUser(ctx context.Context, request *idm.SearchUserRequest, response idm.UserService_SearchUserStream) error

SearchUser in database

func (*Handler) StreamUser

func (h *Handler) StreamUser(ctx context.Context, streamer idm.UserService_StreamUserStream) error

StreamUser from database

type RolesCleaner

type RolesCleaner struct {
	Dao user.DAO
}

RolesCleaner listen for roles deletion and clear the users accordingly

func (*RolesCleaner) Handle

func (c *RolesCleaner) Handle(ctx context.Context, msg *idm.ChangeEvent) error