Package com.turo.pushy.apns

Contains classes and interfaces for interacting with the Apple Push Notification service (APNs).

See: Description

Interface Summary

Interface	Description
ApnsClientMetricsListener	A metrics listener receives events from an ApnsClient that can be used to measure the performance and behavior of the client.
ApnsPushNotification	A push notification that can be sent through the Apple Push Notification service (APNs).
PushNotificationResponse<T extends ApnsPushNotification>	A response from the APNs gateway indicating whether a notification was accepted or rejected.

Class Summary

Class	Description
ApnsClient	An APNs client sends push notifications to the APNs gateway.
ApnsClientBuilder	An ApnsClientBuilder constructs new ApnsClient instances.
MockApnsServer	A mock APNs server emulates the behavior of a real APNs server (but doesn't actually deliver notifications to their destinations).
MockApnsServerBuilder	A MockApnsServerBuilder constructs new MockApnsServer instances.

Enum Summary

Enum	Description
DeliveryPriority	An enumeration of delivery priorities for APNs push notifications.

Exception Summary

Exception	Description
ApnsServerException	An exception that indicates that a push notification could not be sent due to an upstream server error.
ClientNotConnectedException	An exception thrown to indicate that a notification could not be sent because the client was not connected.
PushNotificationStillPendingException	An exception that indicates that an attempt to send a notification failed because the same notification has already been sent, but has not yet been resolved.

Package com.turo.pushy.apns Description

Contains classes and interfaces for interacting with the Apple Push Notification service (APNs).

Callers will primarily interact with the ApnsClient class to send push notifications. An ApnsClient maintains a single connection to the APNs gateway and sends notifications using the HTTP/2-based APNs protocol. Notifications are sent asynchronously.

The ApnsPushNotification interface represents a single APNs push notification sent to a single device. A simple concrete implementation of the ApnsPushNotification interface (SimpleApnsPushNotification) and tools for constructing push notification payloads can be found in the com.relayrides.pushy.apns.util package.

Author:

Jon Chambers