com.zenvia.api.sdk.client.apache

Class Client

java.lang.Object

com.zenvia.api.sdk.client.AbstractClient

com.zenvia.api.sdk.client.apache.Client

All Implemented Interfaces:

Closeable, AutoCloseable

public class Client
extends AbstractClient

API Client that is backed by Apache HTTP Client. This class also relies on Jackson for JSON handling.

Its is meant to not have too many dependencies.

Sending WhatsApp text message example:

    Client client = new Client( "API TOKEN" );
    client.getChannel( "whatsapp" ).sendMessage(
      "WhatsApp-business-id", "receiver-phone-number", new TextContent( "Text to be sent!" )
    );
  

Since:

0.9.0

Field Summary

Fields inherited from class com.zenvia.api.sdk.client.AbstractClient

DEFAULT_CONNECTION_POOL_TIMEOUT, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_INACTIVITY_TIME_BEFORE_STALE_CHECK, DEFAULT_MAX_CONNECTION_RETRIES, DEFAULT_MAX_CONNECTIONS, DEFAULT_SOCKET_TIMEOUT, DEFAULT_URL

Constructor Summary

Constructors

Constructor and Description
Client(String apiToken) Initializes the connection pool using default configurations.
Client(String apiToken, Integer maxConnections) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, Integer maxConnections, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, Integer maxConnections, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries, Integer connectionPoolTimeout, Integer inactivityTimeBeforeStaleCheck) Initializes the connection pool using the given configurations.
Client(String apiToken, String apiUrl) Initializes the connection pool using default configurations.
Client(String apiToken, String apiUrl, Integer maxConnections) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, String apiUrl, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, String apiUrl, Integer maxConnections, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries) Initializes the connection pool using a mix of the given configurations and below default configurations.
Client(String apiToken, String apiUrl, Integer maxConnections, Integer connectionTimeout, Integer socketTimeout, Integer maxConnectionRetries, Integer connectionPoolTimeout, Integer inactivityTimeBeforeStaleCheck) Initializes the connection pool using the given configurations.

Method Summary

Modifier and Type	Method and Description
<SUBSCRIPTION extends Subscription> SUBSCRIPTION	createSubscription(SUBSCRIPTION subscription)
void	deleteSubscription(String id)
Channel	getChannel(ChannelType channelType)
Channel	getChannel(String channelType)
<SUBSCRIPTION extends Subscription> SUBSCRIPTION	getSubscription(String id)
List<Subscription>	listSubscriptions()
<SUBSCRIPTION extends Subscription> SUBSCRIPTION	updateSubscription(String id, PartialSubscription partialSubscription)
<SUBSCRIPTION extends Subscription> SUBSCRIPTION	updateSubscription(SUBSCRIPTION subscription)

Methods inherited from class com.zenvia.api.sdk.client.AbstractClient

close, getApiUrl, getConnectionPoolTimeout, getConnectionTimeout, getInactivityTimeBeforeStaleCheck, getMaxConnectionRetries, getMaxConnections, getSocketTimeout, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(String apiToken)

Initializes the connection pool using default configurations.

• Maximum connections: 100
• Connection timeout: 25000 ms
• Socket timeout: 60000 ms
• Maximum connection retries: 4
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

Since:

0.9.0

Client

public Client(String apiToken,
              Integer maxConnections)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Connection timeout: 25000 ms
• Socket timeout: 60000 ms
• Maximum connection retries: 4
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Maximum connections: 100
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              Integer maxConnections,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              Integer maxConnections,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries,
              Integer connectionPoolTimeout,
              Integer inactivityTimeBeforeStaleCheck)

Initializes the connection pool using the given configurations.

Parameters:

apiToken - An API token generated on Zenvia API console.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

connectionPoolTimeout - The amount of time in milliseconds for a request to timeout when wait for a free connection from the pool. When zero, it means it will wait indefinitely for a connection. When null, the default 0 will be used instead.

inactivityTimeBeforeStaleCheck - The amount of time in milliseconds of inactivity necessary to trigger a stale check on idle pool connections. When null, the default 5000 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              String apiUrl)

Initializes the connection pool using default configurations.

• Maximum connections: 100
• Connection timeout: 25000 ms
• Socket timeout: 60000 ms
• Maximum connection retries: 4
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

apiUrl - The URL for the API service. Normally the value "https://api.zenvia.com" is used, but can be useful for testing, and in rare cases, for custom integrations. When null, the default "https://api.zenvia.com" will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              String apiUrl,
              Integer maxConnections)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Connection timeout: 25000 ms
• Socket timeout: 60000 ms
• Maximum connection retries: 4
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

apiUrl - The URL for the API service. Normally the value "https://api.zenvia.com" is used, but can be useful for testing, and in rare cases, for custom integrations. When null, the default "https://api.zenvia.com" will be used instead.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              String apiUrl,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Maximum connections: 100
• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

