Index (JavaPNS 2.3.2 API)

A B C D E F G I J K N P Q R S T U V W

A

add(PushedNotification) - Method in class javapns.notification.PushedNotifications
add(Payload, String) - Method in class javapns.notification.transmission.NotificationThread
add(Payload, Device) - Method in class javapns.notification.transmission.NotificationThread
add(PayloadPerDevice) - Method in class javapns.notification.transmission.NotificationThread
add(Payload, String) - Method in class javapns.notification.transmission.NotificationThreads
add(Payload, Device) - Method in class javapns.notification.transmission.NotificationThreads
add(PayloadPerDevice) - Method in class javapns.notification.transmission.NotificationThreads
add(Payload, String) - Method in interface javapns.notification.transmission.PushQueue: Queue a message for delivery.
add(Payload, Device) - Method in interface javapns.notification.transmission.PushQueue: Queue a message for delivery.
add(PayloadPerDevice) - Method in interface javapns.notification.transmission.PushQueue: Queue a message for delivery.
addAlert(String) - Method in class javapns.notification.PushNotificationPayload: Add a simple alert message.
addAll(Collection<? extends PushedNotification>) - Method in class javapns.notification.PushedNotifications
addBadge(int) - Method in class javapns.notification.PushNotificationPayload: Add a badge.
addCustomAlertActionLocKey(String) - Method in class javapns.notification.PushNotificationPayload: Create a custom alert (if none exist) and add a custom text for the right button of the popup.
addCustomAlertBody(String) - Method in class javapns.notification.PushNotificationPayload: Create a custom alert (if none exist) and add a body to the custom alert.
addCustomAlertLocArgs(List) - Method in class javapns.notification.PushNotificationPayload: Create a custom alert (if none exist) and add sub-parameters for the loc-key parameter.
addCustomAlertLocKey(String) - Method in class javapns.notification.PushNotificationPayload: Create a custom alert (if none exist) and add a loc-key parameter.
addCustomDictionary(String, String) - Method in class javapns.notification.Payload: Add a custom dictionnary with a string value
addCustomDictionary(String, int) - Method in class javapns.notification.Payload: Add a custom dictionnary with a int value
addCustomDictionary(String, List) - Method in class javapns.notification.Payload: Add a custom dictionnary with multiple values
addCustomDictionary(String, Object) - Method in class javapns.notification.Payload: Add a custom dictionnary with object
addDevice(String, String) - Method in interface javapns.devices.DeviceFactory: Deprecated.

Add a device to the map
addDevice(String, String) - Method in class javapns.devices.implementations.basic.BasicDeviceFactory: Deprecated.

Add a device to the map
addDevice(String, String) - Method in class javapns.notification.PushNotificationManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
addElement(PushedNotification) - Method in class javapns.notification.PushedNotifications
addSound(String) - Method in class javapns.notification.PushNotificationPayload: Add a sound.
alert(String) - Static method in class javapns.notification.PushNotificationPayload: Create a pre-defined payload with a simple alert message.
alert(String, Object, String, boolean, Object) - Static method in class javapns.Push: Push a simple alert to one or more devices.
AppleFeedbackServer - Interface in javapns.feedback: Interface representing a connection to an Apple Feedback Server
AppleFeedbackServerBasicImpl - Class in javapns.feedback: Basic implementation of the AppleFeedbackServer interface, intended to facilitate rapid deployment.
AppleFeedbackServerBasicImpl(Object, String, boolean) - Constructor for class javapns.feedback.AppleFeedbackServerBasicImpl: Communication settings for interacting with Apple's default production or sandbox feedback server.
AppleNotificationServer - Interface in javapns.notification: Interface representing a connection to an Apple Notification Server
AppleNotificationServerBasicImpl - Class in javapns.notification: Basic implementation of the AppleNotificationServer interface, intended to facilitate rapid deployment.
AppleNotificationServerBasicImpl(Object, String, boolean) - Constructor for class javapns.notification.AppleNotificationServerBasicImpl: Communication settings for interacting with Apple's default production or sandbox notification server.
AppleServer - Interface in javapns.communication: Common interface of all classes representing a connection to any Apple server.
AppleServerBasicImpl - Class in javapns.communication: A basic and abstract implementation of the AppleServer interface intended to facilitate rapid deployment.
AppleServerBasicImpl(Object, String, String) - Constructor for class javapns.communication.AppleServerBasicImpl: Constructs a AppleServerBasicImpl object.
asDevices(Object) - Static method in class javapns.devices.Devices
asPayloadsPerDevices(Object) - Static method in class javapns.devices.Devices
asSimulationOnly() - Method in class javapns.notification.Payload: Enables a special simulation mode which causes the library to behave as usual *except* that at the precise point where the payload would actually be streamed out to Apple, it is not.

B

badge(int) - Static method in class javapns.notification.PushNotificationPayload: Create a pre-defined payload with a badge.
badge(int, Object, String, boolean, Object) - Static method in class javapns.Push: Push a simple badge number to one or more devices.
BasicDevice - Class in javapns.devices.implementations.basic: This class is used to represent a Device (iPhone)
BasicDevice() - Constructor for class javapns.devices.implementations.basic.BasicDevice
BasicDevice(String) - Constructor for class javapns.devices.implementations.basic.BasicDevice: Default constructor.
BasicDeviceFactory - Class in javapns.devices.implementations.basic: Deprecated.
BasicDeviceFactory() - Constructor for class javapns.devices.implementations.basic.BasicDeviceFactory: Deprecated.

Constructs a VolatileDeviceFactory

C

clearPushedNotifications() - Method in class javapns.notification.transmission.NotificationThread: Clear the internal list of PushedNotification objects.
clearPushedNotifications() - Method in class javapns.notification.transmission.NotificationThreads: Clear the internal list of PushedNotification objects maintained in each thread.
clearPushedNotifications() - Method in interface javapns.notification.transmission.PushQueue: Clear the internal lists of PushedNotification objects maintained by this queue.
combined(String, int, String) - Static method in class javapns.notification.PushNotificationPayload: Create a pre-defined payload with a simple alert message, a badge and a sound.
combined(String, int, String, Object, String, boolean, Object) - Static method in class javapns.Push: Push a notification combining an alert, a badge and a sound.
CommunicationException - Exception in javapns.communication.exceptions
CommunicationException(String, Exception) - Constructor for exception javapns.communication.exceptions.CommunicationException
complex() - Static method in class javapns.notification.PushNotificationBigPayload
complex() - Static method in class javapns.notification.PushNotificationPayload: Create an empty payload which you can configure later.
ConnectionToAppleServer - Class in javapns.communication: Class representing an abstract connection to an Apple server
ConnectionToAppleServer(AppleServer) - Constructor for class javapns.communication.ConnectionToAppleServer: Builds a connection to an Apple server.
ConnectionToAppleServer(AppleServer, KeyStore) - Constructor for class javapns.communication.ConnectionToAppleServer: Builds a connection to an Apple server.
ConnectionToFeedbackServer - Class in javapns.feedback: Class representing a connection to a specific Feedback Server.
ConnectionToFeedbackServer(AppleFeedbackServer) - Constructor for class javapns.feedback.ConnectionToFeedbackServer
ConnectionToFeedbackServer(AppleNotificationServer, KeyStore) - Constructor for class javapns.feedback.ConnectionToFeedbackServer
ConnectionToNotificationServer - Class in javapns.notification: Connection details specific to the Notification Service.
ConnectionToNotificationServer(AppleNotificationServer) - Constructor for class javapns.notification.ConnectionToNotificationServer
ConnectionToNotificationServer(AppleNotificationServer, KeyStore) - Constructor for class javapns.notification.ConnectionToNotificationServer
contentAvailable() - Static method in class javapns.notification.NewsstandNotificationPayload: Create a pre-defined payload with a content-available property set to 1.
contentAvailable(Object, String, boolean, Object) - Static method in class javapns.Push: Push a content-available notification for Newsstand.

D

DEVELOPMENT_HOST - Static variable in interface javapns.feedback.AppleFeedbackServer
DEVELOPMENT_HOST - Static variable in interface javapns.notification.AppleNotificationServer
DEVELOPMENT_PORT - Static variable in interface javapns.feedback.AppleFeedbackServer
DEVELOPMENT_PORT - Static variable in interface javapns.notification.AppleNotificationServer
Device - Interface in javapns.devices: This is the common interface for all Devices.
DeviceFactory - Interface in javapns.devices: Deprecated.
Phasing out DeviceFactory because it has become irrelevant in the new library architecture
Devices - Class in javapns.devices
Devices() - Constructor for class javapns.devices.Devices
DuplicateDeviceException - Exception in javapns.devices.exceptions: Thrown when a Device already exist and we try to add it a second time
DuplicateDeviceException() - Constructor for exception javapns.devices.exceptions.DuplicateDeviceException: Constructor
DuplicateDeviceException(String) - Constructor for exception javapns.devices.exceptions.DuplicateDeviceException: Constructor with custom message

E

ErrorResponsePacketReceivedException - Exception in javapns.notification.exceptions: Thrown when an error response packet was received from an APNS server.
ErrorResponsePacketReceivedException(ResponsePacket) - Constructor for exception javapns.notification.exceptions.ErrorResponsePacketReceivedException
eventAllThreadsFinished(NotificationThreads) - Method in interface javapns.notification.transmission.NotificationProgressListener
eventAllThreadsStarted(NotificationThreads) - Method in interface javapns.notification.transmission.NotificationProgressListener
eventConnectionRestarted(NotificationThread) - Method in interface javapns.notification.transmission.NotificationProgressListener
eventCriticalException(NotificationThread, Exception) - Method in interface javapns.notification.transmission.NotificationProgressListener
eventThreadFinished(NotificationThread) - Method in interface javapns.notification.transmission.NotificationProgressListener
eventThreadStarted(NotificationThread) - Method in interface javapns.notification.transmission.NotificationProgressListener

F

feedback(Object, String, boolean) - Static method in class javapns.Push: Retrieve a list of devices that should be removed from future notification lists.
FeedbackServiceManager - Class in javapns.feedback: Class for interacting with a specific Feedback Service.
FeedbackServiceManager() - Constructor for class javapns.feedback.FeedbackServiceManager: Constructs a FeedbackServiceManager with a default basic DeviceFactory.
findFailedNotifications(List<PushedNotification>) - Static method in class javapns.notification.PushedNotification: Filters a list of pushed notifications and returns only the ones that failed.
findSuccessfulNotifications(List<PushedNotification>) - Static method in class javapns.notification.PushedNotification: Filters a list of pushed notifications and returns only the ones that were successful.
fromJSON(String) - Static method in class javapns.notification.PushNotificationBigPayload
fromJSON(String) - Static method in class javapns.notification.PushNotificationPayload: Create a PushNotificationPayload object from a preformatted JSON payload.

