/
SecurityRequirement.java
128 lines (115 loc) · 4.71 KB
/
SecurityRequirement.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
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
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* Copyright 2017 SmartBear Software
* <p>
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
*/
package org.eclipse.microprofile.openapi.models.security;
import java.util.List;
import java.util.Map;
import org.eclipse.microprofile.openapi.models.Constructible;
/**
* SecurityRequirement
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
* Object</a>
*/
public interface SecurityRequirement extends Constructible {
/**
* Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scope (optional)
* provided.
*
* @param securitySchemeName
* the name of security scheme declared in the Components section of the OpenAPI document
* @param scope
* a required scope - only valid when the defined scheme's type is 'oauth2' or 'openIdConnect'. passing
* null will result in an empty list of scopes
* @return Updated SecurityRequirement instance
*/
SecurityRequirement addScheme(String securitySchemeName, String scope);
/**
* Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scopes
* (optional) provided.
*
* @param securitySchemeName
* the name of security scheme declared in the Components section of the OpenAPI document
* @param scopes
* the scopes required - only valid when the defined scheme is 'oauth2' or 'openIdConnect'. passing null
* will result in an empty list of scopes
* @return Updated SecurityRequirement instance
*/
SecurityRequirement addScheme(String securitySchemeName, List<String> scopes);
/**
* Adds a security scheme to the SecurityRequirement instance based on the scheme name. No scopes are included,
* resulting in an empty list of scopes for the security scheme. This is valid when the defined security scheme is
* not 'oauth2' or 'openIdConnect'.
*
* @param securitySchemeName
* the name of security scheme declared in the Components section of the OpenAPI document
* @return Updated SecurityRequirement instance
*/
SecurityRequirement addScheme(String securitySchemeName);
/**
* Removes a security scheme to the SecurityRequirement instance based on the scheme name.
*
* @param securitySchemeName
* the name of security scheme
*/
void removeScheme(String securitySchemeName);
/**
* Returns a copy map (potentially immutable) of the schemes.
*
* @return all items
*/
Map<String, List<String>> getSchemes();
/**
* Set all security schemes to the SecurityRequirement instance. Keys are the name of security scheme declared in
* the Components section of the OpenAPI document, values are a list of required scope - only valid when the defined
* scheme is 'oauth2' or 'openIdConnect'
*
* @param items
* a map containing the security schemes.
*/
void setSchemes(Map<String, List<String>> items);
/**
* Check whether a scheme is present in the map. This is a convenience method for
* <code>getSchemes().containsKey(name)</code>
*
* @param securitySchemeName
* the name of security scheme
* @return a boolean to indicate if the scheme is present or not.
*/
default boolean hasScheme(String securitySchemeName) {
Map<String, List<String>> map = getSchemes();
if (map == null) {
return false;
}
return map.containsKey(securitySchemeName);
}
/**
* Returns a list of scopes for a given scheme name. This is a convenience method for
* <code>getSchemes().get(name)</code>
*
* @param securitySchemeName
* the name of security scheme
* @return a list of scopes or null.
*/
default List<String> getScheme(String securitySchemeName) {
Map<String, List<String>> map = getSchemes();
if (map == null) {
return null;
}
return map.get(securitySchemeName);
}
}