mirror of
https://github.com/harness/drone.git
synced 2025-07-21 18:00:20 +00:00
51 lines
1.5 KiB
Go
51 lines
1.5 KiB
Go
// Copyright 2023 Harness, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package publicaccess
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/harness/gitness/types/enum"
|
|
)
|
|
|
|
// Service is an abstraction of an entity responsible for managing public access to resources.
|
|
type Service interface {
|
|
/*
|
|
* Get returns whether public access is enabled on the resource.
|
|
* Returns
|
|
* (true, nil) - public access to the resource is allowed
|
|
* (false, nil) - public access to the resource is not allowed
|
|
* (false, err) - an error occurred while performing public access check.
|
|
*/
|
|
Get(
|
|
ctx context.Context,
|
|
resourceType enum.PublicResourceType,
|
|
resourcePath string,
|
|
) (bool, error)
|
|
|
|
/*
|
|
* Sets or deletes public access mode for the resource based on the value of 'enable'.
|
|
* Returns
|
|
* nil - resource public access mode has been updated successfully
|
|
* err - an error occurred while performing public access set.
|
|
*/
|
|
Set(
|
|
ctx context.Context,
|
|
resourceType enum.PublicResourceType,
|
|
resourcePath string,
|
|
enable bool,
|
|
) error
|
|
}
|