Skip to content

Commit 847d8a9

Browse files
cYKatherinecYKatherine
authored
Use Endpoints enum (#497)
1 parent bdd0dff commit 847d8a9

17 files changed

+120
-86
lines changed

‎src/main/java/com/uid2/admin/vertx/AdminVerticle.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import java.util.List;
2424

2525
import static com.uid2.admin.auth.AuthUtil.isAuthDisabled;
26+
import static com.uid2.admin.vertx.Endpoints.*;
2627

2728
public class AdminVerticle extends AbstractVerticle {
2829
private static final Logger LOGGER = LoggerFactory.getLogger(AdminVerticle.class);
@@ -73,7 +74,7 @@ private Router createRoutesSetup() {
7374
final TemplateEngine engine = PebbleTemplateEngine.create(vertx, "html");
7475
final TemplateHandler templateHandler = TemplateHandler.create(engine, "webroot/adm/", TemplateHandler.DEFAULT_CONTENT_TYPE);
7576

76-
router.route("/login").handler(oktaHandler);
77+
router.route(LOGIN.toString()).handler(oktaHandler);
7778
router.get("/adm/*").handler(oktaHandler)
7879
.handler(ctx -> {
7980
ctx.put("ADD_CLIENT_KEY_MESSAGE", config.getString("add_client_key_message"));
@@ -83,10 +84,10 @@ private Router createRoutesSetup() {
8384
.handler(templateHandler);
8485
router.route("/api/*").handler(tokenRefreshHandler);
8586

86-
router.get("/login").handler(new RedirectToRootHandler(false));
87-
router.get("/logout").handler(new RedirectToRootHandler(true));
88-
router.get("/ops/healthcheck").handler(this::handleHealthCheck);
89-
router.get("/api/userinfo").handler(this::handleUserinfo);
87+
router.get(LOGIN.toString()).handler(new RedirectToRootHandler(false));
88+
router.get(LOGOUT.toString()).handler(new RedirectToRootHandler(true));
89+
router.get(OPS_HEALTHCHECK.toString()).handler(this::handleHealthCheck);
90+
router.get(API_USERINFO.toString()).handler(this::handleUserinfo);
9091

9192
for (IService service : this.services) {
9293
service.setupRoutes(router);

‎src/main/java/com/uid2/admin/vertx/service/ClientKeyService.java‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
import java.util.Set;
3333
import java.util.stream.Collectors;
3434

35+
import static com.uid2.admin.vertx.Endpoints.*;
36+
3537
public class ClientKeyService implements IService {
3638
private static final Logger LOGGER = LoggerFactory.getLogger(ClientKeyService.class);
3739
private static final ObjectWriter JSON_WRITER = JsonUtil.createJsonWriter();
@@ -68,72 +70,72 @@ public ClientKeyService(JsonObject config,
6870

6971
@Override
7072
public void setupRoutes(Router router) {
71-
router.get("/api/client/metadata").handler(
73+
router.get(API_CLIENT_METADATA.toString()).handler(
7274
auth.handle(this::handleClientMetadata, Role.MAINTAINER));
73-
router.post("/api/client/rewrite_metadata").blockingHandler(auth.handle((ctx) -> {
75+
router.post(API_CLIENT_REWRITE_METADATA.toString()).blockingHandler(auth.handle((ctx) -> {
7476
synchronized (writeLock) {
7577
this.handleRewriteMetadata(ctx);
7678
}
7779
}, Role.PRIVILEGED));
7880

79-
router.get("/api/client/list").handler(
81+
router.get(API_CLIENT_LIST.toString()).handler(
8082
auth.handle(this::handleClientList, Role.MAINTAINER, Role.METRICS_EXPORT));
8183

82-
router.get("/api/client/list/:siteId").handler(
84+
router.get(API_CLIENT_LIST_SITEID.toString()).handler(
8385
auth.handle(this::handleClientListBySite, Role.MAINTAINER, Role.SHARING_PORTAL));
8486

85-
router.get("/api/client/keyId").handler(
87+
router.get(API_CLIENT_KEYID.toString()).handler(
8688
auth.handle(this::handleClientByKeyId, Role.MAINTAINER, Role.SHARING_PORTAL));
8789

88-
router.get("/api/client/contact").handler(
90+
router.get(API_CLIENT_CONTACT.toString()).handler(
8991
auth.handle(this::handleClientByContact, Role.MAINTAINER, Role.SHARING_PORTAL));
9092

91-
router.get("/api/client/reveal").handler(
93+
router.get(API_CLIENT_REVEAL.toString()).handler(
9294
auth.handle(this::handleClientReveal, Role.PRIVILEGED));
9395

94-
router.post("/api/client/add").blockingHandler(auth.handle((ctx) -> {
96+
router.post(API_CLIENT_ADD.toString()).blockingHandler(auth.handle((ctx) -> {
9597
synchronized (writeLock) {
9698
this.handleClientAdd(ctx);
9799
}
98100
}, Role.MAINTAINER, Role.SHARING_PORTAL));
99101

100-
router.post("/api/client/del").blockingHandler(auth.handle((ctx) -> {
102+
router.post(API_CLIENT_DEL.toString()).blockingHandler(auth.handle((ctx) -> {
101103
synchronized (writeLock) {
102104
this.handleClientDel(ctx);
103105
}
104106
}, Role.SUPER_USER));
105107

106-
router.post("/api/client/update").blockingHandler(auth.handle((ctx) -> {
108+
router.post(API_CLIENT_UPDATE.toString()).blockingHandler(auth.handle((ctx) -> {
107109
synchronized (writeLock) {
108110
this.handleClientUpdate(ctx);
109111
}
110112
}, Role.MAINTAINER));
111113

112-
router.post("/api/client/disable").blockingHandler(auth.handle((ctx) -> {
114+
router.post(API_CLIENT_DISABLE.toString()).blockingHandler(auth.handle((ctx) -> {
113115
synchronized (writeLock) {
114116
this.handleClientDisable(ctx);
115117
}
116118
}, Role.MAINTAINER, Role.SHARING_PORTAL));
117119

118-
router.post("/api/client/enable").blockingHandler(auth.handle((ctx) -> {
120+
router.post(API_CLIENT_ENABLE.toString()).blockingHandler(auth.handle((ctx) -> {
119121
synchronized (writeLock) {
120122
this.handleClientEnable(ctx);
121123
}
122124
}, Role.MAINTAINER));
123125

124-
router.post("/api/client/roles").blockingHandler(auth.handle((ctx) -> {
126+
router.post(API_CLIENT_ROLES.toString()).blockingHandler(auth.handle((ctx) -> {
125127
synchronized (writeLock) {
126128
this.handleClientRoles(ctx);
127129
}
128130
}, Role.PRIVILEGED, Role.SHARING_PORTAL));
129131

130-
router.post("/api/client/contact").blockingHandler(auth.handle((ctx) -> {
132+
router.post(API_CLIENT_CONTACT.toString()).blockingHandler(auth.handle((ctx) -> {
131133
synchronized (writeLock) {
132134
this.handleClientContact(ctx);
133135
}
134136
}, Role.MAINTAINER));
135137

136-
router.post("/api/client/rename").blockingHandler(auth.handle((ctx) -> {
138+
router.post(API_CLIENT_RENAME.toString()).blockingHandler(auth.handle((ctx) -> {
137139
synchronized (writeLock) {
138140
this.handleClientRename(ctx);
139141
}

‎src/main/java/com/uid2/admin/vertx/service/ClientSideKeypairService.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727

2828
import static com.uid2.admin.store.writer.ClientSideKeypairStoreWriter.toJsonWithPrivateKey;
2929
import static com.uid2.admin.store.writer.ClientSideKeypairStoreWriter.toJsonWithoutPrivateKey;
30+
import static com.uid2.admin.vertx.Endpoints.*;
3031

3132
public class ClientSideKeypairService implements IService, IKeypairManager {
3233
private final AdminAuthMiddleware auth;
@@ -64,19 +65,19 @@ public ClientSideKeypairService(JsonObject config,
6465

6566
@Override
6667
public void setupRoutes(Router router) {
67-
router.post("/api/client_side_keypairs/add").blockingHandler(auth.handle((ctx) -> {
68+
router.post(API_CLIENT_SIDE_KEYPAIRS_ADD.toString()).blockingHandler(auth.handle((ctx) -> {
6869
synchronized (writeLock) {
6970
this.handleAddKeypair(ctx);
7071
}
7172
}, Role.MAINTAINER, Role.SHARING_PORTAL));
72-
router.post("/api/client_side_keypairs/update").blockingHandler(auth.handle((ctx) -> {
73+
router.post(API_CLIENT_SIDE_KEYPAIRS_UPDATE.toString()).blockingHandler(auth.handle((ctx) -> {
7374
synchronized (writeLock) {
7475
this.handleUpdateKeypair(ctx);
7576
}
7677
}, Role.MAINTAINER, Role.SHARING_PORTAL));
77-
router.get("/api/client_side_keypairs/list").handler(
78+
router.get(API_CLIENT_SIDE_KEYPAIRS_LIST.toString()).handler(
7879
auth.handle(this::handleListAllKeypairs, Role.MAINTAINER, Role.METRICS_EXPORT));
79-
router.get("/api/client_side_keypairs/:subscriptionId").handler(
80+
router.get(API_CLIENT_SIDE_KEYPAIRS_SUBSCRIPTIONID.toString()).handler(
8081
auth.handle(this::handleListKeypair, Role.MAINTAINER)
8182
);
8283
}

‎src/main/java/com/uid2/admin/vertx/service/EnclaveIdService.java‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
import java.util.Optional;
2323
import java.util.stream.Collectors;
2424

25+
import static com.uid2.admin.vertx.Endpoints.*;
26+
2527
public class EnclaveIdService implements IService {
2628
private final AdminAuthMiddleware auth;
2729
private final WriteLock writeLock;
@@ -44,17 +46,17 @@ public EnclaveIdService(AdminAuthMiddleware auth,
4446

4547
@Override
4648
public void setupRoutes(Router router) {
47-
router.get("/api/enclave/metadata").handler(
49+
router.get(API_ENCLAVE_METADATA.toString()).handler(
4850
auth.handle(this::handleEnclaveMetadata, Role.MAINTAINER));
49-
router.get("/api/enclave/list").handler(
51+
router.get(API_ENCLAVE_LIST.toString()).handler(
5052
auth.handle(this::handleEnclaveList, Role.MAINTAINER));
5153

52-
router.post("/api/enclave/add").blockingHandler(auth.handle((ctx) -> {
54+
router.post(API_ENCLAVE_ADD.toString()).blockingHandler(auth.handle((ctx) -> {
5355
synchronized (writeLock) {
5456
this.handleEnclaveAdd(ctx);
5557
}
5658
}, Role.PRIVILEGED));
57-
router.post("/api/enclave/del").blockingHandler(auth.handle((ctx) -> {
59+
router.post(API_ENCLAVE_DEL.toString()).blockingHandler(auth.handle((ctx) -> {
5860
synchronized (writeLock) {
5961
this.handleEnclaveDel(ctx);
6062
}

‎src/main/java/com/uid2/admin/vertx/service/EncryptionKeyService.java‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838

3939
import static com.uid2.admin.AdminConst.enableKeysetConfigProp;
4040
import static com.uid2.admin.managers.KeysetManager.*;
41+
import static com.uid2.admin.vertx.Endpoints.*;
4142
import static java.util.stream.Collectors.*;
4243

4344
public class EncryptionKeyService implements IService, IEncryptionKeyManager, IKeysetKeyManager {
@@ -122,47 +123,47 @@ public EncryptionKeyService(JsonObject config,
122123

123124
@Override
124125
public void setupRoutes(Router router) {
125-
router.get("/api/key/list").handler(
126+
router.get(API_KEY_LIST.toString()).handler(
126127
auth.handle(this::handleKeyList, Role.MAINTAINER));
127128

128129
if(enableKeysets) {
129-
router.get("/api/key/list_keyset_keys").handler(
130+
router.get(API_KEY_LIST_KEYSET_KEYS.toString()).handler(
130131
auth.handle(this::handleKeysetKeyList, Role.MAINTAINER));
131132
}
132133

133-
router.post("/api/key/rewrite_metadata").blockingHandler(auth.handle((ctx) -> {
134+
router.post(API_KEY_REWRITE_METADATA.toString()).blockingHandler(auth.handle((ctx) -> {
134135
synchronized (writeLock) {
135136
this.handleRewriteMetadata(ctx);
136137
}
137138
}, Role.PRIVILEGED));
138139

139-
router.post("/api/key/rotate_master").blockingHandler(auth.handle((ctx) -> {
140+
router.post(API_KEY_ROTATE_MASTER.toString()).blockingHandler(auth.handle((ctx) -> {
140141
synchronized (writeLock) {
141142
this.handleRotateMasterKey(ctx);
142143
}
143144
}, Role.MAINTAINER, Role.SECRET_ROTATION));
144145

145-
router.post("/api/key/add").blockingHandler(auth.handle((ctx) -> {
146+
router.post(API_KEY_ADD.toString()).blockingHandler(auth.handle((ctx) -> {
146147
synchronized (writeLock) {
147148
this.handleAddSiteKey(ctx);
148149
}
149150
}, Role.MAINTAINER));
150151

151-
router.post("/api/key/rotate_site").blockingHandler(auth.handle((ctx) -> {
152+
router.post(API_KEY_ROTATE_SITE.toString()).blockingHandler(auth.handle((ctx) -> {
152153
synchronized (writeLock) {
153154
this.handleRotateSiteKey(ctx);
154155
}
155156
}, Role.MAINTAINER));
156157

157158
if(enableKeysets) {
158-
router.post("/api/key/rotate_keyset_key").blockingHandler(auth.handle((ctx) -> {
159+
router.post(API_KEY_ROTATE_KEYSET_KEY.toString()).blockingHandler(auth.handle((ctx) -> {
159160
synchronized (writeLock) {
160161
this.handleRotateKeysetKey(ctx);
161162
}
162163
}, Role.MAINTAINER));
163164
}
164165

165-
router.post("/api/key/rotate_all_sites").blockingHandler(auth.handle((ctx) -> {
166+
router.post(API_KEY_ROTATE_ALL_SITES.toString()).blockingHandler(auth.handle((ctx) -> {
166167
synchronized (writeLock) {
167168
this.handleRotateAllSiteKeys(ctx);
168169
}

‎src/main/java/com/uid2/admin/vertx/service/JobDispatcherService.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
import com.uid2.shared.auth.Role;
88
import io.vertx.ext.web.Router;
99

10+
import static com.uid2.admin.vertx.Endpoints.API_JOB_DISPATCHER_CURRENT_JOB;
11+
import static com.uid2.admin.vertx.Endpoints.API_JOB_DISPATCHER_JOB_QUEUE;
12+
1013
public class JobDispatcherService implements IService {
1114
private final ObjectWriter jsonWriter = JsonUtil.createJsonWriter();
1215
private final AdminAuthMiddleware auth;
@@ -19,7 +22,7 @@ public JobDispatcherService(AdminAuthMiddleware auth, JobDispatcher jobDispatche
1922

2023
@Override
2124
public void setupRoutes(Router router) {
22-
router.get("/api/job-dispatcher/current-job").blockingHandler(auth.handle((ctx) -> {
25+
router.get(API_JOB_DISPATCHER_CURRENT_JOB.toString()).blockingHandler(auth.handle((ctx) -> {
2326
try {
2427
ctx.response().end(jsonWriter.writeValueAsString(jobDispatcher.getExecutingJobInfo()));
2528
} catch (Exception ex) {
@@ -29,7 +32,7 @@ public void setupRoutes(Router router) {
2932
//can be other role
3033
Role.MAINTAINER));
3134

32-
router.get("/api/job-dispatcher/job-queue").blockingHandler(auth.handle((ctx) -> {
35+
router.get(API_JOB_DISPATCHER_JOB_QUEUE.toString()).blockingHandler(auth.handle((ctx) -> {
3336
try {
3437
ctx.response().end(jsonWriter.writeValueAsString(jobDispatcher.getJobQueueInfo()));
3538
} catch (Exception ex) {

‎src/main/java/com/uid2/admin/vertx/service/KeyAclService.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
import java.util.*;
2424

25+
import static com.uid2.admin.vertx.Endpoints.API_KEYS_ACL_LIST;
26+
import static com.uid2.admin.vertx.Endpoints.API_KEYS_ACL_REWRITE_METADATA;
27+
2528
public class KeyAclService implements IService {
2629
private final AdminAuthMiddleware auth;
2730
private final WriteLock writeLock;
@@ -47,10 +50,10 @@ public KeyAclService(AdminAuthMiddleware auth,
4750

4851
@Override
4952
public void setupRoutes(Router router) {
50-
router.get("/api/keys_acl/list").handler(
53+
router.get(API_KEYS_ACL_LIST.toString()).handler(
5154
auth.handle(this::handleKeyAclList, Role.MAINTAINER));
5255

53-
router.post("/api/keys_acl/rewrite_metadata").blockingHandler(auth.handle((ctx) -> {
56+
router.post(API_KEYS_ACL_REWRITE_METADATA.toString()).blockingHandler(auth.handle((ctx) -> {
5457
synchronized (writeLock) {
5558
this.handleRewriteMetadata(ctx);
5659
}

‎src/main/java/com/uid2/admin/vertx/service/OperatorKeyService.java‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
import java.util.*;
2828
import java.util.stream.Collectors;
2929

30+
import static com.uid2.admin.vertx.Endpoints.*;
31+
3032
public class OperatorKeyService implements IService {
3133
private static final Logger LOGGER = LoggerFactory.getLogger(OperatorKeyService.class);
3234
private static final ObjectWriter JSON_WRITER = JsonUtil.createJsonWriter();
@@ -71,44 +73,44 @@ public OperatorKeyService(JsonObject config,
7173

7274
@Override
7375
public void setupRoutes(Router router) {
74-
router.get("/api/operator/metadata").handler(
76+
router.get(API_OPERATOR_METADATA.toString()).handler(
7577
auth.handle(this::handleOperatorMetadata, Role.MAINTAINER));
76-
router.get("/api/operator/list").handler(
78+
router.get(API_OPERATOR_LIST.toString()).handler(
7779
auth.handle(this::handleOperatorList, Role.MAINTAINER, Role.METRICS_EXPORT));
78-
router.get("/api/operator/reveal").handler(
80+
router.get(API_OPERATOR_REVEAL.toString()).handler(
7981
auth.handle(this::handleOperatorReveal, Role.MAINTAINER));
8082

81-
router.post("/api/operator/add").blockingHandler(auth.handle((ctx) -> {
83+
router.post(API_OPERATOR_ADD.toString()).blockingHandler(auth.handle((ctx) -> {
8284
synchronized (writeLock) {
8385
this.handleOperatorAdd(ctx);
8486
}
8587
}, Role.MAINTAINER));
8688

87-
router.post("/api/operator/del").blockingHandler(auth.handle((ctx) -> {
89+
router.post(API_OPERATOR_DEL.toString()).blockingHandler(auth.handle((ctx) -> {
8890
synchronized (writeLock) {
8991
this.handleOperatorDel(ctx);
9092
}
9193
}, Role.SUPER_USER));
9294

93-
router.post("/api/operator/disable").blockingHandler(auth.handle((ctx) -> {
95+
router.post(API_OPERATOR_DISABLE.toString()).blockingHandler(auth.handle((ctx) -> {
9496
synchronized (writeLock) {
9597
this.handleOperatorDisable(ctx);
9698
}
9799
}, Role.PRIVILEGED));
98100

99-
router.post("/api/operator/enable").blockingHandler(auth.handle((ctx) -> {
101+
router.post(API_OPERATOR_ENABLE.toString()).blockingHandler(auth.handle((ctx) -> {
100102
synchronized (writeLock) {
101103
this.handleOperatorEnable(ctx);
102104
}
103105
}, Role.MAINTAINER));
104106

105-
router.post("/api/operator/update").blockingHandler(auth.handle((ctx) -> {
107+
router.post(API_OPERATOR_UPDATE.toString()).blockingHandler(auth.handle((ctx) -> {
106108
synchronized (writeLock) {
107109
this.handleOperatorUpdate(ctx);
108110
}
109111
}, Role.PRIVILEGED));
110112

111-
router.post("/api/operator/roles").blockingHandler(auth.handle((ctx) -> {
113+
router.post(API_OPERATOR_ROLES.toString()).blockingHandler(auth.handle((ctx) -> {
112114
synchronized (writeLock) {
113115
this.handleOperatorRoles(ctx);
114116
}

‎src/main/java/com/uid2/admin/vertx/service/PartnerConfigService.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
import io.vertx.ext.web.Router;
1212
import io.vertx.ext.web.RoutingContext;
1313

14+
import static com.uid2.admin.vertx.Endpoints.API_PARTNER_CONFIG_GET;
15+
import static com.uid2.admin.vertx.Endpoints.API_PARTNER_CONFIG_UPDATE;
16+
1417
public class PartnerConfigService implements IService {
1518
private final AdminAuthMiddleware auth;
1619
private final WriteLock writeLock;
@@ -29,9 +32,9 @@ public PartnerConfigService(AdminAuthMiddleware auth,
2932

3033
@Override
3134
public void setupRoutes(Router router) {
32-
router.get("/api/partner_config/get").handler(
35+
router.get(API_PARTNER_CONFIG_GET.toString()).handler(
3336
auth.handle(this::handlePartnerConfigGet, Role.MAINTAINER));
34-
router.post("/api/partner_config/update").blockingHandler(auth.handle((ctx) -> {
37+
router.post(API_PARTNER_CONFIG_UPDATE.toString()).blockingHandler(auth.handle((ctx) -> {
3538
synchronized (writeLock) {
3639
this.handlePartnerConfigUpdate(ctx);
3740
}

0 commit comments

Comments
 (0)