G

getCharacterEncoding() - Method in class javapns.notification.Payload: Returns the character encoding that will be used by getPayloadAsBytes().
getCommand() - Method in class javapns.notification.ResponsePacket: Returns the response's command number.
getCriticalException() - Method in class javapns.notification.transmission.NotificationThread: If this thread experienced a critical exception (communication error, keystore issue, etc.), this method returns the exception.
getCriticalExceptions() - Method in class javapns.notification.transmission.NotificationThread: Wrap a critical exception (if any occurred) into a List to satisfy the NotificationQueue interface contract.
getCriticalExceptions() - Method in class javapns.notification.transmission.NotificationThreads: Get a list of critical exceptions that threads experienced.
getCriticalExceptions() - Method in interface javapns.notification.transmission.PushQueue: Get a list of critical exceptions that underlying threads experienced.
getDelayBetweenThreads() - Method in class javapns.notification.transmission.NotificationThreads: Get the amount of time that the library will wait after starting a thread and before starting the next one.
getDevice(String) - Method in interface javapns.devices.DeviceFactory: Deprecated.

Get a device according to his id
getDevice(String) - Method in class javapns.devices.implementations.basic.BasicDeviceFactory: Deprecated.

Get a device according to his id
getDevice() - Method in class javapns.notification.PayloadPerDevice
getDevice() - Method in class javapns.notification.PushedNotification: Returns the device that the payload was pushed to.
getDevice(String) - Method in class javapns.notification.PushNotificationManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
getDeviceFactory() - Method in class javapns.feedback.FeedbackServiceManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
getDeviceFactory() - Method in class javapns.notification.PushNotificationManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
getDeviceId() - Method in interface javapns.devices.Device: An id representing a particular device.
getDeviceId() - Method in class javapns.devices.implementations.basic.BasicDevice: Getter
getDevices(AppleFeedbackServer) - Method in class javapns.feedback.FeedbackServiceManager
getDevices() - Method in class javapns.notification.transmission.NotificationThread: Get the list of devices associated with this thread.
getException() - Method in class javapns.notification.PushedNotification: Get the exception that occurred while trying to push this notification, if any.
getExpiry() - Method in class javapns.notification.Payload: Return the number of seconds after which this payload should expire.
getExpiry() - Method in class javapns.notification.PushedNotification: Returns the expiration date of the push notification.
getFailedNotifications() - Method in class javapns.notification.PushedNotifications: Filter a list of pushed notifications and return only the ones that failed.
getFailedNotifications() - Method in class javapns.notification.transmission.NotificationThread: Returns list of all notifications that this thread attempted to push but that failed.
getFailedNotifications() - Method in class javapns.notification.transmission.NotificationThreads: Get a list of all notifications that all threads attempted to push but that failed.
getFeedbackServerHost() - Method in interface javapns.feedback.AppleFeedbackServer
getFeedbackServerHost() - Method in class javapns.feedback.AppleFeedbackServerBasicImpl
getFeedbackServerPort() - Method in interface javapns.feedback.AppleFeedbackServer
getFeedbackServerPort() - Method in class javapns.feedback.AppleFeedbackServerBasicImpl
getFirstMessageIdentifier() - Method in class javapns.notification.transmission.NotificationThread: Returns the first message identifier generated by this thread.
getIdentifier() - Method in class javapns.notification.PushedNotification: Returns the connection-unique identifier referred to by error-response packets.
getIdentifier() - Method in class javapns.notification.ResponsePacket: Returns the response's identifier, which matches the pushed notification's.
getKeystorePassword() - Method in interface javapns.communication.AppleServer: Returns the keystore's password.
getKeystorePassword() - Method in class javapns.communication.AppleServerBasicImpl
getKeystoreStream() - Method in interface javapns.communication.AppleServer: Returns a stream to a keystore.
getKeystoreStream() - Method in class javapns.communication.AppleServerBasicImpl
getKeystoreType() - Method in interface javapns.communication.AppleServer: Returns the format used to produce the keystore (typically PKCS12).
getKeystoreType() - Method in class javapns.communication.AppleServerBasicImpl
getLastMessageIdentifier() - Method in class javapns.notification.transmission.NotificationThread: Returns the last message identifier generated by this thread.
getLastRegister() - Method in interface javapns.devices.Device
getLastRegister() - Method in class javapns.devices.implementations.basic.BasicDevice: Getter
getLatestTransmissionAttempt() - Method in class javapns.notification.PushedNotification: Returns a human-friendly description of the number of attempts made to transmit the notification.
getListener() - Method in class javapns.notification.transmission.NotificationThread
getListener() - Method in class javapns.notification.transmission.NotificationThreads: Get the progress listener, if any is attached.
getMaximumPayloadSize() - Method in class javapns.notification.PushNotificationBigPayload: Return the maximum payload size in bytes.
getMaximumPayloadSize() - Method in class javapns.notification.PushNotificationPayload: Return the maximum payload size in bytes.
getMaxNotificationsPerConnection() - Method in class javapns.notification.transmission.NotificationThread
getMessage() - Method in class javapns.notification.ResponsePacket: Returns a humand-friendly error message, as documented by Apple.
getMessages() - Method in class javapns.notification.transmission.NotificationThread: Get the messages associated with this thread, if any.
getNotificationServerHost() - Method in interface javapns.notification.AppleNotificationServer
getNotificationServerHost() - Method in class javapns.notification.AppleNotificationServerBasicImpl
getNotificationServerPort() - Method in interface javapns.notification.AppleNotificationServer
getNotificationServerPort() - Method in class javapns.notification.AppleNotificationServerBasicImpl
getPacket() - Method in exception javapns.notification.exceptions.ErrorResponsePacketReceivedException
getPayload() - Method in class javapns.notification.Payload: Get the actual JSON object backing this payload.
getPayload() - Method in class javapns.notification.PayloadPerDevice
getPayload() - Method in class javapns.notification.PushedNotification: Returns the payload that was pushed.
getPayloadAsBytes() - Method in class javapns.notification.Payload: Get this payload as a byte array using the preconfigured character encoding.
getPayloadSize() - Method in class javapns.notification.Payload: Get the number of bytes that the payload will occupy when streamed.
getProxyHost() - Method in interface javapns.communication.AppleServer: Get the proxy host address currently configured for this specific server.
getProxyHost() - Method in class javapns.communication.AppleServerBasicImpl
getProxyPort() - Method in interface javapns.communication.AppleServer: Get the proxy port currently configured for this specific server.
getProxyPort() - Method in class javapns.communication.AppleServerBasicImpl
getPushedNotifications() - Method in class javapns.notification.transmission.NotificationThread: Returns list of all notifications pushed by this thread (successful or not).
getPushedNotifications() - Method in class javapns.notification.transmission.NotificationThreads: Get a list of all notifications pushed by all threads.
getPushedNotifications() - Method in interface javapns.notification.transmission.PushQueue: Get a list of all notifications pushed through this queue.
getResponse() - Method in class javapns.notification.PushedNotification: If a response packet regarding this notification was received, this method returns it.
getRetryAttempts() - Method in class javapns.notification.PushNotificationManager: Get the number of retry attempts
getServer() - Method in class javapns.communication.ConnectionToAppleServer
getServerHost() - Method in class javapns.communication.ConnectionToAppleServer
getServerHost() - Method in class javapns.feedback.ConnectionToFeedbackServer
getServerHost() - Method in class javapns.notification.ConnectionToNotificationServer
getServerPort() - Method in class javapns.communication.ConnectionToAppleServer
getServerPort() - Method in class javapns.feedback.ConnectionToFeedbackServer
getServerPort() - Method in class javapns.notification.ConnectionToNotificationServer
getSleepBetweenNotifications() - Method in class javapns.notification.transmission.NotificationThread
getSSLSocket() - Method in class javapns.communication.ConnectionToAppleServer: Create a SSLSocket which will be used to send data to Apple
getStatus() - Method in class javapns.notification.ResponsePacket: Returns the response's status code (see getMessage() for a human-friendly status message instead).
getSuccessfulNotifications() - Method in class javapns.notification.PushedNotifications: Filter a list of pushed notifications and return only the ones that were successful.
getSuccessfulNotifications() - Method in class javapns.notification.transmission.NotificationThread: Returns list of all notifications that this thread attempted to push and succeeded.
getSuccessfulNotifications() - Method in class javapns.notification.transmission.NotificationThreads: Get a list of all notifications that all threads attempted to push and succeeded.
getThreadNumber() - Method in class javapns.notification.transmission.NotificationThread: Return the thread number assigned by the parent NotificationThreads object, if any.
getThreads() - Method in class javapns.notification.transmission.NotificationThreads: Get a list of threads created to push notifications.
getToken() - Method in interface javapns.devices.Device: A device token.
getToken() - Method in class javapns.devices.implementations.basic.BasicDevice: Getter
getTransmissionAttempts() - Method in class javapns.notification.PushedNotification: Returns the number of attempts that have been made to transmit the notification.

