A B C D E F G H I M P R S T U V W

A

addCustomProperty(String, Object) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Adds a custom property to the payload.

ApnsConnection<T extends ApnsPushNotification> - Class in com.relayrides.pushy.apns

A connection to an APNs gateway.

ApnsConnection(ApnsEnvironment, SSLContext, NioEventLoopGroup, ApnsConnectionConfiguration, ApnsConnectionListener<T>, String) - Constructor for class com.relayrides.pushy.apns.ApnsConnection

Constructs a new APNs connection.

ApnsConnectionConfiguration - Class in com.relayrides.pushy.apns

A set of user-configurable options that affect the behavior of an ApnsConnection.

ApnsConnectionConfiguration() - Constructor for class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Creates a new connection configuration object with all options set to their default values.

ApnsConnectionConfiguration(ApnsConnectionConfiguration) - Constructor for class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Creates a new connection configuration object with all options set to the values in the given connection configuration object.

ApnsConnectionListener<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns

An ApnsConnectionListener receives lifecycle events from ApnsConnection instances.

ApnsEnvironment - Class in com.relayrides.pushy.apns

An APNs environment is a set of servers that provide push notification services.

ApnsEnvironment(String, int, String, int) - Constructor for class com.relayrides.pushy.apns.ApnsEnvironment

Constructs a new APenvironment with the given host names and ports.

ApnsPayloadBuilder - Class in com.relayrides.pushy.apns.util

A utility class for constructing JSON payloads suitable for inclusion in APNs push notifications.

ApnsPayloadBuilder() - Constructor for class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Constructs a new payload builder.

ApnsPushNotification - Interface in com.relayrides.pushy.apns

A push notification that can be sent through the Apple Push Notification service (APNs).

B

buildWithDefaultMaximumLength() - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Returns a JSON representation of the push notification payload under construction.

buildWithMaximumLength(int) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Returns a JSON representation of the push notification payload under construction.

C

com.relayrides.pushy.apns - package com.relayrides.pushy.apns

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

com.relayrides.pushy.apns.util - package com.relayrides.pushy.apns.util

Contains classes for working with APNs tokens and payloads.

connect() - Method in class com.relayrides.pushy.apns.ApnsConnection

Asynchronously connects to the APNs gateway in this connection's environment.

connect() - Method in class com.relayrides.pushy.apns.FeedbackServiceConnection

Connects to the APNs feedback service and waits for expired tokens to arrive.

createDefaultSSLContext(String, String) - Static method in class com.relayrides.pushy.apns.util.SSLContextUtil

Creates a new SSL context using the JVM default trust managers and the certificates in the given PKCS12 file.

createDefaultSSLContext(InputStream, String) - Static method in class com.relayrides.pushy.apns.util.SSLContextUtil

Creates a new SSL context using the JVM default trust managers and the certificates in the given PKCS12 InputStream.

createDefaultSSLContext(KeyStore, char[]) - Static method in class com.relayrides.pushy.apns.util.SSLContextUtil

Creates a new SSL context using the JVM default trust managers and the certificates in the given keystore.

D

DEFAULT_SENT_NOTIFICATION_BUFFER_CAPACITY - Static variable in class com.relayrides.pushy.apns.ApnsConnection

DEFAULT_SOUND_FILENAME - Static variable in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

The name of the iOS default push notification sound ("default").

DeliveryPriority - Enum in com.relayrides.pushy.apns

An enumeration of delivery priorities for APNs push notifications.

E

equals(Object) - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

equals(Object) - Method in class com.relayrides.pushy.apns.ExpiredToken

equals(Object) - Method in class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

equals(Object) - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

equals(Object) - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

ExpiredToken - Class in com.relayrides.pushy.apns

Represents a device token that the APN Feedback Service has reported as expired.

ExpiredTokenListener<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns

Listens for expired tokens from the APNs feedback service.

F

FailedConnectionListener<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns

Listens for failed attempts to connect to an APNs gateway.

FeedbackConnectionConfiguration - Class in com.relayrides.pushy.apns

A set of user-configurable options that affect the behavior of a FeedbackServiceConnection.

FeedbackConnectionConfiguration() - Constructor for class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

Creates a new connection configuration object with all options set to their default values.

FeedbackConnectionConfiguration(FeedbackConnectionConfiguration) - Constructor for class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

Creates a new connection configuration object with all options set to the values in the given connection configuration object.

FeedbackServiceConnection - Class in com.relayrides.pushy.apns

A connection to the APNs feedback service that listens for expired tokens, then disconnects after a period of inactivity.

