org.metafacture.io

Class HttpOpener

java.lang.Object

org.metafacture.framework.helpers.DefaultSender<R>

org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>

org.metafacture.io.HttpOpener

All Implemented Interfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.ObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>, org.metafacture.framework.ObjectReceiver<java.lang.String>, org.metafacture.framework.Receiver, org.metafacture.framework.Sender<org.metafacture.framework.ObjectReceiver<java.io.Reader>>

@Description(value="Opens an HTTP resource. Supports setting HTTP header fields `Accept`, `Accept-Charset` and `Content-Type`, as well as generic headers (separated by `\\n`). Defaults: request `method` = `GET`, request `url` = `@-` (input data), request `body` = `@-` (input data) if request method supports body and input data not already used, `Accept` header = `*/*`, `Accept-Charset` header (`encoding`) = `UTF-8`, `errorPrefix` = `ERROR: `.")
 @In(value=java.lang.String.class)
 @Out(value=java.io.Reader.class)
 @FluxCommand(value="open-http")
public final class HttpOpener
extends org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>

Opens an HttpURLConnection and passes a reader to the receiver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpOpener.Method

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_DEFAULT
static java.lang.String	ACCEPT_HEADER
static java.lang.String	CONTENT_TYPE_HEADER
static HttpOpener.Method	DEFAULT_METHOD
static java.lang.String	DEFAULT_METHOD_NAME
static java.lang.String	DEFAULT_PREFIX
static java.lang.String	ENCODING_DEFAULT
static java.lang.String	ENCODING_HEADER
static java.lang.String	HEADER_FIELD_SEPARATOR
static java.lang.String	HEADER_VALUE_SEPARATOR
static java.lang.String	INPUT_DESIGNATOR

Constructor Summary

Constructors

Constructor and Description
HttpOpener() Creates an instance of HttpOpener.

Method Summary

Modifier and Type	Method and Description
void	process(java.lang.String input)
void	setAccept(java.lang.String accept) Sets the HTTP "accept" header value.
void	setBody(java.lang.String body) Sets the HTTP request body.
void	setContentType(java.lang.String contentType) Sets the HTTP "content-type" header value.
void	setEncoding(java.lang.String encoding) Sets the HTTP "accept-charset" header value.
void	setErrorPrefix(java.lang.String errorPrefix) Sets the error prefix.
void	setHeader(java.lang.String header) Sets a request property (header), or multiple request properties separated by "\n".
void	setHeader(java.lang.String key, java.lang.String value) Sets a request property (header).
void	setMethod(HttpOpener.Method method) Sets the HTTP request method.
void	setUrl(java.lang.String url) Sets the HTTP request URL.

Methods inherited from class org.metafacture.framework.helpers.DefaultSender

closeStream, getReceiver, isClosed, onCloseStream, onResetStream, onSetReceiver, resetStream, setReceiver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.metafacture.framework.LifeCycle

closeStream, resetStream

Methods inherited from interface org.metafacture.framework.Sender

setReceiver

Field Detail

ACCEPT_DEFAULT

public static final java.lang.String ACCEPT_DEFAULT

See Also:

Constant Field Values

ACCEPT_HEADER

public static final java.lang.String ACCEPT_HEADER

See Also:

Constant Field Values

CONTENT_TYPE_HEADER

public static final java.lang.String CONTENT_TYPE_HEADER

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

See Also:

Constant Field Values

ENCODING_DEFAULT

public static final java.lang.String ENCODING_DEFAULT

See Also:

Constant Field Values

ENCODING_HEADER

public static final java.lang.String ENCODING_HEADER

See Also:

Constant Field Values

INPUT_DESIGNATOR

public static final java.lang.String INPUT_DESIGNATOR

See Also:

Constant Field Values

DEFAULT_METHOD_NAME

public static final java.lang.String DEFAULT_METHOD_NAME

See Also:

Constant Field Values

DEFAULT_METHOD

public static final HttpOpener.Method DEFAULT_METHOD

HEADER_FIELD_SEPARATOR

public static final java.lang.String HEADER_FIELD_SEPARATOR

See Also:

Constant Field Values

HEADER_VALUE_SEPARATOR

public static final java.lang.String HEADER_VALUE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

HttpOpener

public HttpOpener()

Creates an instance of HttpOpener.

Method Detail

setAccept

public void setAccept(java.lang.String accept)

Sets the HTTP "accept" header value. This is a MIME type such as text/plain or application/json. The default value for the accept header is "*/*" which means any MIME type.

Parameters:

accept - MIME type to use for the HTTP accept header

setBody

public void setBody(java.lang.String body)

Sets the HTTP request body. The default value for the request body is "@-" if the request method accepts a request body, which means it will use the input data data as request body if the input has not already been used; otherwise, no request body will be set by default.

If a request body has been set, but the request method does not accept a body, the method may be changed to POST.

Parameters:

body - the request body

setContentType

public void setContentType(java.lang.String contentType)

Sets the HTTP "content-type" header value. This is a MIME type such as text/plain or application/json.

Parameters:

contentType - MIME type to use for the HTTP content-type header

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the HTTP "accept-charset" header value. This is the preferred encoding for the HTTP response. Additionally, the encoding is used for reading the HTTP response if it does not specify a content encoding. The default for the encoding is "UTF-8".

Parameters:

encoding - name of the encoding used for the accept-charset HTTP header

setErrorPrefix

public void setErrorPrefix(java.lang.String errorPrefix)

Sets the error prefix. The default error prefix is "ERROR: ".

Parameters:

errorPrefix - the error prefix

setHeader

public void setHeader(java.lang.String header)

Sets a request property (header), or multiple request properties separated by "\n". Header name and value are separated by ":". The header name is case-insensitive.

Parameters:

header - request property line

See Also:

setHeader(String, String)

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

Sets a request property (header). The header name is case-insensitive.

Parameters:

key - request property key

value - request property value

setMethod

public void setMethod(HttpOpener.Method method)

Sets the HTTP request method. The default request method is "GET".

Parameters:

method - the request method

setUrl

public void setUrl(java.lang.String url)

Sets the HTTP request URL. The default value for the request URL is "@-", which means it will use the input data as request URL.

Parameters:

url - the request URL

process

public void process(java.lang.String input)

Specified by:

process in interface org.metafacture.framework.ObjectReceiver<java.lang.String>

Overrides:

process in class org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.io.Reader>>