I

initializeConnection(AppleNotificationServer) - Method in class javapns.notification.PushNotificationManager: Initialize a connection and create a SSLSocket
InvalidCertificateChainException - Exception in javapns.communication.exceptions: Thrown when we try to contact Apple with an invalid keystore or certificate chain.
InvalidCertificateChainException() - Constructor for exception javapns.communication.exceptions.InvalidCertificateChainException: Constructor
InvalidCertificateChainException(String) - Constructor for exception javapns.communication.exceptions.InvalidCertificateChainException: Constructor with custom message
InvalidDeviceTokenFormatException - Exception in javapns.devices.exceptions: Thrown when a device token cannot be parsed (invalid format).
InvalidDeviceTokenFormatException(String) - Constructor for exception javapns.devices.exceptions.InvalidDeviceTokenFormatException
InvalidDeviceTokenFormatException(String, String) - Constructor for exception javapns.devices.exceptions.InvalidDeviceTokenFormatException
InvalidKeystoreFormatException - Exception in javapns.communication.exceptions: Thrown when we try to contact Apple with an invalid keystore format.
InvalidKeystoreFormatException() - Constructor for exception javapns.communication.exceptions.InvalidKeystoreFormatException: Constructor
InvalidKeystoreFormatException(String) - Constructor for exception javapns.communication.exceptions.InvalidKeystoreFormatException: Constructor with custom message
InvalidKeystorePasswordException - Exception in javapns.communication.exceptions: Thrown when we try to contact Apple with an invalid password for the keystore.
InvalidKeystorePasswordException() - Constructor for exception javapns.communication.exceptions.InvalidKeystorePasswordException: Constructor
InvalidKeystorePasswordException(String) - Constructor for exception javapns.communication.exceptions.InvalidKeystorePasswordException: Constructor with custom message
InvalidKeystoreReferenceException - Exception in javapns.communication.exceptions: Thrown when we try to contact Apple with an invalid keystore format.
InvalidKeystoreReferenceException() - Constructor for exception javapns.communication.exceptions.InvalidKeystoreReferenceException: Constructor
InvalidKeystoreReferenceException(Object) - Constructor for exception javapns.communication.exceptions.InvalidKeystoreReferenceException: Constructor with custom message
InvalidKeystoreReferenceException(String) - Constructor for exception javapns.communication.exceptions.InvalidKeystoreReferenceException: Constructor with custom message
isBusy() - Method in class javapns.notification.transmission.NotificationThread: Determine if this thread is busy.
isEnhancedNotificationFormatEnabled() - Static method in class javapns.notification.PushNotificationManager: Check if the enhanced notification format is currently enabled.
isEstimatedPayloadSizeAllowedAfterAdding(String, Object) - Method in class javapns.notification.Payload: Validate if the estimated payload size after adding a given property will be allowed.
isPayloadSizeEstimatedWhenAdding() - Method in class javapns.notification.Payload: Indicates if payload size is estimated and controlled when adding properties (default is false).
isSuccessful() - Method in class javapns.notification.PushedNotification: Returns true if no response packet was received for this notification, or if one was received but is not an error-response (ie command 8), or if one was received but its status is 0 (no error occurred).
isTransmissionCompleted() - Method in class javapns.notification.PushedNotification: Indicates if the notification has been streamed successfully to Apple's server.
isTrustAllServerCertificates() - Method in class javapns.notification.PushNotificationManager: Get the status of the "trust all server certificates" feature to simplify SSL communications.
isValidErrorMessage() - Method in class javapns.notification.ResponsePacket: Determine if this packet is a valid error-response packet.