FeedbackServiceConnection(ApnsEnvironment, SSLContext, NioEventLoopGroup, FeedbackConnectionConfiguration, FeedbackServiceListener, String) - Constructor for class com.relayrides.pushy.apns.FeedbackServiceConnection

Constructs a new feedback client that connects to the feedback service in the given environment with the credentials and key/trust managers in the given SSL context.

G

getApnsGatewayHost() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the host name of the APNs gateway in this environment.

getApnsGatewayPort() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the TCP port for the APNs gateway in this environment.

getByErrorCode(byte) - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Gets the rejection reason associated with the given error code.

getCloseAfterInactivityTime() - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Returns the time, in seconds, between the sending of the last push notification and connection closure.

getConcurrentConnectionCount() - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Returns the number of concurrent connections to be maintained by push managers created with this configuration.

getConnectionConfiguration() - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Returns the configuration to be used for connections created by push managers created with this configuration.

getDeliveryInvalidationTime() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the time at which Apple's push notification service should stop trying to deliver this push notification.

getDeliveryInvalidationTime() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the time at which this push notification is no longer valid and should no longer be delivered.

getErrorCode() - Method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns the one-byte error code associated with this rejection reason.

getExpiration() - Method in class com.relayrides.pushy.apns.ExpiredToken

Returns the time, rounded to the nearest second, when APNs determined that the application no longer exists on the device.

getFeedbackConnectionConfiguration() - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Returns the configuration to be used for connections to the APNs feedback service created by push managers with this configuration.

getFeedbackHost() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the host name of the APNs feedback service in this environment.

getFeedbackPort() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the TCP port for the APNs feedback service in this environment.

getGracefulShutdownTimeout() - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Returns the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately.

getName() - Method in class com.relayrides.pushy.apns.PushManager

Returns the human-readable name of this push manager.

getPayload() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the JSON-encoded payload of this push notification.

getPayload() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the payload to include in this push notification.

getPriority() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the priority with which this push notification should be sent to the receiving device.

getPriority() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the priority with which this push notification should be delivered to the receiving device.

getProductionEnvironment() - Static method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns an APNs environment for connecting to Apple's production servers.

getQueue() - Method in class com.relayrides.pushy.apns.PushManager

Returns the queue of messages to be sent to the APNs gateway.

getReadTimeout() - Method in class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

Returns the time, in seconds, after which this connection will be closed if no new expired tokens have been received.

getSandboxEnvironment() - Static method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns an APNs environment for connecting to Apple's sandbox servers.

getSendAttemptLimit() - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Returns the number of notifications a connection may attempt to send before shutting down.

getSentNotificationBufferCapacity() - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Returns the sent notification buffer capacity for connections created with this configuration.

getToken() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the token of the device to which this push notification is to be sent.

getToken() - Method in class com.relayrides.pushy.apns.ExpiredToken

Returns the token APNs has reported as expired.

getToken() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the token of the device to which this push notification should be delivered.

H

handleConnectionClosure(ApnsConnection<T>) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that the given connection has disconnected from the previously-connected APNs gateway and can no longer send push notifications.

handleConnectionClosure(FeedbackServiceConnection) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionClosure(ApnsConnection<T>) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionFailure(ApnsConnection<T>, Throwable) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that the given connection attempted to connect to an APNs gateway, but failed.

handleConnectionFailure(FeedbackServiceConnection, Throwable) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionFailure(ApnsConnection<T>, Throwable) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionSuccess(ApnsConnection<T>) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that the given connection successfully connected to an APNs gateway and is ready to send push notifications.

handleConnectionSuccess(FeedbackServiceConnection) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionSuccess(ApnsConnection<T>) - Method in class com.relayrides.pushy.apns.PushManager

handleConnectionWritabilityChange(ApnsConnection<T>, boolean) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that the given connection has changed its writability state.

handleConnectionWritabilityChange(ApnsConnection<T>, boolean) - Method in class com.relayrides.pushy.apns.PushManager

handleExpiredToken(FeedbackServiceConnection, ExpiredToken) - Method in class com.relayrides.pushy.apns.PushManager

handleExpiredTokens(PushManager<? extends T>, Collection<ExpiredToken>) - Method in interface com.relayrides.pushy.apns.ExpiredTokenListener

Handles a collection of expired tokens received from the APNs feedback service.

handleFailedConnection(PushManager<? extends T>, Throwable) - Method in interface com.relayrides.pushy.apns.FailedConnectionListener

Handles a failed attempt to connect to the APNs gateway.

handleRejectedNotification(ApnsConnection<T>, T, RejectedNotificationReason) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that a notification sent via the given connection was definitively rejected by the APNs gateway.

handleRejectedNotification(ApnsConnection<T>, T, RejectedNotificationReason) - Method in class com.relayrides.pushy.apns.PushManager

handleRejectedNotification(PushManager<? extends T>, T, RejectedNotificationReason) - Method in interface com.relayrides.pushy.apns.RejectedNotificationListener

Handles a permanent push notification rejection.

handleUnprocessedNotifications(ApnsConnection<T>, Collection<T>) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that notifications that had previously been sent to an APNs gateway by the given connection were not processed by the gateway and should be sent again later.

handleUnprocessedNotifications(ApnsConnection<T>, Collection<T>) - Method in class com.relayrides.pushy.apns.PushManager

handleWriteFailure(ApnsConnection<T>, T, Throwable) - Method in interface com.relayrides.pushy.apns.ApnsConnectionListener

Indicates that the given connection failed to send a push notification to an APNs gateway.

handleWriteFailure(ApnsConnection<T>, T, Throwable) - Method in class com.relayrides.pushy.apns.PushManager

hashCode() - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

hashCode() - Method in class com.relayrides.pushy.apns.ExpiredToken

hashCode() - Method in class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

hashCode() - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

hashCode() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

I

isShutDown() - Method in class com.relayrides.pushy.apns.PushManager

Indicates whether this push manager has been shut down (or is in the process of shutting down).

isStarted() - Method in class com.relayrides.pushy.apns.PushManager

Indicates whether this push manager has been started and not yet shut down.

M

MalformedTokenStringException - Exception in com.relayrides.pushy.apns.util

Signals that a given string was not could not be parsed as an APNs token.

MalformedTokenStringException(String) - Constructor for exception com.relayrides.pushy.apns.util.MalformedTokenStringException

Constructs a new malformed token string exception with the given detail message.

P

PushManager<T extends ApnsPushNotification> - Class in com.relayrides.pushy.apns

Push managers manage connections to the APNs gateway and send notifications from their queue.

PushManager(ApnsEnvironment, SSLContext, NioEventLoopGroup, ExecutorService, BlockingQueue<T>, PushManagerConfiguration, String) - Constructor for class com.relayrides.pushy.apns.PushManager

Constructs a new PushManager that operates in the given environment with the given SSL context and the given number of parallel connections to APNs.

PushManagerConfiguration - Class in com.relayrides.pushy.apns

A set of user-configurable options that affect the behavior of a PushManager and its associated ApnsConnections.

PushManagerConfiguration() - Constructor for class com.relayrides.pushy.apns.PushManagerConfiguration

Constructs a new push manager configuration object with all options set to their default values.

PushManagerConfiguration(PushManagerConfiguration) - Constructor for class com.relayrides.pushy.apns.PushManagerConfiguration

Constructs a new push manager configuration object with all options set to the values in the given configuration object.

R

