├── .gitignore ├── src └── main │ └── java │ └── net │ └── galgus │ └── flink │ └── streaming │ └── connectors │ └── http │ ├── exception │ └── HTTPConnectionConfigException.java │ ├── HTTPSink.java │ └── common │ └── HTTPConnectionConfig.java ├── pom.xml ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | *.iml 3 | target -------------------------------------------------------------------------------- /src/main/java/net/galgus/flink/streaming/connectors/http/exception/HTTPConnectionConfigException.java: -------------------------------------------------------------------------------- 1 | package net.galgus.flink.streaming.connectors.http.exception; 2 | 3 | public class HTTPConnectionConfigException extends Exception { 4 | public HTTPConnectionConfigException(String msg) { 5 | super(msg); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | net.galgus 8 | flink-connector-http 9 | 1.0-SNAPSHOT 10 | 11 | flink-connector-http 12 | 13 | jar 14 | 15 | 16 | 1.9.0 17 | 18 | 19 | 20 | 21 | org.apache.flink 22 | flink-streaming-java_2.12 23 | ${apache.flink.version} 24 | provided 25 | 26 | 27 | 28 | 29 | 30 | 31 | org.apache.maven.plugins 32 | maven-compiler-plugin 33 | 34 | 8 35 | 8 36 | 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Flink HTTP Connector 2 | 3 | `flink-connector-http` is a [Flink Streaming Connector](https://ci.apache.org/projects/flink/flink-docs-stable/dev/connectors/) for invoking HTTPs APIs with data from any source. 4 | 5 | 6 | 7 | ## Build & Run 8 | 9 | ### Requirements 10 | 11 | To build `flink-connector-http` you need to have [maven](https://maven.apache.org/) installed. 12 | 13 | 14 | 15 | ### Steps 16 | 17 | To build `flink-connector-http` you must run the next command: 18 | 19 | ``` 20 | mvn clean install 21 | ``` 22 | 23 | 24 | 25 | This command will install all the components in your `.m2` directory. To use you only must to add the next dependency in your `pom.xml` file: 26 | 27 | ``` 28 | 29 | net.galgus 30 | flink-connector-http 31 | 1.0-SNAPSHOT 32 | 33 | ``` 34 | 35 | 36 | 37 | ## FAQ 38 | 39 | ### How could I disable SSL Certificate verification 40 | 41 | This is a common issue when you are developing in your localhost or with a self-signed certificate. If you run a flink application you could get the next exceptions: 42 | 43 | `PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target` 44 | 45 | `javax.net.ssl.SSLHandshakeException: java.security.cert.CertificateException: No name matching ssl.someUrl.de found` 46 | 47 | To solve this issue you can use the next snippet: 48 | 49 | ``` 50 | TrustManager[] trustAllCerts = new TrustManager[] { 51 | new X509TrustManager() { 52 | public java.security.cert.X509Certificate[] getAcceptedIssuers() { 53 | return null; 54 | } 55 | 56 | public void checkClientTrusted(X509Certificate[] certs, String authType) { } 57 | 58 | public void checkServerTrusted(X509Certificate[] certs, String authType) { } 59 | } 60 | }; 61 | 62 | SSLContext sc = SSLContext.getInstance("SSL"); 63 | sc.init(null, trustAllCerts, new java.security.SecureRandom()); 64 | 65 | HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); 66 | 67 | HttpsURLConnection.setDefaultHostnameVerifier(new HostnameVerifier() { 68 | @Override 69 | public boolean verify(String s, SSLSession sslSession) { 70 | return true; 71 | } 72 | }); 73 | ``` 74 | 75 | 76 | 77 | This code is for testing purposes, and disabling certificate verification is not a recommended practice. -------------------------------------------------------------------------------- /src/main/java/net/galgus/flink/streaming/connectors/http/HTTPSink.java: -------------------------------------------------------------------------------- 1 | package net.galgus.flink.streaming.connectors.http; 2 | 3 | import net.galgus.flink.streaming.connectors.http.common.HTTPConnectionConfig; 4 | import org.apache.flink.streaming.api.functions.sink.RichSinkFunction; 5 | import org.slf4j.Logger; 6 | import org.slf4j.LoggerFactory; 7 | 8 | import javax.net.ssl.HttpsURLConnection; 9 | import java.io.BufferedReader; 10 | import java.io.InputStreamReader; 11 | import java.io.OutputStreamWriter; 12 | import java.net.HttpURLConnection; 13 | import java.net.URL; 14 | import java.nio.charset.StandardCharsets; 15 | 16 | public class HTTPSink extends RichSinkFunction { 17 | private static final Logger log = LoggerFactory.getLogger(HTTPSink.class); 18 | 19 | private HTTPConnectionConfig httpConnectionConfig; 20 | 21 | public HTTPSink(HTTPConnectionConfig httpConnectionConfig) { 22 | this.httpConnectionConfig = httpConnectionConfig; 23 | } 24 | 25 | public void invoke(IN value, Context context) throws Exception { 26 | if (value != null) { 27 | URL url = new URL(httpConnectionConfig.getEndpoint()); 28 | 29 | HttpURLConnection conn = httpConnectionConfig.isHttpsEnabled() ? (HttpsURLConnection) url.openConnection() : (HttpURLConnection) url.openConnection(); 30 | 31 | conn.setDoOutput(true); 32 | conn.setRequestMethod(httpConnectionConfig.getMethod()); 33 | 34 | httpConnectionConfig.getHeaders().forEach(conn::setRequestProperty); 35 | 36 | OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream(), StandardCharsets.UTF_8); 37 | writer.write(value.toString()); 38 | writer.close(); 39 | 40 | int status = conn.getResponseCode(); 41 | if (status != 200) { 42 | BufferedReader in = new BufferedReader( 43 | new InputStreamReader(conn.getErrorStream())); 44 | String inputLine; 45 | StringBuffer error = new StringBuffer(); 46 | while ((inputLine = in.readLine()) != null) { 47 | error.append(inputLine); 48 | } 49 | in.close(); 50 | log.error("HTTP Response code: " + status 51 | + ", " + conn.getResponseMessage() + ", " + error 52 | + ", Submitted payload: " + value.toString() 53 | + ", url:" + httpConnectionConfig.getEndpoint()); 54 | } 55 | 56 | log.debug(", response code: " + status 57 | + ", " + conn.getResponseMessage() 58 | + ", headers: " + httpConnectionConfig.getHeaders()); 59 | 60 | conn.disconnect(); 61 | } 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /src/main/java/net/galgus/flink/streaming/connectors/http/common/HTTPConnectionConfig.java: -------------------------------------------------------------------------------- 1 | package net.galgus.flink.streaming.connectors.http.common; 2 | 3 | import java.io.Serializable; 4 | import java.util.HashMap; 5 | import java.util.Map; 6 | 7 | public class HTTPConnectionConfig implements Serializable { 8 | 9 | public enum HTTPMethod { 10 | PUT, 11 | DELETE, 12 | POST, 13 | PATCH 14 | } 15 | 16 | private String endpoint; 17 | private HTTPMethod method = HTTPMethod.POST; 18 | private Map headers = new HashMap<>(); 19 | private boolean isHttpsEnabled; 20 | 21 | public HTTPConnectionConfig(String endpoint, HTTPMethod method, Map headers, boolean isHttpsEnabled) { 22 | this.endpoint = endpoint; 23 | this.method = method; 24 | this.headers = headers; 25 | this.isHttpsEnabled = isHttpsEnabled; 26 | } 27 | 28 | public Map getHeaders() { 29 | return headers; 30 | } 31 | 32 | public String getEndpoint() { 33 | return endpoint; 34 | } 35 | 36 | public void setEndpoint(String endpoint) { 37 | this.endpoint = endpoint; 38 | } 39 | 40 | public String getMethod() { 41 | return method.toString(); 42 | } 43 | 44 | public void setMethod(HTTPMethod method) { 45 | this.method = method; 46 | } 47 | 48 | public boolean isHttpsEnabled() { 49 | return isHttpsEnabled; 50 | } 51 | 52 | public void setEnableHttps(boolean isEnabled) { 53 | isHttpsEnabled = isEnabled; 54 | } 55 | 56 | public static class Builder { 57 | private String endpoint; 58 | private HTTPMethod method; 59 | private Map headers = new HashMap<>(); 60 | private boolean isHttpsEnabled; 61 | 62 | public Builder setEndpoint(String endpoint) { 63 | this.endpoint = endpoint; 64 | return this; 65 | } 66 | 67 | public Builder setMethod(String method) { 68 | this.method = HTTPMethod.valueOf(method.toUpperCase()); 69 | return this; 70 | } 71 | 72 | public Builder setHttpsEnabled(boolean isEnabled) { 73 | this.isHttpsEnabled = isEnabled; 74 | return this; 75 | } 76 | 77 | public Builder addHeaders(String headers) { 78 | final String HEADER_SEPARATOR = ","; 79 | final String HEADER_SPLITTER = ":"; 80 | final int KEY = 0; 81 | final int VALUE = 1; 82 | 83 | String[] tokens = headers.split(HEADER_SEPARATOR); 84 | 85 | for (String token : tokens) { 86 | String[] header = token.split(HEADER_SPLITTER); 87 | 88 | this.headers.put(header[KEY], header[VALUE]); 89 | } 90 | 91 | return this; 92 | } 93 | 94 | public HTTPConnectionConfig build() { 95 | return new HTTPConnectionConfig(endpoint, method, headers, isHttpsEnabled); 96 | } 97 | 98 | 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------