xintongsong commented on code in PR #20236: URL: https://github.com/apache/flink/pull/20236#discussion_r923034287
########## flink-runtime/src/main/java/org/apache/flink/runtime/rest/versioning/APIVersion.java: ########## @@ -0,0 +1,43 @@ +/* + * 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.versioning; + +/** Interface for all versions of the REST API. */ +public interface APIVersion { Review Comment: ```suggestion public interface RestAPIVersion { ``` ########## flink-runtime/src/main/java/org/apache/flink/runtime/rest/versioning/RestAPIVersion.java: ########## @@ -31,7 +31,7 @@ * modification of a handler url - addition of new mandatory parameters - removal of a * handler/request - modifications to request/response bodies (excluding additions) */ -public enum RestAPIVersion { +public enum RestAPIVersion implements APIVersion { Review Comment: ```suggestion public enum RuntimeRestAPIVersion implements APIVersion { ``` ########## flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/NonLeaderRetrievalRestfulGateway.java: ########## @@ -0,0 +1,100 @@ +/* + * 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.webmonitor; + +import org.apache.flink.api.common.JobID; +import org.apache.flink.api.common.time.Time; +import org.apache.flink.api.java.tuple.Tuple2; +import org.apache.flink.runtime.clusterframework.types.ResourceID; +import org.apache.flink.runtime.jobmaster.JobResult; +import org.apache.flink.runtime.messages.Acknowledge; +import org.apache.flink.runtime.messages.webmonitor.ClusterOverview; +import org.apache.flink.runtime.messages.webmonitor.MultipleJobsDetails; +import org.apache.flink.runtime.rest.messages.ThreadDumpInfo; +import org.apache.flink.runtime.scheduler.ExecutionGraphInfo; + +import java.util.Collection; +import java.util.concurrent.CompletableFuture; + +/** + * * Gateway for restful endpoints without leader retrieval logic. * * + * + * <p>Gateways which implement this method run a REST endpoint which is reachable under the returned + * address, and can be used in {@link org.apache.flink.runtime.rest.handler.AbstractHandler} without + * leader retrieval logic. + */ +public class NonLeaderRetrievalRestfulGateway implements RestfulGateway { + private static final String MESSAGE = + "NonLeaderRetrievalRestfulGateway doesn't support the operation."; + + public static final NonLeaderRetrievalRestfulGateway INSTANCE = Review Comment: Need a private constructor to make sure this class is singleton. ########## flink-runtime/src/main/java/org/apache/flink/runtime/rest/versioning/RestAPIVersion.java: ########## @@ -31,7 +31,7 @@ * modification of a handler url - addition of new mandatory parameters - removal of a * handler/request - modifications to request/response bodies (excluding additions) */ -public enum RestAPIVersion { +public enum RestAPIVersion implements APIVersion { Review Comment: I think we should also find a way to define `getLatestVersion` and the comparing method in the common abstract. The unused `fromURLVersionPrefix` probably can be removed. ########## flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/util/SqlGatewayRestOptions.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.table.gateway.rest.util; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.configuration.ConfigOption; +import org.apache.flink.configuration.DelegatingConfiguration; +import org.apache.flink.configuration.description.Description; + +import static org.apache.flink.configuration.ConfigOptions.key; +import static org.apache.flink.configuration.description.TextElement.text; + +/** Options to configure {@link org.apache.flink.table.gateway.rest.SqlGatewayRestEndpoint}. */ +@PublicEvolving +public class SqlGatewayRestOptions { + + /** The key name of port option. */ + private static final String REST_PORT_KEY = "rest.port"; + + /** + * The prefix for all sql gateway options, which will be used in {@link DelegatingConfiguration} + * during the initialization of sql gateway server. + */ + public static final String GATEWAY_ENDPOINT_PREFIX = "sql-gateway.endpoint."; + + /** The address that should be used by clients to connect to the sql gateway server. */ + public static final ConfigOption<String> ADDRESS = + key("rest.address") + .stringType() + .defaultValue("127.0.0.1") Review Comment: If this is required, there should be no default value. ########## flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/util/SqlGatewayRestEndpointFactory.java: ########## @@ -0,0 +1,72 @@ +/* + * 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.table.gateway.rest.util; + +import org.apache.flink.configuration.ConfigOption; +import org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint; +import org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactory; +import org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpointFactoryUtils; +import org.apache.flink.table.gateway.api.utils.SqlGatewayException; +import org.apache.flink.table.gateway.rest.SqlGatewayRestEndpoint; + +import java.util.Collections; +import java.util.HashSet; +import java.util.Set; + +import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestOptions.ADDRESS; +import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestOptions.BIND_ADDRESS; +import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestOptions.BIND_PORT; +import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestOptions.PORT; + +/** The factory for sql gateway. */ +public class SqlGatewayRestEndpointFactory implements SqlGatewayEndpointFactory { + + @Override + public SqlGatewayEndpoint createSqlGatewayEndpoint(Context context) { + SqlGatewayEndpointFactoryUtils.EndpointFactoryHelper endpointFactoryHelper = + SqlGatewayEndpointFactoryUtils.createEndpointFactoryHelper(this, context); + endpointFactoryHelper.validate(); + try { + return new SqlGatewayRestEndpoint( + context.getFlinkConfiguration(), context.getSqlGatewayService()); + } catch (Exception e) { + throw new SqlGatewayException("Cannot start the rest endpoint.", e); + } + } + + @Override + public String factoryIdentifier() { + return null; + } + + @Override + public Set<ConfigOption<?>> requiredOptions() { + Set<ConfigOption<?>> options = new HashSet<>(); + options.add(ADDRESS); + options.add(BIND_ADDRESS); + options.add(BIND_PORT); Review Comment: Why are these two required? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