J

javapns - package javapns: The JavaPNS library
javapns.communication - package javapns.communication: Classes for communicating with Apple servers.
javapns.communication.exceptions - package javapns.communication.exceptions: Communication-related exceptions thrown by the javapns library.
javapns.devices - package javapns.devices: Classes representing mobile devices.
javapns.devices.exceptions - package javapns.devices.exceptions: Device-related exceptions thrown by the javapns library.
javapns.devices.implementations.basic - package javapns.devices.implementations.basic: A basic non-persistent implementation for devices.
javapns.feedback - package javapns.feedback: Classes for interacting with the Apple Feedback Service.
javapns.notification - package javapns.notification: Classes for pushing notifications through Apple servers.
javapns.notification.exceptions - package javapns.notification.exceptions: Notification-related exceptions thrown by the javapns library.
javapns.notification.management - package javapns.notification.management: Specific payloads for Apple's MDM technology
javapns.notification.transmission - package javapns.notification.transmission: Specialized classes for transmitting notifications to large number of devices.

K

KEYSTORE_TYPE_JKS - Static variable in class javapns.communication.ConnectionToAppleServer
KEYSTORE_TYPE_PKCS12 - Static variable in class javapns.communication.ConnectionToAppleServer
KeystoreException - Exception in javapns.communication.exceptions: Thrown when we try to contact Apple with an invalid keystore format.
KeystoreException(String) - Constructor for exception javapns.communication.exceptions.KeystoreException: Constructor with custom message
KeystoreException(String, Exception) - Constructor for exception javapns.communication.exceptions.KeystoreException: Constructor with custom message
KeystoreManager - Class in javapns.communication: Class responsible for dealing with keystores.
KeystoreManager() - Constructor for class javapns.communication.KeystoreManager

N

