11/*
22 * 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.
1513 */
14+
1615package io .adminshell .aas .v3 .model ;
1716
18- import io .adminshell .aas .v3 .model .annotations .KnownSubtypes ;
19- import io .adminshell .aas .v3 .model .annotations .IRI ;
2017import java .util .List ;
2118
19+
20+
21+ import io .adminshell .aas .v3 .model .annotations .IRI ;
22+ import io .adminshell .aas .v3 .model .annotations .KnownSubtypes ;
2223import io .adminshell .aas .v3 .model .builder .*;
2324import io .adminshell .aas .v3 .model .impl .*;
2425
2526/**
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.
2829 */
2930@ KnownSubtypes ({
3031 @ KnownSubtypes .Type (value = DefaultAccessControl .class )
3132})
3233public interface AccessControl {
3334
3435 /**
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.
3738 *
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
4040 *
41- * @return Returns the List of AccessPermissionRules for the property
42- * accessPermissionRules.
41+ * @return Returns the List of AccessPermissionRules for the property accessPermissionRules.
4342 */
4443 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule" )
4544 List <AccessPermissionRule > getAccessPermissionRules ();
4645
4746 /**
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.
5049 *
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
5351 *
54- * @param accessPermissionRules desired value for the property
55- * accessPermissionRules.
52+ * @param accessPermissionRules desired value for the property accessPermissionRules.
5653 */
5754 void setAccessPermissionRules (List <AccessPermissionRule > accessPermissionRules );
5855
5956 /**
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.
6359 *
64- * Default: reference to the submodel referenced via
65- * defaultSubjectAttributes.
60+ * Default: reference to the submodel referenced via defaultSubjectAttributes.
6661 *
6762 * More information under
6863 * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
6964 *
70- * @return Returns the Reference for the property
71- * selectableSubjectAttributes.
65+ * @return Returns the Reference for the property selectableSubjectAttributes.
7266 */
7367 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes" )
7468 Reference getSelectableSubjectAttributes ();
7569
7670 /**
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.
8073 *
81- * Default: reference to the submodel referenced via
82- * defaultSubjectAttributes.
74+ * Default: reference to the submodel referenced via defaultSubjectAttributes.
8375 *
8476 * More information under
8577 * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
8678 *
87- * @param selectableSubjectAttributes desired value for the property
88- * selectableSubjectAttributes.
79+ * @param selectableSubjectAttributes desired value for the property selectableSubjectAttributes.
8980 */
9081 void setSelectableSubjectAttributes (Reference selectableSubjectAttributes );
9182
9283 /**
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.
9586 *
9687 * The submodel is of kind=Type.
9788 *
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
10090 *
10191 * @return Returns the Reference for the property defaultSubjectAttributes.
10292 */
10393 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes" )
10494 Reference getDefaultSubjectAttributes ();
10595
10696 /**
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.
10999 *
110100 * The submodel is of kind=Type.
111101 *
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
114103 *
115- * @param defaultSubjectAttributes desired value for the property
116- * defaultSubjectAttributes.
104+ * @param defaultSubjectAttributes desired value for the property defaultSubjectAttributes.
117105 */
118106 void setDefaultSubjectAttributes (Reference defaultSubjectAttributes );
119107
120108 /**
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.
123110 *
124111 * Default: reference to the submodel referenced via defaultPermissions
125112 *
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
128114 *
129115 * @return Returns the Reference for the property selectablePermissions.
130116 */
131117 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions" )
132118 Reference getSelectablePermissions ();
133119
134120 /**
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.
137122 *
138123 * Default: reference to the submodel referenced via defaultPermissions
139124 *
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
142126 *
143- * @param selectablePermissions desired value for the property
144- * selectablePermissions.
127+ * @param selectablePermissions desired value for the property selectablePermissions.
145128 */
146129 void setSelectablePermissions (Reference selectablePermissions );
147130
148131 /**
149132 * Reference to a submodel defining the default permissions for the AAS.
150133 *
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
153135 *
154136 * @return Returns the Reference for the property defaultPermissions.
155137 */
@@ -159,67 +141,60 @@ public interface AccessControl {
159141 /**
160142 * Reference to a submodel defining the default permissions for the AAS.
161143 *
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
164145 *
165- * @param defaultPermissions desired value for the property
166- * defaultPermissions.
146+ * @param defaultPermissions desired value for the property defaultPermissions.
167147 */
168148 void setDefaultPermissions (Reference defaultPermissions );
169149
170150 /**
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.
173153 *
174154 * More information under
175155 * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
176156 *
177- * @return Returns the Reference for the property
178- * selectableEnvironmentAttributes.
157+ * @return Returns the Reference for the property selectableEnvironmentAttributes.
179158 */
180159 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes" )
181160 Reference getSelectableEnvironmentAttributes ();
182161
183162 /**
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.
186165 *
187166 * More information under
188167 * https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
189168 *
190169 * @param selectableEnvironmentAttributes desired value for the property
191- * selectableEnvironmentAttributes.
170+ * selectableEnvironmentAttributes.
192171 */
193172 void setSelectableEnvironmentAttributes (Reference selectableEnvironmentAttributes );
194173
195174 /**
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.
201179 *
202180 * More information under
203181 * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
204182 *
205- * @return Returns the Reference for the property
206- * defaultEnvironmentAttributes.
183+ * @return Returns the Reference for the property defaultEnvironmentAttributes.
207184 */
208185 @ IRI ("https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes" )
209186 Reference getDefaultEnvironmentAttributes ();
210187
211188 /**
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.
217193 *
218194 * More information under
219195 * https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
220196 *
221- * @param defaultEnvironmentAttributes desired value for the property
222- * defaultEnvironmentAttributes.
197+ * @param defaultEnvironmentAttributes desired value for the property defaultEnvironmentAttributes.
223198 */
224199 void setDefaultEnvironmentAttributes (Reference defaultEnvironmentAttributes );
225200
0 commit comments