-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- refactor
- Loading branch information
Showing
4 changed files
with
234 additions
and
77 deletions.
There are no files selected for viewing
137 changes: 137 additions & 0 deletions
137
metafacture-io/src/main/java/org/metafacture/io/AbstractUrlConnection.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| package org.metafacture.io; | ||
|
|
||
| import org.metafacture.framework.ObjectReceiver; | ||
| import org.metafacture.framework.helpers.DefaultObjectPipe; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.URL; | ||
| import java.net.URLConnection; | ||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * Common functions for object writers. | ||
| * | ||
| * @param <T> object type that this module processes | ||
| * @param <R> receiver type of the downstream module | ||
| * @author Jens Wille | ||
| * @author Pascal Christoph (dr0i) | ||
| */ | ||
| abstract class AbstractUrlConnection<T, R> extends DefaultObjectPipe<T, ObjectReceiver<R>> { | ||
| public static final String ACCEPT_HEADER = "accept"; | ||
| public static final String ENCODING_HEADER = "accept-charset"; | ||
| public static final String CONTENT_TYPE_HEADER = "content-Type"; | ||
| static final String ACCEPT_DEFAULT = "*/*"; | ||
| static final String ENCODING_DEFAULT = "UTF-8"; | ||
| private static Boolean doOutput = false; | ||
| private final Map<String, String> headers = new HashMap<>(); | ||
| private final Pattern headerFieldSeparator = Pattern.compile("\n"); | ||
| private final Pattern headerValueSeparator = Pattern.compile(":"); | ||
| private URLConnection con; | ||
|
|
||
| /** | ||
| * Sets the HTTP {@value #ACCEPT_HEADER} header. This is a mime-type such as text/plain | ||
| * or text/html. | ||
| * | ||
| * @param accept mime-type to use for the HTTP accept header | ||
| */ | ||
| public void setAccept(final String accept) { | ||
| setHeader(ACCEPT_HEADER, accept); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the preferred encoding of the HTTP response. This value is set as the | ||
| * {@value #ENCODING_HEADER} header. Additionally, the encoding is used for reading the | ||
| * HTTP response if it does not specify an encoding. | ||
| * | ||
| * @param encoding name of the encoding used for the accept-charset HTTP | ||
| * header | ||
| */ | ||
| public void setEncoding(final String encoding) { | ||
| setHeader(ENCODING_HEADER, encoding); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the HTTP {@value #CONTENT_TYPE_HEADER} header. This is a mime-type such as text/plain, | ||
| * text/html or application/x-ndjson. | ||
| * | ||
| * @param contentType mime-type to use for the HTTP contentType header | ||
| */ | ||
| public void setContentType(final String contentType) { | ||
| setHeader(CONTENT_TYPE_HEADER, contentType); | ||
| } | ||
|
|
||
| /** | ||
| * Set the DoOutput flag to true if you intend to use the URL connection for output, false if not. The default is false. | ||
| * | ||
| * @param doOutput the new value | ||
| * @see URLConnection#setDoOutput(boolean) | ||
| */ | ||
| public void setDoOutput(final boolean doOutput) { | ||
| AbstractUrlConnection.doOutput = doOutput; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the {@value #ENCODING_HEADER} header of the URLConnection. | ||
| * | ||
| * @return the name of the encoding header | ||
| */ | ||
| public String getEncodingHeader() { | ||
| return ENCODING_HEADER; | ||
| } | ||
|
|
||
| /** | ||
| * Sets a request property, or multiple request properties separated by | ||
| * {@code \n}. | ||
| * | ||
| * @param header request property line | ||
| */ | ||
| public void setHeader(final String header) { | ||
| Arrays.stream(headerFieldSeparator.split(header)).forEach(h -> { | ||
| final String[] parts = headerValueSeparator.split(h, 2); | ||
| if (parts.length == 2) { | ||
| setHeader(parts[0], parts[1].trim()); | ||
| } | ||
| else { | ||
| throw new IllegalArgumentException("Invalid header: " + h); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Sets a request property. | ||
| * | ||
| * @param key request property key | ||
| * @param value request property value | ||
| */ | ||
| public void setHeader(final String key, final String value) { | ||
| headers.put(key.toLowerCase(), value); | ||
| } | ||
|
|
||
| /** | ||
| * Gets headers of the {@link java.net.URLConnection} as a HashMap. | ||
| * | ||
| * @return the headers od the URLConnection as HashMap | ||
| */ | ||
| public Map<String, String> getHeaders() { | ||
| return headers; | ||
| } | ||
|
|
||
| /** | ||
| * Opens an {@link java.net.URLConnection} defined by the URL. | ||
| * | ||
| * @param urlStr an URL as String | ||
| * @return {@link java.net.URLConnection} | ||
| * @throws IOException if an I/O IOException occurs | ||
| */ | ||
| public URLConnection getUrlConnection(final String urlStr) throws IOException { | ||
| final URL url = new URL(urlStr); | ||
| con = url.openConnection(); | ||
| con.setDoOutput(doOutput); | ||
| headers.forEach(con::addRequestProperty); | ||
| return con; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
metafacture-io/src/main/java/org/metafacture/io/HttpPoster.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright 2013, 2014 Deutsche Nationalbibliothek | ||
| * | ||
| * Licensed 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.metafacture.io; | ||
|
|
||
| import org.metafacture.framework.FluxCommand; | ||
| import org.metafacture.framework.MetafactureException; | ||
| import org.metafacture.framework.annotations.Description; | ||
| import org.metafacture.framework.annotations.In; | ||
| import org.metafacture.framework.annotations.Out; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStreamReader; | ||
| import java.io.OutputStream; | ||
| import java.io.Reader; | ||
| import java.net.HttpURLConnection; | ||
| import java.net.ProtocolException; | ||
|
|
||
| /** | ||
| * Uploads data using {@link java.net.HttpURLConnection} with POST method and passes the response to the receiver. | ||
| * Supports the setting of 'Accept', 'ContentType' and 'Encoding' as HTTP header fields. | ||
| * | ||
| * @author Pascal Christoph (dr0i) | ||
| */ | ||
| @Description("POSTs data to a {@link java.net.HttpURLConnection}. Argument 'url' is mandatory. Supports the setting of 'accept', 'contentType' and 'encoding' (of the response) as http header fields.") | ||
| @In(String.class) | ||
| @Out(Reader.class) | ||
| @FluxCommand("post-http") | ||
| public final class HttpPoster extends AbstractUrlConnection<String, Reader> { | ||
|
|
||
| private static final String POST = "POST"; | ||
| private static final Boolean DO_OUTPUT = true; | ||
| private static final int HTTP_STATUS_CODE_MIN = 100; | ||
| private static final int HTTP_STATUS_CODE_MAX = 399; | ||
| private String contentType = "application/json"; | ||
| private String url; | ||
|
|
||
| /** | ||
| * Creates an instance of {@link HttpPoster}. | ||
| * | ||
| * @throws ProtocolException if a protocol error occurs | ||
| */ | ||
| public HttpPoster() throws ProtocolException { | ||
| setDoOutput(DO_OUTPUT); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the HTTP URL to POST to | ||
| * | ||
| * @param url the URL to POST to | ||
| */ | ||
| public void setUrl(final String url) { | ||
| this.url = url; | ||
| } | ||
|
|
||
| @Override | ||
| public void process(final String data) throws IllegalStateException, NullPointerException { | ||
| try { | ||
| final HttpURLConnection conn = (HttpURLConnection) getUrlConnection(url); | ||
| conn.setRequestMethod(POST); | ||
| final InputStreamReader inputStreamReader; | ||
| final OutputStream os = conn.getOutputStream(); | ||
| os.write(data.getBytes()); | ||
| if (HTTP_STATUS_CODE_MIN <= conn.getResponseCode() && conn.getResponseCode() <= HTTP_STATUS_CODE_MAX) { | ||
| inputStreamReader = new InputStreamReader(conn.getInputStream()); | ||
| } | ||
| else { | ||
| inputStreamReader = new InputStreamReader(conn.getErrorStream()); | ||
| } | ||
| getReceiver().process(inputStreamReader); | ||
| } | ||
| catch (final IOException e) { | ||
| throw new MetafactureException(e); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters