-
Notifications
You must be signed in to change notification settings - Fork 219
/
PolicyImport.java
83 lines (73 loc) · 2.83 KB
/
PolicyImport.java
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
/*
* Copyright (c) 2022 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.policies.model;
import java.util.Optional;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.json.JsonField;
import org.eclipse.ditto.json.JsonFieldSelector;
import org.eclipse.ditto.json.JsonObject;
/**
* Represents a single import of another {@link Policy} based on its {@code policyId} and {@link EffectedImports}
* containing optional includes and excludes.
*
* @since 3.x.0 TODO ditto#298
*/
public interface PolicyImport extends Jsonifiable.WithFieldSelectorAndPredicate<JsonField> {
/**
* Returns a new {@code PolicyImport} with the specified {@code resourceKey} and {@code effectedPermissions}.
*
* @param importedPolicyId the {@link PolicyId} of the imported policy.
* @param effectedImports the EffectedImports of the new PolicyImport to create.
* @return the new {@code PolicyImport}.
* @throws NullPointerException if any argument is {@code null}.
*/
static PolicyImport newInstance(final PolicyId importedPolicyId, final EffectedImports effectedImports) {
return PoliciesModelFactory.newPolicyImport(importedPolicyId, effectedImports);
}
/**
* Subject is only available in JsonSchemaVersion V_2.
*
* @return the supported JsonSchemaVersions of Subject.
*/
@Override
default JsonSchemaVersion[] getSupportedSchemaVersions() {
return new JsonSchemaVersion[]{JsonSchemaVersion.V_2};
}
/**
* Returns the Policy ID of the Policy to import.
*
* @return the Policy ID of the Policy to import.
*/
PolicyId getImportedPolicyId();
/**
* Returns the optional {@link EffectedImports} (containing included and excluded ones) for this PolicyImport.
*
* @return the effected imported entries.
*/
Optional<EffectedImports> getEffectedImports();
/**
* Returns all non hidden marked fields of this PolicyImport.
*
* @return a JSON object representation of this PolicyImport including only non hidden marked fields.
*/
@Override
default JsonObject toJson() {
return toJson(FieldType.notHidden());
}
@Override
default JsonObject toJson(final JsonSchemaVersion schemaVersion, final JsonFieldSelector fieldSelector) {
return toJson(schemaVersion, FieldType.regularOrSpecial()).get(fieldSelector);
}
}