NewsstandNotificationPayload - Class in javapns.notification: A Newsstand-specific payload compatible with the Apple Push Notification Service.
NotificationProgressListener - Interface in javapns.notification.transmission: An event listener for monitoring progress of NotificationThreads
NotificationThread - Class in javapns.notification.transmission: Pushes payloads asynchroneously using a dedicated thread.
NotificationThread(NotificationThreads, PushNotificationManager, AppleNotificationServer, Payload, Object) - Constructor for class javapns.notification.transmission.NotificationThread: Create a grouped thread in LIST mode for pushing a single payload to a list of devices and coordinating with a parent NotificationThreads object.
NotificationThread(NotificationThreads, PushNotificationManager, AppleNotificationServer, Object) - Constructor for class javapns.notification.transmission.NotificationThread: Create a grouped thread in LIST mode for pushing individual payloads to a list of devices and coordinating with a parent NotificationThreads object.
NotificationThread(PushNotificationManager, AppleNotificationServer, Payload, Object) - Constructor for class javapns.notification.transmission.NotificationThread: Create a standalone thread in LIST mode for pushing a single payload to a list of devices.
NotificationThread(PushNotificationManager, AppleNotificationServer, Object) - Constructor for class javapns.notification.transmission.NotificationThread: Create a standalone thread in LIST mode for pushing individual payloads to a list of devices.
NotificationThread(NotificationThreads, PushNotificationManager, AppleNotificationServer) - Constructor for class javapns.notification.transmission.NotificationThread: Create a grouped thread in QUEUE mode, awaiting messages to push.
NotificationThread(PushNotificationManager, AppleNotificationServer) - Constructor for class javapns.notification.transmission.NotificationThread: Create a standalone thread in QUEUE mode, awaiting messages to push.
NotificationThread(AppleNotificationServer) - Constructor for class javapns.notification.transmission.NotificationThread: Create a standalone thread in QUEUE mode, awaiting messages to push.
NotificationThread.MODE - Enum in javapns.notification.transmission: Working modes supported by Notification Threads.
NotificationThreads - Class in javapns.notification.transmission: Pushes a payload to a large number of devices using multiple threads
NotificationThreads(AppleNotificationServer, Payload, List<Device>, int) - Constructor for class javapns.notification.transmission.NotificationThreads: Create the specified number of notification threads and spread the devices evenly between the threads.
NotificationThreads(AppleNotificationServer, List<PayloadPerDevice>, int) - Constructor for class javapns.notification.transmission.NotificationThreads: Create the specified number of notification threads and spread the messages evenly between the threads.
NotificationThreads(Object, String, boolean, Payload, List<Device>, int) - Constructor for class javapns.notification.transmission.NotificationThreads: Create the specified number of notification threads and spread the devices evenly between the threads.
NotificationThreads(Object, String, boolean, Payload, List<Device>, List<NotificationThread>) - Constructor for class javapns.notification.transmission.NotificationThreads: Spread the devices evenly between the provided threads.
NotificationThreads(Object, String, boolean, Payload, List<NotificationThread>) - Constructor for class javapns.notification.transmission.NotificationThreads: Use the provided threads which should already each have their group of devices to work with.
NotificationThreads(AppleNotificationServer, int) - Constructor for class javapns.notification.transmission.NotificationThreads: Create a pool of notification threads in QUEUE mode.
NullDeviceTokenException - Exception in javapns.devices.exceptions: Thrown when the given token is null
NullDeviceTokenException() - Constructor for exception javapns.devices.exceptions.NullDeviceTokenException: Constructor
NullDeviceTokenException(String) - Constructor for exception javapns.devices.exceptions.NullDeviceTokenException: Constructor with custom message
NullIdException - Exception in javapns.devices.exceptions: Thrown when the given id is null
NullIdException() - Constructor for exception javapns.devices.exceptions.NullIdException: Constructor
NullIdException(String) - Constructor for exception javapns.devices.exceptions.NullIdException: Constructor with custom message

P

