com.urbanairship.api.client

Class UrbanAirshipClient

java.lang.Object

com.urbanairship.api.client.UrbanAirshipClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class UrbanAirshipClient
extends java.lang.Object
implements java.io.Closeable

The UrbanAirshipClient class handles HTTP requests to the Urban Airship API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UrbanAirshipClient.Builder UrbanAirshipClient builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EU_OAUTH_URI
static java.lang.String	EU_URI
java.lang.String	oAuthBaseUri
static java.lang.String	US_OAUTH_URI
static java.lang.String	US_URI

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying HTTP client's thread pool.
<T> Response	execute(Request<T> request)
<T> Response	execute(Request<T> request, ResponseCallback callback)
<T> java.util.concurrent.Future<Response>	executeAsync(Request<T> request)
<T> java.util.concurrent.Future<Response>	executeAsync(Request<T> request, ResponseCallback callback)
java.lang.String	getAppKey() Get the app key.
java.util.Optional<java.lang.String>	getAppSecret() Get the app secret.
java.util.Optional<java.lang.String>	getBaseUri() Get the Base URI.
java.util.Optional<java.lang.String>	getBearerToken() Get the bearer token.
java.util.Optional<OAuthCredentials>	getOAuthCredentials() Get the OAuthCredentials.
RequestClient	getRequestClient() Get the request client.
java.util.Optional<java.lang.Boolean>	getUseEuropeanSite() Get useEuropeanSite.
java.lang.String	getUserAgent(java.lang.String appKey) Retrieve the client user agent.
static UrbanAirshipClient.Builder	newBuilder() New UrbanAirshipClient Builder.

Methods inherited from class java.lang.Object

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

Field Detail

US_URI

public static final java.lang.String US_URI

See Also:

Constant Field Values

EU_URI

public static final java.lang.String EU_URI

See Also:

Constant Field Values

EU_OAUTH_URI

public static final java.lang.String EU_OAUTH_URI

See Also:

Constant Field Values

US_OAUTH_URI

public static final java.lang.String US_OAUTH_URI

See Also:

Constant Field Values

oAuthBaseUri

public final java.lang.String oAuthBaseUri

Method Detail

newBuilder

public static UrbanAirshipClient.Builder newBuilder()

New UrbanAirshipClient Builder.

Returns:

UrbanAirshipClient Builder.

executeAsync

public <T> java.util.concurrent.Future<Response> executeAsync(Request<T> request,
                                                              ResponseCallback callback)

executeAsync

public <T> java.util.concurrent.Future<Response> executeAsync(Request<T> request)

execute

public <T> Response execute(Request<T> request)
                     throws java.io.IOException

Throws:

java.io.IOException

execute

public <T> Response execute(Request<T> request,
                            ResponseCallback callback)
                     throws java.io.IOException

Throws:

java.io.IOException

getUserAgent

public java.lang.String getUserAgent(java.lang.String appKey)

Retrieve the client user agent.

Parameters:

appKey - String

Returns:

The user agent.

close

public void close()
           throws java.io.IOException

Close the underlying HTTP client's thread pool.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getBaseUri

public java.util.Optional<java.lang.String> getBaseUri()

Get the Base URI.

Returns:

The base URI.

getUseEuropeanSite

public java.util.Optional<java.lang.Boolean> getUseEuropeanSite()

Get useEuropeanSite.

Returns:

The useEuropeanSite value.

getAppKey

public java.lang.String getAppKey()

Get the app key.

Returns:

The app key.

getAppSecret

public java.util.Optional<java.lang.String> getAppSecret()

Get the app secret.

Returns:

The app secret.

getBearerToken

public java.util.Optional<java.lang.String> getBearerToken()

Get the bearer token.

Returns:

The bearer token.

getOAuthCredentials

public java.util.Optional<OAuthCredentials> getOAuthCredentials()

Get the OAuthCredentials.

Returns:

The OAuthCredentials

getRequestClient

public RequestClient getRequestClient()

Get the request client.

Returns:

The RequestClient.