Class DiscogsConnection

java.lang.Object

com.amilesend.client.connection.Connection<GsonFactory>

com.amilesend.discogs.connection.DiscogsConnection

public class DiscogsConnection
extends com.amilesend.client.connection.Connection<GsonFactory>

Wraps a OkHttpClient that manages authentication refresh and parsing responses to corresponding POJO types.

See Also:

• AuthManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiscogsConnection.DiscogsConnectionBuilder<C extends DiscogsConnection, B extends DiscogsConnection.DiscogsConnectionBuilder<C,B>>

Nested classes/interfaces inherited from class com.amilesend.client.connection.Connection

com.amilesend.client.connection.Connection.ConnectionBuilder<G,C,B>, com.amilesend.client.connection.Connection.Headers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_DISPOSITION
static final String	CONTENT_LENGTH
static final String	DEFAULT_BASE_URL
static final String	LOCATION
static final String	TEXT_CSV_TYPE

Fields inherited from class com.amilesend.client.connection.Connection

FORM_DATA_CONTENT_TYPE, FORM_DATA_MEDIA_TYPE, JSON_CONTENT_TYPE, JSON_MEDIA_TYPE

Method Summary

Modifier and Type	Method	Description
static DiscogsConnection.DiscogsConnectionBuilder<?,?>	builder()
DownloadInformation	download(@NonNull okhttp3.Request request, @NonNull Path folderPath, @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)	Downloads the contents for the given request to the specified folderPath.
okhttp3.Response	execute(@NonNull okhttp3.Request request)
<T> T	execute(@NonNull okhttp3.Request request, @NonNull com.amilesend.client.parse.parser.GsonParser<T> parser)
AuthVerifier	getAuthVerifier()	The authorization verifier used to check if API calls require authentication prior to invoking the API.
okhttp3.Request.Builder	newRequestBuilderForDownload()	Creates a new Request.Builder with pre-configured headers for a download request that expects a CSV-formatted response.
UploadInformation	upload(@NonNull okhttp3.Request request, String filename)	Uploads the contents for a given request.

Methods inherited from class com.amilesend.client.connection.Connection

getAuthManager, getBaseUrl, getGsonFactory, getHttpClient, getRetryStrategy, getUserAgent, isGzipContentEncodingEnabled, newRequestBuilder

Methods inherited from class Object

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

Field Details

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

See Also:

• Constant Field Values

TEXT_CSV_TYPE

public static final String TEXT_CSV_TYPE

See Also:

• Constant Field Values

LOCATION

public static final String LOCATION

See Also:

• Constant Field Values

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION

See Also:

• Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

• Constant Field Values

Method Details

newRequestBuilderForDownload

public okhttp3.Request.Builder newRequestBuilderForDownload()

Creates a new Request.Builder with pre-configured headers for a download request that expects a CSV-formatted response.

Returns:

the request builder

execute

public <T> T execute(@NonNull okhttp3.Request request,
 @NonNull com.amilesend.client.parse.parser.GsonParser<T> parser)
              throws com.amilesend.client.connection.ConnectionException

Overrides:

execute in class com.amilesend.client.connection.Connection<GsonFactory>

Throws:

com.amilesend.client.connection.ConnectionException

upload

public UploadInformation upload(@NonNull okhttp3.Request request,
 String filename)

Uploads the contents for a given request.

Parameters:

request - the request

filename - the name of the file that is uploaded

Returns:

the upload information

Throws:

com.amilesend.client.connection.ConnectionException - if an error occurred while uploading the content for the request

See Also:

• UploadInformation

execute

public okhttp3.Response execute(@NonNull okhttp3.Request request)
                         throws com.amilesend.client.connection.ConnectionException

Overrides:

execute in class com.amilesend.client.connection.Connection<GsonFactory>

Throws:

com.amilesend.client.connection.ConnectionException

download

public DownloadInformation download(@NonNull okhttp3.Request request,
 @NonNull Path folderPath,
 @NonNull com.amilesend.client.connection.file.TransferProgressCallback callback)
                             throws com.amilesend.client.connection.ConnectionException

Downloads the contents for the given request to the specified folderPath.

Parameters:

request - the request

folderPath - the path of the folder to download the content to

callback - the TransferProgressCallback call to invoke to report download transfer progress

Returns:

the download information

Throws:

com.amilesend.client.connection.ConnectionException - if an error occurred while downloading the content for the request

See Also:

• DownloadInformation

builder

public static DiscogsConnection.DiscogsConnectionBuilder<?,?> builder()

getAuthVerifier

public AuthVerifier getAuthVerifier()

The authorization verifier used to check if API calls require authentication prior to invoking the API.