Payload - Class in javapns.notification: Abstract class representing a payload that can be transmitted to Apple.
Payload() - Constructor for class javapns.notification.Payload: Construct a Payload object with a blank root JSONObject
payload(Payload, Object, String, boolean, Object) - Static method in class javapns.Push: Push a preformatted payload to a list of devices.
payload(Payload, Object, String, boolean, int, Object) - Static method in class javapns.Push: Push a preformatted payload to a list of devices using multiple simulatenous threads (and connections).
PayloadAlertAlreadyExistsException - Exception in javapns.notification.exceptions: Thrown when a payload exceeds the maximum size allowed.
PayloadAlertAlreadyExistsException() - Constructor for exception javapns.notification.exceptions.PayloadAlertAlreadyExistsException: Default constructor
PayloadAlertAlreadyExistsException(String) - Constructor for exception javapns.notification.exceptions.PayloadAlertAlreadyExistsException: Constructor with custom message
PayloadIsEmptyException - Exception in javapns.notification.exceptions: Thrown when a payload is empty.
PayloadIsEmptyException() - Constructor for exception javapns.notification.exceptions.PayloadIsEmptyException
PayloadIsEmptyException(String) - Constructor for exception javapns.notification.exceptions.PayloadIsEmptyException: Constructor with custom message
PayloadMaxSizeExceededException - Exception in javapns.notification.exceptions: Thrown when a payload exceeds the maximum size allowed.
PayloadMaxSizeExceededException() - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeExceededException: Default constructor
PayloadMaxSizeExceededException(int) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeExceededException
PayloadMaxSizeExceededException(int, int) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeExceededException
PayloadMaxSizeExceededException(String) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeExceededException: Constructor with custom message
PayloadMaxSizeProbablyExceededException - Exception in javapns.notification.exceptions: Thrown when a payload is expected to exceed the maximum size allowed after adding a given property.
PayloadMaxSizeProbablyExceededException() - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeProbablyExceededException: Default constructor
PayloadMaxSizeProbablyExceededException(int) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeProbablyExceededException
PayloadMaxSizeProbablyExceededException(int, int) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeProbablyExceededException
PayloadMaxSizeProbablyExceededException(String) - Constructor for exception javapns.notification.exceptions.PayloadMaxSizeProbablyExceededException: Constructor with custom message
PayloadPerDevice - Class in javapns.notification: A one-to-one link between a payload and device.
PayloadPerDevice(Payload, String) - Constructor for class javapns.notification.PayloadPerDevice
PayloadPerDevice(Payload, Device) - Constructor for class javapns.notification.PayloadPerDevice
payloads(Object, String, boolean, Object) - Static method in class javapns.Push: Push a different preformatted payload for each device.
payloads(Object, String, boolean, int, Object) - Static method in class javapns.Push: Push a different preformatted payload for each device using multiple simulatenous threads (and connections).
PRODUCTION_HOST - Static variable in interface javapns.feedback.AppleFeedbackServer
PRODUCTION_HOST - Static variable in interface javapns.notification.AppleNotificationServer
PRODUCTION_PORT - Static variable in interface javapns.feedback.AppleFeedbackServer
PRODUCTION_PORT - Static variable in interface javapns.notification.AppleNotificationServer
Push - Class in javapns: Main class for easily interacting with the Apple Push Notification System
PushedNotification - Class in javapns.notification: An object representing the result of a push notification to a specific payload to a single device.
PushedNotification(Device, Payload) - Constructor for class javapns.notification.PushedNotification
PushedNotification(Device, Payload, Exception) - Constructor for class javapns.notification.PushedNotification
PushedNotifications - Class in javapns.notification: A list of PushedNotification objects.
PushedNotifications() - Constructor for class javapns.notification.PushedNotifications: Construct an empty list of PushedNotification objects.
PushedNotifications(int) - Constructor for class javapns.notification.PushedNotifications: Construct an empty list of PushedNotification objects with a suggested initial capacity.
PushNotificationBigPayload - Class in javapns.notification
PushNotificationManager - Class in javapns.notification: The main class used to send notification and handle a connection to Apple SSLServerSocket.
PushNotificationManager() - Constructor for class javapns.notification.PushNotificationManager: Constructs a PushNotificationManager
PushNotificationPayload - Class in javapns.notification: A payload compatible with the Apple Push Notification Service.
PushNotificationPayload(String, int, String) - Constructor for class javapns.notification.PushNotificationPayload: Create a payload and immediately add an alert message, a badge and a sound.
PushQueue - Interface in javapns.notification.transmission: A queue backed by an asynchronous notification thread or threads.

Q

queue(Object, String, boolean, int) - Static method in class javapns.Push: Build and start an asynchronous queue for sending notifications later without opening and closing connections.

R

removeDevice(String) - Method in interface javapns.devices.DeviceFactory: Deprecated.

Remove a device
removeDevice(String) - Method in class javapns.devices.implementations.basic.BasicDeviceFactory: Deprecated.

Remove a device
removeDevice(String) - Method in class javapns.notification.PushNotificationManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
ResponsePacket - Class in javapns.notification: A response packet, as described in Apple's enhanced notification format.
ResponsePacket() - Constructor for class javapns.notification.ResponsePacket
restartConnection(AppleNotificationServer) - Method in class javapns.notification.PushNotificationManager: Stop and restart the current connection to the Apple server
run() - Method in class javapns.notification.transmission.NotificationThread: Run method for the thread; do not call this method directly.

S

