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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*-
* ============LICENSE_START=======================================================
* ONAP CLAMP
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights
* reserved.
* ================================================================================
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.policy.clamp.authorization;
/**
* Permission class that can be instantiated easily using constructor or factory
* methods.
*/
public class SecureServicePermission {
public static final String ALL = "*";
private String type;
private String instance;
private String action;
/**
* Factory method to create permission given type, instance, and action.
*
* @param type type of the permission
* @param instance instance of the permission
* @param action action of the permission
* @return instance of SecureServicePermission with type, instance and action
*/
public static SecureServicePermission create(String type, String instance, String action) {
return new SecureServicePermission(type, instance, action);
}
/**
* Factory method to create permission given type and instance. Default
* action to ALL/*.
*
* @param type type of the permission
* @param instance instance of the permission
* @return instance of SecureServicePermission with type, instance and default action
*/
public static SecureServicePermission create(String type, String instance) {
return new SecureServicePermission(type, instance, ALL);
}
/**
* Factory method to create permission given type. Default instance and
* action to ALL/*.
*
* @param type type of the permission
* @return instance of SecureServicePermission with type and default instance and action
*/
public static SecureServicePermission create(String type) {
return new SecureServicePermission(type, ALL, ALL);
}
/**
* Instantiate permission given type, instance, and action.
*
* @param type type of the permission
* @param instance instance of the permission
* @param action action of the permission
*/
public SecureServicePermission(String type, String instance, String action) {
this.type = type;
this.instance = instance;
this.action = action;
}
/**
* Instantiate permission given type from concatenated string.
*
* @param concatenatedString
* the string type|instance|action, less than 3 params can be
* provided (e.g. "permission-type-cl", "permission-type-cl|dev",
* "permission-type-cl|dev|update" )
*/
public SecureServicePermission(String concatenatedString) {
String[] userInfo = concatenatedString.split("[|]");
// We should have at least 1 string
this.type = userInfo[0];
this.instance = (userInfo.length > 1 ? userInfo[1] : ALL);
this.action = (userInfo.length > 2 ? userInfo[2] : ALL);
}
/**
* Override toString - return permission in key format.
*/
@Override
public String toString() {
return getKey();
}
/**
* Return Permission in Key format = type, instance, and action separate by
* pipe character.
*
* @return permission in key format
*/
public String getKey() {
return type + "|" + instance + "|" + action;
}
/**
* Return Permission in Key format = type, all instance, and action separate
* by pipe character.
*
* @return permission in key format
*/
public String getKeyAllInstance() {
return type + "|" + ALL + "|" + action;
}
/**
* Return Permission in Key format = type, all instance, and all action
* separate by pipe character.
*
* @return permission in key format
*/
public String getKeyAllInstanceAction() {
return type + "|" + ALL + "|" + ALL;
}
/**
* Return Permission in Key format = type, instance, and all action separate
* by pipe character.
*
* @return permission in key format
*/
public String getKeyAllAction() {
return type + "|" + instance + "|" + ALL;
}
/**
* Returns the permission type.
*
* @return the type
*/
public String getType() {
return type;
}
/**
* Sets the type of permission.
*
* @param type the type to set
*/
public void setType(String type) {
this.type = type;
}
/**
* Returns the instance of permission.
*
* @return the instance
*/
public String getInstance() {
return instance;
}
/**
* Sets the instance of permission.
*
* @param instance the instance to set
*/
public void setInstance(String instance) {
this.instance = instance;
}
/**
* Returns the action of permission.
*
* @return the action
*/
public String getAction() {
return action;
}
/**
* Sets the action of permission.
*
* @param action the action to set
*/
public void setAction(String action) {
this.action = action;
}
}
|
