A B C D E F G H I 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, ApnsConnectionListener<T>) - Constructor for class com.relayrides.pushy.apns.ApnsConnection

Constructs a new APNs connection.

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

buildPushManager() - Method in class com.relayrides.pushy.apns.PushManagerFactory

Constructs a new PushManager with the settings provided to this factory.

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.

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

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

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

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

D

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

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

E

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

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.

F

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

Listens for failed attempts to connect to an APNs gateway.

FeedbackConnectionException - Exception in com.relayrides.pushy.apns

Signals that an attempt to connect to the APNs feedback service has failed.

FeedbackConnectionException(Throwable) - Constructor for exception com.relayrides.pushy.apns.FeedbackConnectionException

Constructs a new feedback connection exception with the given root cause.

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.

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.

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

Queries the APNs feedback service for expired tokens using a reasonable default timeout.

getExpiredTokens(long, TimeUnit) - Method in class com.relayrides.pushy.apns.PushManager

Queries the APNs feedback service for expired tokens using the given timeout.

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.

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.

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.

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

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

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(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(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(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

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.ExpiredToken

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.

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.

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

A PushManagerFactory is used to configure and construct a new PushManager.

PushManagerFactory(ApnsEnvironment, SSLContext) - Constructor for class com.relayrides.pushy.apns.PushManagerFactory

Constructs a new factory that will construct PushManagers that operate in the given environment with the given credentials.

R

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.

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.

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.

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

Sets the number of concurrent connections constructed PushManagers should maintain to the APNs gateway.

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.

setEventLoopGroup(NioEventLoopGroup) - Method in class com.relayrides.pushy.apns.PushManagerFactory

Sets a custom event loop group to be used by constructed PushMangers.

setLaunchImage(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.

setListenerExecutorService(ExecutorService) - Method in class com.relayrides.pushy.apns.PushManagerFactory

Sets a custom executor service to be used by constructed PushManagers to dispatch notifications to registered listeners.

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.

setQueue(BlockingQueue<T>) - Method in class com.relayrides.pushy.apns.PushManagerFactory

Sets the queue to be used to pass new notifications to constructed PushManagers.

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).

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 delivery expiration time.

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.util.SimpleApnsPushNotification

U

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.RejectedNotificationReason

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

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 P R S T U V W