1
1
/*
2
2
* Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5
+ * in compliance with the License. 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 distributed under the License
10
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11
+ * or implied. See the License for the specific language governing permissions and limitations under
12
+ * the License.
15
13
*/
14
+
16
15
package io .adminshell .aas .v3 .model ;
17
16
18
- import io .adminshell .aas .v3 .model .annotations .KnownSubtypes ;
19
- import io .adminshell .aas .v3 .model .annotations .IRI ;
20
17
import java .util .List ;
21
18
19
+
20
+
21
+ import io .adminshell .aas .v3 .model .annotations .IRI ;
22
+ import io .adminshell .aas .v3 .model .annotations .KnownSubtypes ;
22
23
import io .adminshell .aas .v3 .model .builder .*;
23
24
import io .adminshell .aas .v3 .model .impl .*;
24
25
25
26
/**
26
- * Access Control defines the local access control policy administration point.
27
- * Access Control has the major task to define the access permission rules.
27
+ * Access Control defines the local access control policy administration point. Access Control has
28
+ * the major task to define the access permission rules.
28
29
*/
29
30
@ KnownSubtypes ({
30
31
@ KnownSubtypes .Type (value = DefaultAccessControl .class )
31
32
})
32
33
public interface AccessControl {
33
34
34
35
/**
35
- * Access permission rules of the AAS describing the rights assigned to
36
- * (already authenticated) subjects to access elements of the AAS.
36
+ * Access permission rules of the AAS describing the rights assigned to (already authenticated)
37
+ * subjects to access elements of the AAS.
37
38
*
38
- * More information under
39
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
39
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
40
40
*
41
- * @return Returns the List of AccessPermissionRules for the property
42
- * accessPermissionRules.
41
+ * @return Returns the List of AccessPermissionRules for the property accessPermissionRules.
43
42
*/
44
43
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule" )
45
44
List <AccessPermissionRule > getAccessPermissionRules ();
46
45
47
46
/**
48
- * Access permission rules of the AAS describing the rights assigned to
49
- * (already authenticated) subjects to access elements of the AAS.
47
+ * Access permission rules of the AAS describing the rights assigned to (already authenticated)
48
+ * subjects to access elements of the AAS.
50
49
*
51
- * More information under
52
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
50
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
53
51
*
54
- * @param accessPermissionRules desired value for the property
55
- * accessPermissionRules.
52
+ * @param accessPermissionRules desired value for the property accessPermissionRules.
56
53
*/
57
54
void setAccessPermissionRules (List <AccessPermissionRule > accessPermissionRules );
58
55
59
56
/**
60
- * Reference to a submodel defining the authenticated subjects that are
61
- * configured for the AAS. They are selectable by the access permission
62
- * rules to assign permissions to the subjects.
57
+ * Reference to a submodel defining the authenticated subjects that are configured for the AAS. They
58
+ * are selectable by the access permission rules to assign permissions to the subjects.
63
59
*
64
- * Default: reference to the submodel referenced via
65
- * defaultSubjectAttributes.
60
+ * Default: reference to the submodel referenced via defaultSubjectAttributes.
66
61
*
67
62
* More information under
68
63
* https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
69
64
*
70
- * @return Returns the Reference for the property
71
- * selectableSubjectAttributes.
65
+ * @return Returns the Reference for the property selectableSubjectAttributes.
72
66
*/
73
67
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes" )
74
68
Reference getSelectableSubjectAttributes ();
75
69
76
70
/**
77
- * Reference to a submodel defining the authenticated subjects that are
78
- * configured for the AAS. They are selectable by the access permission
79
- * rules to assign permissions to the subjects.
71
+ * Reference to a submodel defining the authenticated subjects that are configured for the AAS. They
72
+ * are selectable by the access permission rules to assign permissions to the subjects.
80
73
*
81
- * Default: reference to the submodel referenced via
82
- * defaultSubjectAttributes.
74
+ * Default: reference to the submodel referenced via defaultSubjectAttributes.
83
75
*
84
76
* More information under
85
77
* https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
86
78
*
87
- * @param selectableSubjectAttributes desired value for the property
88
- * selectableSubjectAttributes.
79
+ * @param selectableSubjectAttributes desired value for the property selectableSubjectAttributes.
89
80
*/
90
81
void setSelectableSubjectAttributes (Reference selectableSubjectAttributes );
91
82
92
83
/**
93
- * Reference to a submodel defining the default subjects attributes for the
94
- * AAS that can be used to describe access permission rules.
84
+ * Reference to a submodel defining the default subjects attributes for the AAS that can be used to
85
+ * describe access permission rules.
95
86
*
96
87
* The submodel is of kind=Type.
97
88
*
98
- * More information under
99
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
89
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
100
90
*
101
91
* @return Returns the Reference for the property defaultSubjectAttributes.
102
92
*/
103
93
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes" )
104
94
Reference getDefaultSubjectAttributes ();
105
95
106
96
/**
107
- * Reference to a submodel defining the default subjects attributes for the
108
- * AAS that can be used to describe access permission rules.
97
+ * Reference to a submodel defining the default subjects attributes for the AAS that can be used to
98
+ * describe access permission rules.
109
99
*
110
100
* The submodel is of kind=Type.
111
101
*
112
- * More information under
113
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
102
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
114
103
*
115
- * @param defaultSubjectAttributes desired value for the property
116
- * defaultSubjectAttributes.
104
+ * @param defaultSubjectAttributes desired value for the property defaultSubjectAttributes.
117
105
*/
118
106
void setDefaultSubjectAttributes (Reference defaultSubjectAttributes );
119
107
120
108
/**
121
- * Reference to a submodel defining which permissions can be assigned to the
122
- * subjects.
109
+ * Reference to a submodel defining which permissions can be assigned to the subjects.
123
110
*
124
111
* Default: reference to the submodel referenced via defaultPermissions
125
112
*
126
- * More information under
127
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
113
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
128
114
*
129
115
* @return Returns the Reference for the property selectablePermissions.
130
116
*/
131
117
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions" )
132
118
Reference getSelectablePermissions ();
133
119
134
120
/**
135
- * Reference to a submodel defining which permissions can be assigned to the
136
- * subjects.
121
+ * Reference to a submodel defining which permissions can be assigned to the subjects.
137
122
*
138
123
* Default: reference to the submodel referenced via defaultPermissions
139
124
*
140
- * More information under
141
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
125
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
142
126
*
143
- * @param selectablePermissions desired value for the property
144
- * selectablePermissions.
127
+ * @param selectablePermissions desired value for the property selectablePermissions.
145
128
*/
146
129
void setSelectablePermissions (Reference selectablePermissions );
147
130
148
131
/**
149
132
* Reference to a submodel defining the default permissions for the AAS.
150
133
*
151
- * More information under
152
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
134
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
153
135
*
154
136
* @return Returns the Reference for the property defaultPermissions.
155
137
*/
@@ -159,67 +141,60 @@ public interface AccessControl {
159
141
/**
160
142
* Reference to a submodel defining the default permissions for the AAS.
161
143
*
162
- * More information under
163
- * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
144
+ * More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
164
145
*
165
- * @param defaultPermissions desired value for the property
166
- * defaultPermissions.
146
+ * @param defaultPermissions desired value for the property defaultPermissions.
167
147
*/
168
148
void setDefaultPermissions (Reference defaultPermissions );
169
149
170
150
/**
171
- * Reference to a submodel defining which environment attributes can be
172
- * accessed via the permission rules.
151
+ * Reference to a submodel defining which environment attributes can be accessed via the permission
152
+ * rules.
173
153
*
174
154
* More information under
175
155
* https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
176
156
*
177
- * @return Returns the Reference for the property
178
- * selectableEnvironmentAttributes.
157
+ * @return Returns the Reference for the property selectableEnvironmentAttributes.
179
158
*/
180
159
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes" )
181
160
Reference getSelectableEnvironmentAttributes ();
182
161
183
162
/**
184
- * Reference to a submodel defining which environment attributes can be
185
- * accessed via the permission rules.
163
+ * Reference to a submodel defining which environment attributes can be accessed via the permission
164
+ * rules.
186
165
*
187
166
* More information under
188
167
* https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
189
168
*
190
169
* @param selectableEnvironmentAttributes desired value for the property
191
- * selectableEnvironmentAttributes.
170
+ * selectableEnvironmentAttributes.
192
171
*/
193
172
void setSelectableEnvironmentAttributes (Reference selectableEnvironmentAttributes );
194
173
195
174
/**
196
- * Reference to a submodel defining default environment attributes, i.e.
197
- * attributes that are not describing the asset itself. The submodel is of
198
- * kind=Type. At the same type the values of these environment attributes
199
- * need to be accessible when evaluating the access permission rules. This
200
- * is realized as a policy information point.
175
+ * Reference to a submodel defining default environment attributes, i.e. attributes that are not
176
+ * describing the asset itself. The submodel is of kind=Type. At the same type the values of these
177
+ * environment attributes need to be accessible when evaluating the access permission rules. This is
178
+ * realized as a policy information point.
201
179
*
202
180
* More information under
203
181
* https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
204
182
*
205
- * @return Returns the Reference for the property
206
- * defaultEnvironmentAttributes.
183
+ * @return Returns the Reference for the property defaultEnvironmentAttributes.
207
184
*/
208
185
@ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes" )
209
186
Reference getDefaultEnvironmentAttributes ();
210
187
211
188
/**
212
- * Reference to a submodel defining default environment attributes, i.e.
213
- * attributes that are not describing the asset itself. The submodel is of
214
- * kind=Type. At the same type the values of these environment attributes
215
- * need to be accessible when evaluating the access permission rules. This
216
- * is realized as a policy information point.
189
+ * Reference to a submodel defining default environment attributes, i.e. attributes that are not
190
+ * describing the asset itself. The submodel is of kind=Type. At the same type the values of these
191
+ * environment attributes need to be accessible when evaluating the access permission rules. This is
192
+ * realized as a policy information point.
217
193
*
218
194
* More information under
219
195
* https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
220
196
*
221
- * @param defaultEnvironmentAttributes desired value for the property
222
- * defaultEnvironmentAttributes.
197
+ * @param defaultEnvironmentAttributes desired value for the property defaultEnvironmentAttributes.
223
198
*/
224
199
void setDefaultEnvironmentAttributes (Reference defaultEnvironmentAttributes );
225
200
0 commit comments