registerExpiredTokenListener(ExpiredTokenListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Registers a listener for expired tokens received from the feedback service.

registerFailedConnectionListener(FailedConnectionListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Registers a listener for failed attempts to connect to the APNs gateway.

registerRejectedNotificationListener(RejectedNotificationListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Registers a listener for notifications rejected by APNs for specific reasons.

RejectedNotificationListener<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns

Listens for permanent push notification rejections.

RejectedNotificationReason - Enum in com.relayrides.pushy.apns

An enumeration of error codes that may be returned by APNs to indicate why a push notification was rejected.

requestExpiredTokens() - Method in class com.relayrides.pushy.apns.PushManager

Begins an asynchronous attempt to get a list of expired tokens from the feedback service.

S

sendNotification(T) - Method in class com.relayrides.pushy.apns.ApnsConnection

Asynchronously sends a push notification to the connected APNs gateway.

setAlertBody(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the literal text of the alert message to be shown for the push notification.

setAlertTitle(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets a short description of the notification purpose.

setBadgeNumber(Integer) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the number to display as the badge of the icon of the application that receives the push notification.

setCategoryName(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the name of the action category name for interactive remote notifications.

setCloseAfterInactivityTime(Integer) - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Sets the time, in seconds, between the sending of the last push notification and connection closure.

setConcurrentConnectionCount(int) - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Sets the number of concurrent connections to be maintained by push managers created with this configuration.

setConnectionConfiguration(ApnsConnectionConfiguration) - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Sets the configuration to be used for connections created by push managers created with this configuration.

setContentAvailable(boolean) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets whether the payload under construction should contain a flag that indicates that new content is available to be downloaded in the background by the receiving app.

setFeedbackConnectionConfiguration(FeedbackConnectionConfiguration) - Method in class com.relayrides.pushy.apns.PushManagerConfiguration

Sets the configuration to be used for connections to the APNs feedback service created by push managers with this configuration.

setGracefulShutdownTimeout(Integer) - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Sets the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately.

setLaunchImageFileName(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the image to be shown when the receiving app launches in response to this push notification.

setLocalizedActionButtonKey(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the key of a string in the receiving app's localized string list to be used as the label of the "action" button if the push notification is displayed as an alert.

setLocalizedAlertMessage(String, String[]) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the key of a message in the receiving app's localized string list to be shown for the push notification.

setLocalizedAlertTitle(String, String[]) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the key of the title string in the receiving app's localized string list to be shown for the push notification.

setReadTimeout(int) - Method in class com.relayrides.pushy.apns.FeedbackConnectionConfiguration

Sets the time, in seconds, after which this connection will be closed if no new expired tokens have been received.

setSendAttemptLimit(Integer) - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Sets the number of notifications a connection may attempt to send before shutting down.

setSentNotificationBufferCapacity(int) - Method in class com.relayrides.pushy.apns.ApnsConnectionConfiguration

Sets the sent notification buffer capacity for connections created with this configuration.

setShowActionButton(boolean) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets whether an "action" button should be shown if the push notification is displayed as an alert.

setSoundFileName(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the name of the sound file to play when the push notification is received.

shutdown() - Method in class com.relayrides.pushy.apns.PushManager

Disconnects from APNs and gracefully shuts down all connections.

shutdown(long) - Method in class com.relayrides.pushy.apns.PushManager

Disconnects from the APNs and gracefully shuts down all connections.

shutdownGracefully() - Method in class com.relayrides.pushy.apns.ApnsConnection

Gracefully and asynchronously shuts down this connection.

shutdownImmediately() - Method in class com.relayrides.pushy.apns.ApnsConnection

Immediately closes this connection (assuming it was ever open).

shutdownImmediately() - Method in class com.relayrides.pushy.apns.FeedbackServiceConnection

Closes this feedback connection as soon as possible.

SimpleApnsPushNotification - Class in com.relayrides.pushy.apns.util

A simple and immutable implementation of the ApnsPushNotification interface.

SimpleApnsPushNotification(byte[], String) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token and payload.

SimpleApnsPushNotification(byte[], String, Date) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token, payload, and expiration time.

SimpleApnsPushNotification(byte[], String, DeliveryPriority) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token, payload, and delivery priority.

SimpleApnsPushNotification(byte[], String, Date, DeliveryPriority) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token, payload, delivery expiration time, and delivery priority.

SSLContextUtil - Class in com.relayrides.pushy.apns.util

A utility class for creating SSL contexts for use with a PushManager.

SSLContextUtil() - Constructor for class com.relayrides.pushy.apns.util.SSLContextUtil

start() - Method in class com.relayrides.pushy.apns.PushManager

Opens all connections to APNs and prepares to send push notifications.

T

tokenBytesToString(byte[]) - Static method in class com.relayrides.pushy.apns.util.TokenUtil

Converts an array of bytes into a string of hexadecimal characters representing the values in the array.

tokenStringToByteArray(String) - Static method in class com.relayrides.pushy.apns.util.TokenUtil

Converts a string of hexadecimal characters into a byte array.

TokenUtil - Class in com.relayrides.pushy.apns.util

A utility class for converting APNS device tokens between byte arrays and hexadecimal strings.

toString() - Method in class com.relayrides.pushy.apns.ApnsConnection

toString() - Method in class com.relayrides.pushy.apns.ExpiredToken

toString() - Method in class com.relayrides.pushy.apns.FeedbackServiceConnection

toString() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

U

unregisterExpiredTokenListener(ExpiredTokenListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Un-registers an expired token listener.

unregisterFailedConnectionListener(FailedConnectionListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Un-registers a connection failure listener.

unregisterRejectedNotificationListener(RejectedNotificationListener<? super T>) - Method in class com.relayrides.pushy.apns.PushManager

Un-registers a rejected notification listener.

V

valueOf(String) - Static method in enum com.relayrides.pushy.apns.DeliveryPriority

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.relayrides.pushy.apns.DeliveryPriority

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForPendingWritesToFinish() - Method in class com.relayrides.pushy.apns.ApnsConnection

Waits for all pending write operations to finish.

A B C D E F G H I M P R S T U V W