sendNotification(Device, Payload) - Method in class javapns.notification.PushNotificationManager: Send a notification to a single device and close the connection.
sendNotification(Device, Payload, boolean) - Method in class javapns.notification.PushNotificationManager: Send a notification (Payload) to the given device
sendNotification(Device, Payload, int) - Method in class javapns.notification.PushNotificationManager: Send a notification (Payload) to the given device
sendNotification(Device, Payload, boolean, int) - Method in class javapns.notification.PushNotificationManager: Send a notification (Payload) to the given device
sendNotifications(Payload, List<Device>) - Method in class javapns.notification.PushNotificationManager: Send a notification to a multiple devices in a single connection and close the connection.
sendNotifications(Payload, Device...) - Method in class javapns.notification.PushNotificationManager: Send a notification to a multiple devices in a single connection and close the connection.
setCharacterEncoding(String) - Method in class javapns.notification.Payload: Changes the character encoding for streaming the payload.
setCommand(int) - Method in class javapns.notification.ResponsePacket
setContentAvailable(boolean) - Method in class javapns.notification.PushNotificationPayload: Sets the content available.
setDelayBetweenThreads(long) - Method in class javapns.notification.transmission.NotificationThreads: Set the amount of time that the library will wait after starting a thread and before starting the next one.
setDevice(Device) - Method in class javapns.notification.PushedNotification
setDeviceFactory(DeviceFactory) - Method in class javapns.notification.PushNotificationManager: Deprecated.
The DeviceFactory-based architecture is deprecated.
setDeviceId(String) - Method in interface javapns.devices.Device: An id representing a particular device.
setDeviceId(String) - Method in class javapns.devices.implementations.basic.BasicDevice: Setter
setEnhancedNotificationFormatEnabled(boolean) - Static method in class javapns.notification.PushNotificationManager: Enable or disable the enhanced notification format (enabled by default).
setHeavyDebugMode(boolean) - Static method in class javapns.notification.PushNotificationManager: Enable or disable a special heavy debug mode which causes verbose details to be written to local files.
setIdentifier(int) - Method in class javapns.notification.ResponsePacket
setKeystore(KeyStore) - Method in class javapns.communication.ConnectionToAppleServer
setLastRegister(Timestamp) - Method in interface javapns.devices.Device
setLastRegister(Timestamp) - Method in class javapns.devices.implementations.basic.BasicDevice
setListener(NotificationProgressListener) - Method in class javapns.notification.transmission.NotificationThread: Provide an event listener which will be notified of this thread's progress.
setListener(NotificationProgressListener) - Method in class javapns.notification.transmission.NotificationThreads: Attach an event listener to this object as well as all linked threads.
setMaxNotificationsPerConnection(int) - Method in class javapns.notification.transmission.NotificationThread: Set a maximum number of notifications that should be streamed over a continuous connection to an Apple server.
setMaxNotificationsPerConnection(int) - Method in class javapns.notification.transmission.NotificationThreads: Configure in all threads the maximum number of notifications per connection.
setMaxRetained(int) - Method in class javapns.notification.PushedNotifications: Set the maximum number of objects that this list retains.
setPayload(Payload) - Method in class javapns.notification.PushedNotification
setPayloadSizeEstimatedWhenAdding(boolean) - Method in class javapns.notification.Payload: Indicate if payload size should be estimated and controlled when adding properties (default is false).
setProxy(String, int) - Method in interface javapns.communication.AppleServer: Configure a proxy to use for this specific server.
setProxy(String, int) - Method in class javapns.communication.AppleServerBasicImpl
setRetryAttempts(int) - Method in class javapns.notification.PushNotificationManager: Set the number of retry attempts
setSleepBetweenNotifications(long) - Method in class javapns.notification.transmission.NotificationThread: Set a delay the thread should sleep between each notification.
setSleepBetweenNotifications(long) - Method in class javapns.notification.transmission.NotificationThreads: Configure in all threads the number of milliseconds that threads should wait between each notification.
setSslSocketTimeout(int) - Method in class javapns.notification.PushNotificationManager: Set the SSL socket timeout to use.
setStatus(int) - Method in class javapns.notification.ResponsePacket
setToken(String) - Method in interface javapns.devices.Device: Set the device token
setToken(String) - Method in class javapns.devices.implementations.basic.BasicDevice: Setter the device token
setTrustAllServerCertificates(boolean) - Method in class javapns.notification.PushNotificationManager: Set whether or not to enable the "trust all server certificates" feature to simplify SSL communications.
sound(String) - Static method in class javapns.notification.PushNotificationPayload: Create a pre-defined payload with a sound name.
sound(String, Object, String, boolean, Object) - Static method in class javapns.Push: Push a simple sound name to one or more devices.
start() - Method in class javapns.notification.transmission.NotificationThread: Start the transmission thread.
start() - Method in class javapns.notification.transmission.NotificationThreads: Start all notification threads.
start() - Method in interface javapns.notification.transmission.PushQueue: Start the transmission thread(s) working for the queue.
stopConnection() - Method in class javapns.notification.PushNotificationManager: Read and process any pending error-responses, and then close the connection.

T

test() - Static method in class javapns.notification.PushNotificationPayload: Create a special payload with a useful debugging alert message.
test(Object, String, boolean, Object) - Static method in class javapns.Push: Push a special test notification with an alert message containing useful debugging information.
toString() - Method in exception javapns.devices.exceptions.DuplicateDeviceException: String representation
toString() - Method in exception javapns.devices.exceptions.NullDeviceTokenException: String representation
toString() - Method in exception javapns.devices.exceptions.NullIdException: String representation
toString() - Method in exception javapns.devices.exceptions.UnknownDeviceException: String representation
toString() - Method in class javapns.notification.Payload: Get the string representation
toString() - Method in class javapns.notification.PushedNotification: Returns a human-friendly description of this pushed notification.

U

UnknownDeviceException - Exception in javapns.devices.exceptions: Thrown when we try to retrieve a device that doesn't exist
UnknownDeviceException() - Constructor for exception javapns.devices.exceptions.UnknownDeviceException: Constructor
UnknownDeviceException(String) - Constructor for exception javapns.devices.exceptions.UnknownDeviceException: Constructor with custom message

V

validateKeystoreParameter(Object) - Static method in class javapns.communication.KeystoreManager: Ensures that a keystore parameter is actually supported by the KeystoreManager.
validateTokenFormat(String) - Static method in class javapns.devices.implementations.basic.BasicDevice
validateTokenFormat() - Method in class javapns.devices.implementations.basic.BasicDevice
valueOf(String) - Static method in enum javapns.notification.transmission.NotificationThread.MODE: Returns the enum constant of this type with the specified name.
values() - Static method in enum javapns.notification.transmission.NotificationThread.MODE: Returns an array containing the constants of this enum type, in the order they are declared.
verifyKeystoreContent(AppleServer, Object) - Static method in class javapns.communication.KeystoreManager: Perform basic tests on a keystore to detect common user mistakes.

W

waitForAllThreads() - Method in class javapns.notification.transmission.NotificationThreads: Wait for all threads to complete their work.
waitForAllThreads(boolean) - Method in class javapns.notification.transmission.NotificationThreads: Wait for all threads to complete their work, but throw any critical exception that occurs in a thread.

A B C D E F G I J K N P Q R S T U V W