Skip to content

Commit 206a1d0

Browse files
tulinkrytulinkry
committed
renaming AuthorizationRole -> AuthControlFlag
1 parent f8b9276 commit 206a1d0

File tree

5 files changed

+63
-63
lines changed

5 files changed

+63
-63
lines changed

‎src/org/opensolaris/opengrok/authorization/AuthorizationCheck.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public class AuthorizationCheck implements Serializable {
3737
/**
3838
* Enum for avaliable authorization roles.
3939
*/
40-
public enum AuthorizationRole {
40+
public enum AuthControlFlag {
4141
/**
4242
* Failure of such a plugin will ultimately lead to the authorization
4343
* framework returning failure but only after the remaining plugins have
@@ -64,7 +64,7 @@ public enum AuthorizationRole {
6464

6565
private final String role;
6666

67-
private AuthorizationRole(String role) {
67+
private AuthControlFlag(String role) {
6868
this.role = role;
6969
}
7070

@@ -73,17 +73,17 @@ public String toString() {
7373
return this.role;
7474
}
7575

76-
public static AuthorizationRole get(String role) {
76+
public static AuthControlFlag get(String role) {
7777
try {
78-
return AuthorizationRole.valueOf(role.toUpperCase());
78+
return AuthControlFlag.valueOf(role.toUpperCase());
7979
} catch (IllegalArgumentException ex) {
8080
// role does not exist -> add some more info about which roles do exist
8181
throw new IllegalArgumentException(
8282
String.format("No authorization role \"%s\", available roles are [%s]. %s",
8383
role,
84-
Arrays.asList(AuthorizationRole.values())
84+
Arrays.asList(AuthControlFlag.values())
8585
.stream()
86-
.map(AuthorizationRole::toString)
86+
.map(AuthControlFlag::toString)
8787
.collect(Collectors.joining(", ")),
8888
ex.getLocalizedMessage()), ex);
8989
}
@@ -93,7 +93,7 @@ public static AuthorizationRole get(String role) {
9393
/**
9494
* One of "required", "requisite", "sufficient".
9595
*/
96-
private AuthorizationRole role;
96+
private AuthControlFlag role;
9797

9898
/**
9999
* Canonical name of a java class.
@@ -103,7 +103,7 @@ public static AuthorizationRole get(String role) {
103103
public AuthorizationCheck() {
104104
}
105105

106-
public AuthorizationCheck(AuthorizationRole role, String classname) {
106+
public AuthorizationCheck(AuthControlFlag role, String classname) {
107107
this.role = role;
108108
this.classname = classname;
109109
}
@@ -131,7 +131,7 @@ public void setClassname(String classname) {
131131
*
132132
* @return the value of role
133133
*/
134-
public AuthorizationRole getRole() {
134+
public AuthControlFlag getRole() {
135135
return role;
136136
}
137137

@@ -140,7 +140,7 @@ public AuthorizationRole getRole() {
140140
*
141141
* @param role new value of role
142142
*/
143-
public void setRole(AuthorizationRole role) {
143+
public void setRole(AuthControlFlag role) {
144144
this.role = role;
145145
}
146146

@@ -150,6 +150,6 @@ public void setRole(AuthorizationRole role) {
150150
* @param role new value of role
151151
*/
152152
public void setRole(String role) {
153-
this.role = AuthorizationRole.get(role);
153+
this.role = AuthControlFlag.get(role);
154154
}
155155
}

‎src/org/opensolaris/opengrok/authorization/AuthorizationFramework.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
import java.util.logging.Level;
3838
import java.util.logging.Logger;
3939
import javax.servlet.http.HttpServletRequest;
40-
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthorizationRole;
40+
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthControlFlag;
4141
import org.opensolaris.opengrok.configuration.Configuration;
4242
import org.opensolaris.opengrok.configuration.Group;
4343
import org.opensolaris.opengrok.configuration.Nameable;
@@ -238,7 +238,7 @@ public AuthorizationPluginWrapper findPlugin(String classname) {
238238
* @param plugin the authorization plugin
239239
*/
240240
protected synchronized void addPlugin(IAuthorizationPlugin plugin) {
241-
addPlugin(plugin, AuthorizationRole.REQUIRED);
241+
addPlugin(plugin, AuthControlFlag.REQUIRED);
242242
}
243243

244244
/**
@@ -260,7 +260,7 @@ protected synchronized void addPlugin(IAuthorizationPlugin plugin) {
260260
* @param plugin the authorization plugin
261261
* @param role the role for the new plugins
262262
*/
263-
public synchronized void addPlugin(IAuthorizationPlugin plugin, AuthorizationRole role) {
263+
public synchronized void addPlugin(IAuthorizationPlugin plugin, AuthControlFlag role) {
264264
AuthorizationPluginWrapper wrapper;
265265
if ((wrapper = findPlugin(getClassName(plugin))) != null) {
266266
if (wrapper.hasPlugin()) {

‎src/org/opensolaris/opengrok/authorization/AuthorizationPluginWrapper.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
package org.opensolaris.opengrok.authorization;
2424

2525
import javax.servlet.http.HttpServletRequest;
26-
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthorizationRole;
26+
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthControlFlag;
2727
import org.opensolaris.opengrok.configuration.Group;
2828
import org.opensolaris.opengrok.configuration.Project;
2929

@@ -45,7 +45,7 @@ public AuthorizationPluginWrapper(AuthorizationCheck description, IAuthorization
4545
this.plugin = plugin;
4646
}
4747

48-
public AuthorizationPluginWrapper(AuthorizationRole role, String classname, IAuthorizationPlugin plugin) {
48+
public AuthorizationPluginWrapper(AuthControlFlag role, String classname, IAuthorizationPlugin plugin) {
4949
this(new AuthorizationCheck(role, classname), plugin);
5050
}
5151

@@ -100,7 +100,7 @@ public boolean hasPlugin() {
100100
* @return true if is required; false otherwise
101101
*/
102102
public boolean isRequired() {
103-
return check.getRole().equals(AuthorizationRole.REQUIRED);
103+
return check.getRole().equals(AuthControlFlag.REQUIRED);
104104
}
105105

106106
/**
@@ -109,7 +109,7 @@ public boolean isRequired() {
109109
* @return true if is sufficient; false otherwise
110110
*/
111111
public boolean isSufficient() {
112-
return check.getRole().equals(AuthorizationRole.SUFFICIENT);
112+
return check.getRole().equals(AuthControlFlag.SUFFICIENT);
113113
}
114114

115115
/**
@@ -118,7 +118,7 @@ public boolean isSufficient() {
118118
* @return true if is requisite; false otherwise
119119
*/
120120
public boolean isRequisite() {
121-
return check.getRole().equals(AuthorizationRole.REQUISITE);
121+
return check.getRole().equals(AuthControlFlag.REQUISITE);
122122
}
123123

124124
/**
@@ -209,7 +209,7 @@ public String getClassname() {
209209
*
210210
* @return the value of role
211211
*/
212-
public AuthorizationRole getRole() {
212+
public AuthControlFlag getRole() {
213213
return check.getRole();
214214
}
215215
}

‎test/org/opensolaris/opengrok/authorization/AuthorizationFrameworkTest.java

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import org.junit.Assert;
2828
import org.junit.BeforeClass;
2929
import org.junit.Test;
30-
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthorizationRole;
30+
import org.opensolaris.opengrok.authorization.AuthorizationCheck.AuthControlFlag;
3131
import org.opensolaris.opengrok.configuration.Group;
3232
import org.opensolaris.opengrok.configuration.Project;
3333
import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
@@ -53,8 +53,8 @@ public void test2Plugins() {
5353
@Test
5454
public void testRolePlugins() {
5555
AuthorizationFramework instance = getInstance();
56-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
57-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
56+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
57+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
5858

5959
// sufficient is ok
6060
Assert.assertTrue(instance.isAllowed(createRequest(), createUnallowedProject()));
@@ -67,8 +67,8 @@ public void testRolePlugins() {
6767
@Test
6868
public void testRolePlugins1() {
6969
AuthorizationFramework instance = getInstance();
70-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
71-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
70+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
71+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
7272

7373
// sufficient fails and required is ok
7474
Assert.assertTrue(instance.isAllowed(createRequest(), createUnallowedProject()));
@@ -81,8 +81,8 @@ public void testRolePlugins1() {
8181
@Test
8282
public void testRolePlugin2() {
8383
AuthorizationFramework instance = getInstance();
84-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
85-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
84+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
85+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
8686

8787
// all are sufficient - success
8888
Assert.assertTrue(instance.isAllowed(createRequest(), createUnallowedProject()));
@@ -94,8 +94,8 @@ public void testRolePlugin2() {
9494
@Test
9595
public void testRolePlugin3() {
9696
AuthorizationFramework instance = getInstance();
97-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
98-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
97+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
98+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
9999

100100
// required fails
101101
Assert.assertFalse(instance.isAllowed(createRequest(), createAllowedProject()));
@@ -108,8 +108,8 @@ public void testRolePlugin3() {
108108
@Test
109109
public void testRolePlugin4() {
110110
AuthorizationFramework instance = getInstance();
111-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
112-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
111+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
112+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
113113

114114
// same instance is not added twice in the plugins so
115115
// there is only one plugin set as sufficient thus everything is true
@@ -122,8 +122,8 @@ public void testRolePlugin4() {
122122
@Test
123123
public void testRolePlugin5() {
124124
AuthorizationFramework instance = getInstance();
125-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
126-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
125+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
126+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
127127

128128
// same instance is not added twice in the plugins so
129129
// there is only one plugin set as required
@@ -137,8 +137,8 @@ public void testRolePlugin5() {
137137
@Test
138138
public void testRolePlugin6() {
139139
AuthorizationFramework instance = getInstance();
140-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUISITE);
141-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
140+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUISITE);
141+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
142142

143143
// requisite is ok and the other plugin is sufficient
144144
Assert.assertTrue(instance.isAllowed(createRequest(), createAllowedProject()));
@@ -151,8 +151,8 @@ public void testRolePlugin6() {
151151
@Test
152152
public void testRolePlugin7() {
153153
AuthorizationFramework instance = getInstance();
154-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUISITE);
155-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
154+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUISITE);
155+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
156156

157157
// requisite is ok however required fails
158158
Assert.assertFalse(instance.isAllowed(createRequest(), createAllowedProject()));
@@ -164,8 +164,8 @@ public void testRolePlugin7() {
164164
@Test
165165
public void testRolePlugin8() {
166166
AuthorizationFramework instance = getInstance();
167-
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthorizationRole.REQUISITE);
168-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
167+
instance.addPlugin(createNotAllowedPrefixPlugin(), AuthControlFlag.REQUISITE);
168+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
169169

170170
// requisite fails
171171
Assert.assertFalse(instance.isAllowed(createRequest(), createAllowedProject()));
@@ -178,8 +178,8 @@ public void testRolePlugin8() {
178178
@Test
179179
public void testRolePlugins9() {
180180
AuthorizationFramework instance = getInstance();
181-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.SUFFICIENT);
182-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
181+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.SUFFICIENT);
182+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
183183
instance.loadAllPlugins();
184184

185185
// sufficient fails and required fails as well
@@ -193,8 +193,8 @@ public void testRolePlugins9() {
193193
@Test
194194
public void testRolePlugin10() {
195195
AuthorizationFramework instance = getInstance();
196-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.SUFFICIENT);
197-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
196+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.SUFFICIENT);
197+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
198198
instance.loadAllPlugins();
199199

200200
// all are sufficient - success
@@ -207,8 +207,8 @@ public void testRolePlugin10() {
207207
@Test
208208
public void testRolePlugin11() {
209209
AuthorizationFramework instance = getInstance();
210-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.REQUIRED);
211-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
210+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.REQUIRED);
211+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
212212
instance.loadAllPlugins();
213213

214214
// required load fails
@@ -221,8 +221,8 @@ public void testRolePlugin11() {
221221
@Test
222222
public void testRolePlugin12() {
223223
AuthorizationFramework instance = getInstance();
224-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.SUFFICIENT);
225-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.REQUIRED);
224+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.SUFFICIENT);
225+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.REQUIRED);
226226
instance.loadAllPlugins();
227227

228228
// same instance is not added twice in the plugins
@@ -236,8 +236,8 @@ public void testRolePlugin12() {
236236
@Test
237237
public void testRolePlugin13() {
238238
AuthorizationFramework instance = getInstance();
239-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.REQUIRED);
240-
instance.addPlugin(createLoadFailingPlugin(), AuthorizationRole.SUFFICIENT);
239+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.REQUIRED);
240+
instance.addPlugin(createLoadFailingPlugin(), AuthControlFlag.SUFFICIENT);
241241
instance.loadAllPlugins();
242242

243243
// same instance is not added twice in the plugins
@@ -252,8 +252,8 @@ public void testRolePlugin13() {
252252
@Test
253253
public void testRolePlugins14() {
254254
AuthorizationFramework instance = getInstance();
255-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.SUFFICIENT);
256-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.REQUIRED);
255+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.SUFFICIENT);
256+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.REQUIRED);
257257
instance.loadAllPlugins();
258258

259259
// sufficient is ok
@@ -268,8 +268,8 @@ public void testRolePlugins14() {
268268
@Test
269269
public void testRolePlugin15() {
270270
AuthorizationFramework instance = getInstance();
271-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.SUFFICIENT);
272-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
271+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.SUFFICIENT);
272+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
273273
instance.loadAllPlugins();
274274

275275
// all are sufficient - success
@@ -282,8 +282,8 @@ public void testRolePlugin15() {
282282
@Test
283283
public void testRolePlugin16() {
284284
AuthorizationFramework instance = getInstance();
285-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.REQUIRED);
286-
instance.addPlugin(createAllowedPrefixPlugin(), AuthorizationRole.SUFFICIENT);
285+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.REQUIRED);
286+
instance.addPlugin(createAllowedPrefixPlugin(), AuthControlFlag.SUFFICIENT);
287287
instance.loadAllPlugins();
288288

289289
// required test fails (exception when group is not allowed)
@@ -296,8 +296,8 @@ public void testRolePlugin16() {
296296
@Test
297297
public void testRolePlugin17() {
298298
AuthorizationFramework instance = getInstance();
299-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.SUFFICIENT);
300-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.REQUIRED);
299+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.SUFFICIENT);
300+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.REQUIRED);
301301
instance.loadAllPlugins();
302302

303303
// same instance is not added twice in the plugins and the plugin stays sufficient
@@ -311,8 +311,8 @@ public void testRolePlugin17() {
311311
@Test
312312
public void testRolePlugin18() {
313313
AuthorizationFramework instance = getInstance();
314-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.REQUIRED);
315-
instance.addPlugin(createTestFailingPlugin(), AuthorizationRole.SUFFICIENT);
314+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.REQUIRED);
315+
instance.addPlugin(createTestFailingPlugin(), AuthControlFlag.SUFFICIENT);
316316
instance.loadAllPlugins();
317317

318318
// same instance is not added twice in the plugins and this instance allows all projects

0 commit comments

Comments
 (0)