github.com/cs3org/reva/v2@v2.27.7/pkg/ocm/provider/provider.go (about)

     1  // Copyright 2018-2023 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package provider
    20  
    21  import (
    22  	"context"
    23  
    24  	ocmprovider "github.com/cs3org/go-cs3apis/cs3/ocm/provider/v1beta1"
    25  )
    26  
    27  // Authorizer provides provisions to verify and add sync'n'share system providers.
    28  type Authorizer interface {
    29  	// GetInfoByDomain returns the information of the provider identified by a specific domain.
    30  	GetInfoByDomain(ctx context.Context, domain string) (*ocmprovider.ProviderInfo, error)
    31  
    32  	// IsProviderAllowed checks if a given system provider is integrated into the OCM or not.
    33  	IsProviderAllowed(ctx context.Context, provider *ocmprovider.ProviderInfo) error
    34  
    35  	// ListAllProviders returns the information of all the providers registered in the mesh.
    36  	ListAllProviders(ctx context.Context) ([]*ocmprovider.ProviderInfo, error)
    37  }