com.flyingspaniel.nava.request

Class Request

java.lang.Object

com.flyingspaniel.nava.emit.Emitter

com.flyingspaniel.nava.utils.EmittingCallbackFn<String,Response>

com.flyingspaniel.nava.request.Request

All Implemented Interfaces:

Callback<String,Response>, Emit.IEmitter, Emit.IListener<String>, Fn<String,Response>, Callable<Response>

public class Request
extends EmittingCallbackFn<String,Response>
implements Callable<Response>

Since:

Copyright (c) 2013 by Morgan Conrad

Author:

Morgan Conrad

See Also:

This software is released under the MIT License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Milestone Enum for the steps in the HTTPRequest.call() method, used for error-tracking...

Nested classes/interfaces inherited from class com.flyingspaniel.nava.utils.EmittingCallbackFn

EmittingCallbackFn.NOP<IN>

Nested classes/interfaces inherited from interface com.flyingspaniel.nava.callback.Callback

Callback.ProducesMore<IN,OUT,MORE>, Callback.ProducesMultiple<IN,OUT>

Nested classes/interfaces inherited from interface com.flyingspaniel.nava.fp.Fn

Fn.AndN<IN,OUT>, Fn.Base<IN,OUT>, Fn.N<IN,OUT>, Fn.Pdouble, Fn.Pint

Field Summary

Fields

Modifier and Type	Field and Description
protected Request.Milestone	attempting
protected String	baseUrl
static String	FORM_DATA
protected HTTPMultiMap	formDataMMap
static String	HEADER_DATA
protected HTTPMultiMap	headersMMap
protected int	maxRetries
protected HTTPMethod	method
protected boolean	methodMustUpload
protected HashWrapper.Linked	options
protected InputStream	pipeIn
protected OutputStream	pipeOut
protected OutputStream	pipeTo
static String	QUERY_DATA
protected HTTPMultiMap	queryMMap Three possible multimaps used for the query, header, and formData
protected Response	response401
protected Object	uploadMe
protected boolean	useStrictRFC3986

Fields inherited from class com.flyingspaniel.nava.utils.EmittingCallbackFn

nextCallback

Fields inherited from class com.flyingspaniel.nava.emit.Emitter

allowDuplicates, idMap, maxListeners

Constructor Summary

Constructors

Constructor and Description
Request()
Request(String urlOrOptions)
Request(String baseUrl, HTTPMethod method)
Request(String baseUrl, HTTPMethod method, Map<String,Object> options) Full constructor
Request(String baseUrl, Map<String,Object> options)

Method Summary

Methods

Modifier and Type	Method and Description
Request	acceptCharset(String charset)
Request	auth(String user, String pass, boolean sendImmediately)
Response	call()
Response	call1()
Response	callback(Exception ex, String urlOrOptions, Object... more) The callback method
protected void	checkMethodMustUpload()
protected long	copy(InputStream input, OutputStream output, boolean emit)
protected void	doAuth(HttpURLConnection conn)
protected String	doAWS(Map awsMap)
protected String	doSubstituteMultiMapData(String upload) Useful for POST - replaces $FORMDATA, $HEADERS or $QUERY in the upload string with the corresponding contents of the respective MultiMaps.
protected void	doUpload(OutputStream outputStream)
Request	form(Map<String,Object> map) Adds form data from a map
Request	form(Object... fieldValuePairs) Adds form data
Request	form(String jsonString) Adds form data from a JSON String
protected String	fullURL() Split off for testing, but a subclass may want to override
protected URLEncoding	getEncoding()
Request	headers(Map<String,Object> map) Adds header data from a Map
Request	headers(Object... fieldValuePairs) Adds header data
Request	headers(String jsonString) Adds header data from a JSON String
Map<String,Object>	JSONtoMap(String jsonString) Converts JSON String to a Map.
Request	method(HTTPMethod method)
protected void	noteMilestone(Request.Milestone attempting) Subclasses who wish to log or send progress can override this
Request	oauth(String jsonString)
protected String	objectToStringForUpload(Object object) Converts Object to a String for uploading Subclasses might want to override and do JSON, XML, etc...
protected HttpURLConnection	openConnection() Split off for testing, but a subclass may want to override
Request	options(Map<String,Object> optionMap) Set all options from a Map.
Request	options(String jsonString) Set all options based on a JSON String
Request	pipe(InputStream in) Sets an input stream for uploading data
Request	pipe(OutputStream out) Sets an outputstream for downloading
protected HttpURLConnection	prepareConnection(HttpURLConnection conn)
Request	query(Map<String,Object> map)
Request	query(Object... fieldValuePairs) Adds field value pairs to the query
Request	query(String jsonString) Adds query data from a JSON String
Request	setForm(Object... fieldValuePairs) Sets form data, replacing any previous data for th field
Request	setHeaders(Object... fieldValuePairs) Replaces all previous header data for the given key value pairs
Request	setQuery(Object... fieldValuePairs) Replaces all previous query data for the given key value pairs
Request	upload(Object toBeUploaded) Sets data to be uploaded: a File or InputStream, a Map which will get converted to JSON or anything else will be sent as a String
Request	uploadSubstitution(boolean b) If uploadSubstitution is activated, text like ${FORM_DATA} in the upload data will be replaced with values from the FORM
Request	useStrictRFC3986(boolean b)

