Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4569#discussion_r134690587
--- Diff:
flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/ParameterMapper.java
---
@@ -0,0 +1,83 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+package org.apache.flink.runtime.rest.messages;
+
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * This class is used to map query/path {@link Parameter}s to their actual
value.
+ */
+public abstract class ParameterMapper {
+
+ /**
+ * Maps the given query {@link Parameter}s to their actual value.
+ *
+ * @param queryParameters parameters to map
+ * @return map containing the parameters and their associated value
+ */
+ public Map<Parameter, String> mapQueryParameters(Set<Parameter>
queryParameters) {
+ return Collections.emptyMap();
+ }
+
+ /**
+ * Maps the given path {@link Parameter}s to their actual value.
+ *
+ * @param pathParameters parameters to map
+ * @return map containing the parameters and their associated value
+ */
+ public Map<Parameter, String> mapPathParameters(Set<Parameter>
pathParameters) {
+ return Collections.emptyMap();
+ }
+
+ /**
+ * Resolves the given URL (e.g "jobs/:jobid") using the given
path/query parameters.
+ *
+ * @param genericUrl URL to resolve
+ * @param pathParameters path parameters
+ * @param queryParameters query parameters
+ * @return resolved url, e.g "/jobs/1234?state=running"
+ */
+ public static String resolveUrl(String genericUrl, Map<Parameter,
String> pathParameters, Map<Parameter, String> queryParameters) {
+ StringBuilder sb = new StringBuilder(genericUrl);
+
+ pathParameters.forEach((parameter, value) -> {
+ int start = sb.indexOf(":" + parameter.getKey());
+ sb.replace(start, start + parameter.getKey().length() +
1, value);
+ });
--- End diff --
Technically it could still be a valid URL.
My conclusion is that this implementation for handling parameters is
inherently flawed.
* The mapper gets a set of parameters in a map but can decide to completely
ignore it, (which is how most implementation will most likely look like)
* There is no good means of verifying whether parameters were set or not
* It doesn't it handle optional parameters, which is common for query
parameters
* it is limited to the client side, on the server side we're still dealing
with String:String maps
I think I've come up with something that addresses the above short-comings,
hang tight.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
