Documentation
¶
Index ¶
- Constants
- func NewAccessControlServiceHandler(svc AccessControlServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type AccessControlServiceClient
- type AccessControlServiceHandler
- type UnimplementedAccessControlServiceHandler
- func (UnimplementedAccessControlServiceHandler) Authorize(context.Context, *connect.Request[v1.AuthorizeRequest]) (*connect.Response[v1.AuthorizeResponse], error)
- func (UnimplementedAccessControlServiceHandler) CheckAccess(context.Context, *connect.Request[v1.CheckAccessRequest]) (*connect.Response[v1.CheckAccessResponse], error)
Constants ¶
const ( // AccessControlServiceCheckAccessProcedure is the fully-qualified name of the // AccessControlService's CheckAccess RPC. AccessControlServiceCheckAccessProcedure = "/accesscontrol.v1.AccessControlService/CheckAccess" // AccessControlServiceAuthorizeProcedure is the fully-qualified name of the AccessControlService's // Authorize RPC. AccessControlServiceAuthorizeProcedure = "/accesscontrol.v1.AccessControlService/Authorize" )
These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.
const (
// AccessControlServiceName is the fully-qualified name of the AccessControlService service.
AccessControlServiceName = "accesscontrol.v1.AccessControlService"
)
Variables ¶
This section is empty.
Functions ¶
func NewAccessControlServiceHandler ¶
func NewAccessControlServiceHandler(svc AccessControlServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewAccessControlServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.
By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.
Types ¶
type AccessControlServiceClient ¶
type AccessControlServiceClient interface {
// Decides whether the requester may resolve the queried secrets.
// Called for every GetSecrets request.
CheckAccess(context.Context, *connect.Request[v1.CheckAccessRequest]) (*connect.Response[v1.CheckAccessResponse], error)
// Preflight: authorizes the requester ahead of use, valid until the
// returned expiry.
Authorize(context.Context, *connect.Request[v1.AuthorizeRequest]) (*connect.Response[v1.AuthorizeResponse], error)
}
AccessControlServiceClient is a client for the accesscontrol.v1.AccessControlService service.
func NewAccessControlServiceClient ¶
func NewAccessControlServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AccessControlServiceClient
NewAccessControlServiceClient constructs a client for the accesscontrol.v1.AccessControlService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.
The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).
type AccessControlServiceHandler ¶
type AccessControlServiceHandler interface {
// Decides whether the requester may resolve the queried secrets.
// Called for every GetSecrets request.
CheckAccess(context.Context, *connect.Request[v1.CheckAccessRequest]) (*connect.Response[v1.CheckAccessResponse], error)
// Preflight: authorizes the requester ahead of use, valid until the
// returned expiry.
Authorize(context.Context, *connect.Request[v1.AuthorizeRequest]) (*connect.Response[v1.AuthorizeResponse], error)
}
AccessControlServiceHandler is an implementation of the accesscontrol.v1.AccessControlService service.
type UnimplementedAccessControlServiceHandler ¶
type UnimplementedAccessControlServiceHandler struct{}
UnimplementedAccessControlServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedAccessControlServiceHandler) Authorize ¶
func (UnimplementedAccessControlServiceHandler) Authorize(context.Context, *connect.Request[v1.AuthorizeRequest]) (*connect.Response[v1.AuthorizeResponse], error)
func (UnimplementedAccessControlServiceHandler) CheckAccess ¶
func (UnimplementedAccessControlServiceHandler) CheckAccess(context.Context, *connect.Request[v1.CheckAccessRequest]) (*connect.Response[v1.CheckAccessResponse], error)
Source Files