-
Notifications
You must be signed in to change notification settings - Fork 113
/
datatx.go
61 lines (55 loc) · 2.57 KB
/
datatx.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// Copyright 2018-2024 CERN
//
// 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.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
package datatx
import (
"context"
userv1beta1 "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
datatx "github.com/cs3org/go-cs3apis/cs3/tx/v1beta1"
)
// Manager the interface any transfer driver should implement.
type Manager interface {
// CreateTransfer creates a transfer job and returns a TxInfo object that includes a unique transfer id.
// Specified target URIs are of form scheme://userinfo@host:port?name={path}
CreateTransfer(ctx context.Context, srcTargetURI string, dstTargetURI string) (*datatx.TxInfo, error)
// GetTransferStatus returns a TxInfo object including the current status, and error if any.
GetTransferStatus(ctx context.Context, transferID string) (*datatx.TxInfo, error)
// CancelTransfer cancels the transfer and returns a TxInfo object and error if any.
CancelTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
// RetryTransfer retries the transfer and returns a TxInfo object and error if any.
// Note that tokens must still be valid.
RetryTransfer(ctx context.Context, transferID string) (*datatx.TxInfo, error)
}
// Transfer represents datatx transfer.
type Transfer struct {
TxID string
SrcTargetURI string
DestTargetURI string
ShareID string
UserID *userv1beta1.UserId
}
// Repository the interface that any storage driver should implement.
type Repository interface {
// StoreTransfer stores the transfer by its TxID
StoreTransfer(transfer *Transfer) error
// StoreTransfer deletes the transfer by its TxID
DeleteTransfer(transfer *Transfer) error
// GetTransfer returns the transfer with the specified transfer id
GetTransfer(txID string) (*Transfer, error)
// ListTransfers returns a filtered list of transfers
ListTransfers(Filters []*datatx.ListTransfersRequest_Filter, UserID *userv1beta1.UserId) ([]*Transfer, error)
}