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

     1  // Copyright 2018-2020 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 datatx
    20  
    21  import (
    22  	"context"
    23  
    24  	datatx "github.com/cs3org/go-cs3apis/cs3/tx/v1beta1"
    25  )
    26  
    27  // Manager the interface any transfer driver should implement
    28  type Manager interface {
    29  	// StartTransfer initiates a transfer job and returns a TxInfo object including a unique transfer id, and error if any.
    30  	StartTransfer(ctx context.Context, srcRemote string, srcPath string, srcToken string, destRemote string, destPath string, destToken string) (*datatx.TxInfo, error)
    31  	// GetTransferStatus returns a TxInfo object including the current status, and error if any.
    32  	GetTransferStatus(ctx context.Context, transferID string) (*datatx.TxInfo, error)
    33  	// CancelTransfer cancels the transfer and returns a TxInfo object and error if any.
    34  	CancelTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
    35  	// RetryTransfer retries the transfer and returns a TxInfo object and error if any.
    36  	// Note that tokens must still be valid.
    37  	RetryTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
    38  }