Methods inherited from class com.flyingspaniel.nava.utils.EmittingCallbackFn

failFast, failSlow, fn1, fn2, getNextCallback, handleEvent, handleException, setNextCallback

Methods inherited from class com.flyingspaniel.nava.emit.Emitter

addListener, createListenerList, emit, emit, fireEvent, getListenerList, listenerCount, listeners, on, once, removeAllListeners, removeListener, setMaxListeners

Methods inherited from class java.lang.Object

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

Field Detail

FORM_DATA

public static final String FORM_DATA

See Also:

Constant Field Values

HEADER_DATA

public static final String HEADER_DATA

See Also:

Constant Field Values

QUERY_DATA

public static final String QUERY_DATA

See Also:

Constant Field Values

useStrictRFC3986

protected boolean useStrictRFC3986

methodMustUpload

protected boolean methodMustUpload

maxRetries

protected int maxRetries

options

protected HashWrapper.Linked options

queryMMap

protected final HTTPMultiMap queryMMap

Three possible multimaps used for the query, header, and formData

See Also:

form(Object...), headers(Object...), query(Object...)

headersMMap

protected final HTTPMultiMap headersMMap

formDataMMap

protected final HTTPMultiMap formDataMMap

baseUrl

protected String baseUrl

method

protected HTTPMethod method

pipeOut

protected OutputStream pipeOut

pipeIn

protected InputStream pipeIn

uploadMe

protected Object uploadMe

pipeTo

protected OutputStream pipeTo

attempting

protected volatile Request.Milestone attempting

response401

protected Response response401

Constructor Detail

Request

public Request(String baseUrl,
       HTTPMethod method,
       Map<String,Object> options)

Full constructor

Parameters:

baseUrl - may include a query part but you have to encode it yourself

method -

options - may be null

Request

public Request(String baseUrl,
       HTTPMethod method)

Request

public Request(String baseUrl,
       Map<String,Object> options)

Request

public Request(String urlOrOptions)

Request

public Request()

Method Detail

callback

public Response callback(Exception ex,
                String urlOrOptions,
                Object... more)
                  throws Exception

Description copied from interface: Callback

The callback method

Specified by:

callback in interface Callback<String,Response>

Specified by:

callback in class EmittingCallbackFn<String,Response>

Parameters:

ex - null, or an Exception thrown from an earlier callback. You should test for this!

urlOrOptions - input data, probably coming from a previous callback

more - additional input data (rarely used)

Returns:

result of processing

Throws:

Exception

options

public Request options(Map<String,Object> optionMap)

Set all options from a Map.

Parameters:

optionMap - if null nothing happens

Returns:

this

options

public Request options(String jsonString)

Set all options based on a JSON String

Parameters:

jsonString - if null or empty nothing happens

Returns:

this

acceptCharset

public Request acceptCharset(String charset)

auth

public Request auth(String user,
           String pass,
           boolean sendImmediately)

form

public Request form(Object... fieldValuePairs)

Adds form data

Parameters:

fieldValuePairs - should be an even number of field/value pairs

Returns:

this

form

public Request form(Map<String,Object> map)

Adds form data from a map

Parameters:

map - may be null or empty

Returns:

this

form

public Request form(String jsonString)

Adds form data from a JSON String

Parameters:

jsonString - if null or empty nothing happens

Returns:

this

setForm

public Request setForm(Object... fieldValuePairs)

Sets form data, replacing any previous data for th field

Parameters:

fieldValuePairs - if null or [], deletes all previous form data

Returns:

this

headers

public Request headers(Object... fieldValuePairs)

Adds header data

Parameters:

fieldValuePairs -

Returns:

this

headers

public Request headers(Map<String,Object> map)

Adds header data from a Map

Parameters:

map - non-null, may be empty

Returns:

this

headers

public Request headers(String jsonString)

Adds header data from a JSON String

Parameters:

jsonString - if null or empty nothing happens

Returns:

this

setHeaders

public Request setHeaders(Object... fieldValuePairs)

Replaces all previous header data for the given key value pairs

Parameters:

fieldValuePairs - if empty, clears all headers for all keys

Returns:

this

method

public Request method(HTTPMethod method)

oauth

public Request oauth(String jsonString)

pipe

public Request pipe(InputStream in)

Sets an input stream for uploading data

Parameters:

in -

Returns:

this

pipe

public Request pipe(OutputStream out)

Sets an outputstream for downloading

Parameters:

out -

Returns:

this

query

public Request query(Object... fieldValuePairs)

Adds field value pairs to the query

Parameters:

fieldValuePairs -

Returns:

this

query

public Request query(Map<String,Object> map)

query

public Request query(String jsonString)

Adds query data from a JSON String

Parameters:

jsonString - if null or empty nothing happens

Returns:

this

setQuery

public Request setQuery(Object... fieldValuePairs)

Replaces all previous query data for the given key value pairs

Parameters:

fieldValuePairs - if empty, clears all query data for all keys

Returns:

this

upload

public Request upload(Object toBeUploaded)

Sets data to be uploaded: a File or InputStream, a Map which will get converted to JSON or anything else will be sent as a String

Parameters:

toBeUploaded -

Returns:

this

uploadSubstitution

public Request uploadSubstitution(boolean b)

If uploadSubstitution is activated, text like ${FORM_DATA} in the upload data will be replaced with values from the FORM

Parameters:

b -

Returns:

this

useStrictRFC3986

public Request useStrictRFC3986(boolean b)

call

public Response call()

Specified by:

call in interface Callable<Response>

call1

public Response call1()

JSONtoMap

public Map<String,Object> JSONtoMap(String jsonString)

Converts JSON String to a Map. I'm using org.json.simple but subclasses could change

Parameters:

jsonString - if null or empty return empty map

Returns:

Map, may be empty

objectToStringForUpload

protected String objectToStringForUpload(Object object)

Converts Object to a String for uploading Subclasses might want to override and do JSON, XML, etc...

copy

protected long copy(InputStream input,
        OutputStream output,
        boolean emit)
             throws IOException

Throws:

IOException

doSubstituteMultiMapData

protected String doSubstituteMultiMapData(String upload)

Useful for POST - replaces $FORMDATA, $HEADERS or $QUERY in the upload string with the corresponding contents of the respective MultiMaps.

Returns:

the String that will be uploaded

See Also:

uploadSubstitution(boolean), FORM_DATA, HEADER_DATA, QUERY_DATA

getEncoding

protected URLEncoding getEncoding()

noteMilestone

protected void noteMilestone(Request.Milestone attempting)

Subclasses who wish to log or send progress can override this

Parameters:

attempting -

openConnection

protected HttpURLConnection openConnection()
                                    throws IOException

Split off for testing, but a subclass may want to override

Returns:

Throws:

IOException

fullURL

protected String fullURL()
                  throws IOException

Split off for testing, but a subclass may want to override

Returns:

full URL + and query/form stuff

Throws:

IOException

prepareConnection

protected HttpURLConnection prepareConnection(HttpURLConnection conn)

doAuth

protected void doAuth(HttpURLConnection conn)

doAWS

protected String doAWS(Map awsMap)
                throws IOException

Throws:

IOException

checkMethodMustUpload

protected void checkMethodMustUpload()

doUpload

protected void doUpload(OutputStream outputStream)
                 throws IOException

Throws:

IOException