com.twilio.rest.api.v2010.account.NotificationReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.api.v2010.account;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.converter.DateConverter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
public class NotificationReader extends Reader {
private String pathAccountSid;
private Integer log;
private LocalDate messageDate;
private LocalDate messageDateBefore;
private LocalDate messageDateAfter;
/**
* Construct a new NotificationReader.
*/
public NotificationReader() {
}
/**
* Construct a new NotificationReader.
*
* @param pathAccountSid The SID of the Account that created the resources to
* read
*/
public NotificationReader(final String pathAccountSid) {
this.pathAccountSid = pathAccountSid;
}
/**
* Only read notifications of the specified log level. Can be: `0` to read only
* ERROR notifications or `1` to read only WARNING notifications. By default,
* all notifications are read..
*
* @param log Filter by log level
* @return this
*/
public NotificationReader setLog(final Integer log) {
this.log = log;
return this;
}
/**
* Only show notifications for the specified date, formatted as `YYYY-MM-DD`.
* You can also specify an inequality, such as `<=YYYY-MM-DD` for messages
* logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages
* logged at or after midnight on a date..
*
* @param messageDate Filter by date
* @return this
*/
public NotificationReader setMessageDate(final LocalDate messageDate) {
this.messageDateBefore = null;
this.messageDateAfter = null;
this.messageDate = messageDate;
return this;
}
/**
* Only show notifications for the specified date, formatted as `YYYY-MM-DD`.
* You can also specify an inequality, such as `<=YYYY-MM-DD` for messages
* logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages
* logged at or after midnight on a date..
*
* @param messageDateBefore Filter by date
* @return this
*/
public NotificationReader setMessageDateBefore(final LocalDate messageDateBefore) {
this.messageDate = null;
this.messageDateBefore = messageDateBefore;
return this;
}
/**
* Only show notifications for the specified date, formatted as `YYYY-MM-DD`.
* You can also specify an inequality, such as `<=YYYY-MM-DD` for messages
* logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages
* logged at or after midnight on a date..
*
* @param messageDateAfter Filter by date
* @return this
*/
public NotificationReader setMessageDateAfter(final LocalDate messageDateAfter) {
this.messageDate = null;
this.messageDateAfter = messageDateAfter;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Notification ResourceSet
*/
@Override
public ResourceSet read(final TwilioRestClient client) {
return new ResourceSet<>(this, client, firstPage(client));
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Notification ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
this.pathAccountSid = this.pathAccountSid == null ? client.getAccountSid() : this.pathAccountSid;
Request request = new Request(
HttpMethod.GET,
Domains.API.toString(),
"/2010-04-01/Accounts/" + this.pathAccountSid + "/Notifications.json"
);
addQueryParams(request);
return pageForRequest(client, request);
}
/**
* Retrieve the target page from the Twilio API.
*
* @param targetUrl API-generated URL for the requested results page
* @param client TwilioRestClient with which to make the request
* @return Notification ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page getPage(final String targetUrl, final TwilioRestClient client) {
this.pathAccountSid = this.pathAccountSid == null ? client.getAccountSid() : this.pathAccountSid;
Request request = new Request(
HttpMethod.GET,
targetUrl
);
return pageForRequest(client, request);
}
/**
* Retrieve the next page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Next Page
*/
@Override
public Page nextPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getNextPageUrl(Domains.API.toString())
);
return pageForRequest(client, request);
}
/**
* Retrieve the previous page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Previous Page
*/
@Override
public Page previousPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getPreviousPageUrl(Domains.API.toString())
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Notification Resources for a given request.
*
* @param client TwilioRestClient with which to make the request
* @param request Request to generate a page for
* @return Page for the Request
*/
private Page pageForRequest(final TwilioRestClient client, final Request request) {
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Notification read failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return Page.fromJson(
"notifications",
response.getContent(),
Notification.class,
client.getObjectMapper()
);
}
/**
* Add the requested query string arguments to the Request.
*
* @param request Request to add query string arguments to
*/
private void addQueryParams(final Request request) {
if (log != null) {
request.addQueryParam("Log", log.toString());
}
if (messageDate != null) {
request.addQueryParam("MessageDate", messageDate.format(DateTimeFormatter.ofPattern(Request.QUERY_STRING_DATE_FORMAT)));
} else if (messageDateAfter != null || messageDateBefore != null) {
request.addQueryDateRange("MessageDate", messageDateAfter, messageDateBefore);
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}