org.shredzone.flattr4j.connector.impl

Class FlattrConnection

java.lang.Object

org.shredzone.flattr4j.connector.impl.FlattrConnection

All Implemented Interfaces:

Connection

public class FlattrConnection
extends Object
implements Connection

Default implementation of Connection.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
FlattrConnection(RequestType type) Creates a new FlattrConnection for the given RequestType.

Method Summary

Modifier and Type	Method and Description
protected String	base64(String str) Base64 encodes a string.
Connection	call(String call) Call to be placed against the URL.
protected HttpURLConnection	createConnection(URL url) Creates a HttpURLConnection to the given url.
Connection	data(FlattrObject data) Data to be transported to the call.
Connection	form(String name, String value) Form parameter to be sent.
protected Charset	getCharset(String contentType) Gets the Charset from the content-type header.
Connection	key(ConsumerKey key) Consumer key to be used.
Connection	parameter(String name, String value) A parameter to be used for a placeholder in the call string.
Connection	parameterArray(String name, String[] value) An array of parameters to be used for a placeholder in the call string.
Connection	query(String name, String value) Query parameter to be used in the URL.
Connection	rateLimit(RateLimit limit) RateLimit object to keep updated.
Collection<FlattrObject>	result() Invokes the call and returns a Collection of FlattrObject as response.
FlattrObject	singleResult() Invokes the call and returns a single FlattrObject as response.
Connection	token(AccessToken token) Access token to be used for calls that require authentication.
Connection	url(String url) Base URL to connect to.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlattrConnection

public FlattrConnection(RequestType type)

Creates a new FlattrConnection for the given RequestType.

Parameters:

type - RequestType to be used

Method Detail

url

public Connection url(String url)

Description copied from interface: Connection

Base URL to connect to. This must be an absolute URL.

Specified by:

url in interface Connection

Parameters:

url - URL to connect to.

Returns:

this

call

public Connection call(String call)

Description copied from interface: Connection

Call to be placed against the URL. The call string may contain placeholders that are prepended by a colon (e.g. "users/:username/things").

If no call is set, the Connection.url(String) is invoked unchanged.

Specified by:

call in interface Connection

Parameters:

call - Signature of the call to be invoked

Returns:

this

token

public Connection token(AccessToken token)

Description copied from interface: Connection

Access token to be used for calls that require authentication. If no AccessToken is set, the call will be placed anonymously.

Specified by:

token in interface Connection

Parameters:

token - AccessToken to be used

Returns:

this

key

public Connection key(ConsumerKey key)

Description copied from interface: Connection

Consumer key to be used. Usually, this is only necessary in the OAuth2 authentication process.

Specified by:

key in interface Connection

Parameters:

key - ConsumerKey to be used

Returns:

this

parameter

public Connection parameter(String name,
                            String value)

Description copied from interface: Connection

A parameter to be used for a placeholder in the call string. If the call string does not contain a matching placeholder, it will be silently ignored.

Specified by:

parameter in interface Connection

Parameters:

name - Parameter name, without colon prepended

value - Value to be used. Will be URL encoded.

Returns:

this

parameterArray

public Connection parameterArray(String name,
                                 String[] value)

Description copied from interface: Connection

An array of parameters to be used for a placeholder in the call string. If the call string does not contain a matching placeholder, it will be silently ignored.

Specified by:

parameterArray in interface Connection

Parameters:

name - Parameter name, without colon prepended

value - Values to be used.

Returns:

this

query

public Connection query(String name,
                        String value)

Description copied from interface: Connection

Query parameter to be used in the URL.

Specified by:

query in interface Connection

Parameters:

name - Parameter name

value - Parameter value

Returns:

this

data

public Connection data(FlattrObject data)

Description copied from interface: Connection

Data to be transported to the call. Requires RequestType.POST or RequestType.PATCH, otherwise an exception will be thrown.

Specified by:

data in interface Connection

Parameters:

data - Data to be sent

Returns:

this

form

public Connection form(String name,
                       String value)

Description copied from interface: Connection

Form parameter to be sent. Requires RequestType.POST, otherwise an exception will be thrown. Do not mix with Connection.data(FlattrObject).

Specified by:

form in interface Connection

Parameters:

name - Parameter name

value - Parameter value

Returns:

this

rateLimit

public Connection rateLimit(RateLimit limit)

Description copied from interface: Connection

RateLimit object to keep updated.

Specified by:

rateLimit in interface Connection

Parameters:

limit - RateLimit object

Returns:

this

result

public Collection<FlattrObject> result()
                                throws FlattrException

Description copied from interface: Connection

Invokes the call and returns a Collection of FlattrObject as response.

Specified by:

result in interface Connection

Returns:

result collection of FlattrObject, may be empty but never null

Throws:

FlattrException - if the call could not be invoked or the web service returned an error

singleResult

public FlattrObject singleResult()
                          throws FlattrException

Description copied from interface: Connection

Invokes the call and returns a single FlattrObject as response.

Specified by:

singleResult in interface Connection

Returns:

result FlattrObject, never null

Throws:

FlattrException - if the call could not be invoked or the web service returned an error

createConnection

protected HttpURLConnection createConnection(URL url)
                                      throws IOException

Creates a HttpURLConnection to the given url. Override to configure the connection.

Parameters:

url - URL to connect to

Returns:

HttpURLConnection that is connected to the url and is preconfigured.

Throws:

IOException

getCharset

protected Charset getCharset(String contentType)

Gets the Charset from the content-type header. If there is no charset, the default charset is returned instead.

Parameters:

contentType - content-type header, may be null

Returns:

Charset

base64

protected String base64(String str)

Base64 encodes a string.

Parameters:

str - String to encode

Returns:

Encoded string