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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\OCM;
use JsonSerializable;
use OCP\OCM\Exceptions\OCMArgumentException;
use OCP\OCM\Exceptions\OCMProviderException;
/**
* Model based on the Open Cloud Mesh Discovery API
* @link https://github.com/cs3org/OCM-API/
* @since 28.0.0
*/
interface IOCMProvider extends JsonSerializable {
/**
* enable OCM
*
* @param bool $enabled
*
* @return $this
* @since 28.0.0
*/
public function setEnabled(bool $enabled): static;
/**
* is set as enabled ?
*
* @return bool
* @since 28.0.0
*/
public function isEnabled(): bool;
/**
* get set API Version
*
* @param string $apiVersion
*
* @return $this
* @since 28.0.0
*/
public function setApiVersion(string $apiVersion): static;
/**
* returns API version
*
* @return string
* @since 28.0.0
*/
public function getApiVersion(): string;
/**
* configure endpoint
*
* @param string $endPoint
*
* @return $this
* @since 28.0.0
*/
public function setEndPoint(string $endPoint): static;
/**
* get configured endpoint
*
* @return string
* @since 28.0.0
*/
public function getEndPoint(): string;
/**
* create a new resource to later add it with {@see addResourceType()}
* @return IOCMResource
* @since 28.0.0
*/
public function createNewResourceType(): IOCMResource;
/**
* add a single resource to the object
*
* @param IOCMResource $resource
*
* @return $this
* @since 28.0.0
*/
public function addResourceType(IOCMResource $resource): static;
/**
* set resources
*
* @param IOCMResource[] $resourceTypes
*
* @return $this
* @since 28.0.0
*/
public function setResourceTypes(array $resourceTypes): static;
/**
* get all set resources
*
* @return IOCMResource[]
* @since 28.0.0
*/
public function getResourceTypes(): array;
/**
* extract a specific string value from the listing of protocols, based on resource-name and protocol-name
*
* @param string $resourceName
* @param string $protocol
*
* @return string
* @throws OCMArgumentException
* @since 28.0.0
*/
public function extractProtocolEntry(string $resourceName, string $protocol): string;
/**
* import data from an array
*
* @param array<string, int|string|bool|array> $data
*
* @return $this
* @throws OCMProviderException in case a descent provider cannot be generated from data
* @since 28.0.0
*/
public function import(array $data): static;
/**
* @return array{
* enabled: bool,
* apiVersion: string,
* endPoint: string,
* resourceTypes: array{
* name: string,
* shareTypes: string[],
* protocols: array<string, string>
* }[]
* }
* @since 28.0.0
*/
public function jsonSerialize(): array;
}
|