apiUrl - The URL for the API service. Normally the value "https://api.zenvia.com" is used, but can be useful for testing, and in rare cases, for custom integrations. When null, the default "https://api.zenvia.com" will be used instead.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              String apiUrl,
              Integer maxConnections,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries)

Initializes the connection pool using a mix of the given configurations and below default configurations.

• Connection pool timeout: 0 ms
• Inactivity time before stale checking: 5000 ms

Parameters:

apiToken - An API token generated on Zenvia API console.

apiUrl - The URL for the API service. Normally the value "https://api.zenvia.com" is used, but can be useful for testing, and in rare cases, for custom integrations. When null, the default "https://api.zenvia.com" will be used instead.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

Since:

0.9.0

Client

public Client(String apiToken,
              String apiUrl,
              Integer maxConnections,
              Integer connectionTimeout,
              Integer socketTimeout,
              Integer maxConnectionRetries,
              Integer connectionPoolTimeout,
              Integer inactivityTimeBeforeStaleCheck)

Initializes the connection pool using the given configurations.

Parameters:

apiToken - An API token generated on Zenvia API console.

apiUrl - The URL for the API service. Normally the value "https://api.zenvia.com" is used, but can be useful for testing, and in rare cases, for custom integrations. When null, the default "https://api.zenvia.com" will be used instead.

maxConnections - The maximum number of connections in the pool. When null, the default 100 will be used instead.

connectionTimeout - The amount of time in milliseconds for a connection attempt to timeout. When null, the default 25000 will be used instead.

socketTimeout - The amount of time in milliseconds for a server reply to timeout. When null, the default 60000 will be used instead.

maxConnectionRetries - The maximum amount of connection retries automatically made by the HTTP client in case of connection failure. When null, the default 4 will be used instead.

connectionPoolTimeout - The amount of time in milliseconds for a request to timeout when wait for a free connection from the pool. When zero, it means it will wait indefinitely for a connection. When null, the default 0 will be used instead.

inactivityTimeBeforeStaleCheck - The amount of time in milliseconds of inactivity necessary to trigger a stale check on idle pool connections. When null, the default 5000 will be used instead.

Since:

0.9.0

Method Detail

getChannel

public Channel getChannel(String channelType)
                   throws UnsupportedChannelException

Overrides:

getChannel in class AbstractClient

Throws:

UnsupportedChannelException

getChannel

public Channel getChannel(ChannelType channelType)
                   throws UnsupportedChannelException

Overrides:

getChannel in class AbstractClient

Throws:

UnsupportedChannelException

listSubscriptions

public List<Subscription> listSubscriptions()
                                     throws UnsuccessfulRequestException,
                                            HttpSocketTimeoutException,
                                            HttpConnectionTimeoutException,
                                            HttpConnectionFailException,
                                            HttpIOException

Overrides:

listSubscriptions in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException

createSubscription

public <SUBSCRIPTION extends Subscription> SUBSCRIPTION createSubscription(SUBSCRIPTION subscription)
                                                                    throws UnsuccessfulRequestException,
                                                                           HttpSocketTimeoutException,
                                                                           HttpConnectionTimeoutException,
                                                                           HttpConnectionFailException,
                                                                           HttpIOException

Overrides:

createSubscription in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException

getSubscription

public <SUBSCRIPTION extends Subscription> SUBSCRIPTION getSubscription(String id)
                                                                 throws UnsuccessfulRequestException,
                                                                        HttpSocketTimeoutException,
                                                                        HttpConnectionTimeoutException,
                                                                        HttpConnectionFailException,
                                                                        HttpIOException

Overrides:

getSubscription in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException

updateSubscription

public <SUBSCRIPTION extends Subscription> SUBSCRIPTION updateSubscription(SUBSCRIPTION subscription)
                                                                    throws UnsuccessfulRequestException,
                                                                           HttpSocketTimeoutException,
                                                                           HttpConnectionTimeoutException,
                                                                           HttpConnectionFailException,
                                                                           HttpIOException

Overrides:

updateSubscription in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException

updateSubscription

public <SUBSCRIPTION extends Subscription> SUBSCRIPTION updateSubscription(String id,
                                                                           PartialSubscription partialSubscription)
                                                                    throws UnsuccessfulRequestException,
                                                                           HttpSocketTimeoutException,
                                                                           HttpConnectionTimeoutException,
                                                                           HttpConnectionFailException,
                                                                           HttpIOException

Overrides:

updateSubscription in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException

deleteSubscription

public void deleteSubscription(String id)
                        throws UnsuccessfulRequestException,
                               HttpSocketTimeoutException,
                               HttpConnectionTimeoutException,
                               HttpConnectionFailException,
                               HttpIOException

Overrides:

deleteSubscription in class AbstractClient

Throws:

UnsuccessfulRequestException

HttpSocketTimeoutException

HttpConnectionTimeoutException

HttpConnectionFailException

HttpIOException