- AcceptAllPushNotificationHandlerFactory - Class in com.turo.pushy.apns.server
-
A factory for push notification handlers that unconditionally accept all push notifications.
- AcceptAllPushNotificationHandlerFactory() - Constructor for class com.turo.pushy.apns.server.AcceptAllPushNotificationHandlerFactory
-
- addCustomProperty(String, Object) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Adds a custom property to the payload.
- ALTERNATE_APNS_PORT - Static variable in class com.turo.pushy.apns.ApnsClientBuilder
-
An alternative port for communication with the APNs gateway.
- APNS_SIGNATURE_ALGORITHM - Static variable in class com.turo.pushy.apns.auth.ApnsKey
-
- ApnsClient - Class in com.turo.pushy.apns
-
An APNs client sends push notifications to the APNs gateway.
- ApnsClientBuilder - Class in com.turo.pushy.apns
-
An
ApnsClientBuilder constructs new
ApnsClient instances.
- ApnsClientBuilder() - Constructor for class com.turo.pushy.apns.ApnsClientBuilder
-
- ApnsClientMetricsListener - Interface in com.turo.pushy.apns
-
A metrics listener receives events from an
ApnsClient that can be used to measure the performance and
behavior of the client.
- ApnsKey - Class in com.turo.pushy.apns.auth
-
A key used for signing or verifying APNs authentication tokens.
- ApnsKey(String, String, ECKey) - Constructor for class com.turo.pushy.apns.auth.ApnsKey
-
Constructs a new APNs key with the given identifiers and underlying elliptic curve key.
- ApnsPayloadBuilder - Class in com.turo.pushy.apns.util
-
A utility class for constructing JSON payloads suitable for inclusion in APNs push notifications.
- ApnsPayloadBuilder() - Constructor for class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
- ApnsPushNotification - Interface in com.turo.pushy.apns
-
A push notification that can be sent through the Apple Push Notification service (APNs).
- ApnsServerException - Exception in com.turo.pushy.apns
-
An exception that indicates that a push notification could not be sent due to an upstream server error.
- ApnsServerException() - Constructor for exception com.turo.pushy.apns.ApnsServerException
-
Constructs a new APNs server exception.
- ApnsServerException(String) - Constructor for exception com.turo.pushy.apns.ApnsServerException
-
Constructs a new APNs server exception with the given message.
- ApnsSigningKey - Class in com.turo.pushy.apns.auth
-
A private key used to sign authentication tokens.
- ApnsSigningKey(String, String, ECPrivateKey) - Constructor for class com.turo.pushy.apns.auth.ApnsSigningKey
-
Constructs a new signing key with the given key identifier, team identifier, and elliptic curve private key.
- ApnsVerificationKey - Class in com.turo.pushy.apns.auth
-
A public key used to verify authentication tokens.
- ApnsVerificationKey(String, String, ECPublicKey) - Constructor for class com.turo.pushy.apns.auth.ApnsVerificationKey
-
Constructs a new verification key with the given key identifier, team identifier, and elliptic curve private key.
- AuthenticationToken - Class in com.turo.pushy.apns.auth
-
An authentication token (or "provider authentication token" or "provider token" in Apple's terminology) is a
JSON Web Token (JWT) that contains cryptographically-signed claims about the identity of the sender that can be used
by APNs clients in lieu of mutual TLS authentication to authenticate with an APNs server.
- AuthenticationToken(ApnsSigningKey, Date) - Constructor for class com.turo.pushy.apns.auth.AuthenticationToken
-
Constructs a new authentication token using the given signing key (and associated metadata) issued at the given
date.
- AuthenticationToken(String) - Constructor for class com.turo.pushy.apns.auth.AuthenticationToken
-
Constructs a new authentication token from a Base64-encoded JWT string.
- getAlgorithm() - Method in class com.turo.pushy.apns.auth.ApnsSigningKey
-
- getAlgorithm() - Method in class com.turo.pushy.apns.auth.ApnsVerificationKey
-
- getAuthorizationHeader() - Method in class com.turo.pushy.apns.auth.AuthenticationToken
-
Returns a complete APNs authorization header value (i.e.
- getCode() - Method in enum com.turo.pushy.apns.DeliveryPriority
-
- getCollapseId() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns an optional identifier for this notification that allows this notification to supersede previous
notifications or to be superseded by later notifications with the same identifier.
- getCollapseId() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the "collapse ID" for this push notification, which allows it to supersede or be superseded by other
notifications with the same ID.
- getEncoded() - Method in class com.turo.pushy.apns.auth.ApnsSigningKey
-
- getEncoded() - Method in class com.turo.pushy.apns.auth.ApnsVerificationKey
-
- getExpiration() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns the time at which Apple's push notification service should stop trying to deliver this push notification.
- getExpiration() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the time at which this push notification is no longer valid and should no longer be delivered.
- getFormat() - Method in class com.turo.pushy.apns.auth.ApnsSigningKey
-
- getFormat() - Method in class com.turo.pushy.apns.auth.ApnsVerificationKey
-
- getFromCode(int) - Static method in enum com.turo.pushy.apns.DeliveryPriority
-
- getIssuedAt() - Method in class com.turo.pushy.apns.auth.AuthenticationToken
-
Returns the time at which this token was issued.
- getKey() - Method in class com.turo.pushy.apns.auth.ApnsVerificationKey
-
- getKeyId() - Method in class com.turo.pushy.apns.auth.ApnsKey
-
Returns the Apple-issued identifier for this key.
- getKeyId() - Method in class com.turo.pushy.apns.auth.AuthenticationToken
-
Returns the Apple-issued ID of the key used to sign this token.
- getParams() - Method in class com.turo.pushy.apns.auth.ApnsKey
-
- getPayload() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns the JSON-encoded payload of this push notification.
- getPayload() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the payload to include in this push notification.
- getPriority() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns the priority with which this push notification should be sent to the receiving device.
- getPriority() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the priority with which this push notification should be delivered to the receiving device.
- getPushNotification() - Method in interface com.turo.pushy.apns.PushNotificationResponse
-
Returns the original push notification sent to the APNs gateway.
- getPushNotification() - Method in interface com.turo.pushy.apns.util.concurrent.PushNotificationFuture
-
Returns the push notification to which the operation represented by this future applies.
- getRejectionReason() - Method in interface com.turo.pushy.apns.PushNotificationResponse
-
Returns the reason for rejection reported by the APNs gateway.
- getS() - Method in class com.turo.pushy.apns.auth.ApnsSigningKey
-
- getTeamId() - Method in class com.turo.pushy.apns.auth.ApnsKey
-
Returns the Apple-issued identifier for the team that owns this key.
- getTeamId() - Method in class com.turo.pushy.apns.auth.AuthenticationToken
-
Returns the Apple-issued ID of the team to which this authentication token's key pair belongs.
- getToken() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns the token of the device to which this push notification is to be sent.
- getToken() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the token of the device to which this push notification should be delivered.
- getTokenInvalidationTimestamp() - Method in interface com.turo.pushy.apns.PushNotificationResponse
-
If the sent push notification was rejected because the destination token is no longer valid, returns the most
recent time at which the APNs gateway confirmed that the token is no longer valid.
- getTopic() - Method in interface com.turo.pushy.apns.ApnsPushNotification
-
Returns the topic to which this notification should be sent.
- getTopic() - Method in class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Returns the topic to which this push notification should be sent.
- getW() - Method in class com.turo.pushy.apns.auth.ApnsVerificationKey
-
- sanitizeTokenString(String) - Static method in class com.turo.pushy.apns.util.TokenUtil
-
Returns a "sanitized" version of the given token string suitable for sending to an APNs server.
- sendNotification(T) - Method in class com.turo.pushy.apns.ApnsClient
-
Sends a push notification to the APNs gateway.
- serialize(Date, Type, JsonSerializationContext) - Method in class com.turo.pushy.apns.util.DateAsTimeSinceEpochTypeAdapter
-
- setActionButtonLabel(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the literal text of the action button to be shown for the push notification for Safari push
notifications only.
- setAlertBody(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the literal text of the alert message to be shown for the push notification.
- setAlertSubtitle(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets a subtitle for the notification.
- setAlertTitle(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets a short description of the notification purpose.
- setApnsServer(String) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the hostname of the server to which the client under construction will connect.
- setApnsServer(String, int) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the hostname and port of the server to which the client under construction will connect.
- setBadgeNumber(Integer) - Method in class com.turo.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.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the name of the action category name for interactive remote notifications.
- setClientCredentials(File, String) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the TLS credentials for the client under construction using the contents of the given PKCS#12 file.
- setClientCredentials(InputStream, String) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the TLS credentials for the client under construction using the data from the given PKCS#12 input stream.
- setClientCredentials(X509Certificate, PrivateKey, String) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the TLS credentials for the client under construction.
- setConcurrentConnections(int) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the maximum number of concurrent connections the client under construction may attempt to maintain to the
APNs server.
- setConnectionTimeout(long, TimeUnit) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the maximum amount of time, in milliseconds, that the client under construction will wait to establish a
connection with the APNs server before the connection attempt is considered a failure.
- setContentAvailable(boolean) - Method in class com.turo.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(EventLoopGroup) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the event loop group to be used by the client under construction.
- setEventLoopGroup(EventLoopGroup) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the event loop group to be used by the server under construction.
- setFrameLogger(Http2FrameLogger) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the HTTP/2 frame logger for the client under construction.
- setGracefulShutdownTimeout(long, TimeUnit) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the amount of time clients should wait for in-progress requests to complete before closing a connection
during a graceful shutdown.
- setHandlerFactory(PushNotificationHandlerFactory) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the handler factory to be used to construct push notification handlers for the server under construction.
- setIdlePingInterval(long, TimeUnit) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the amount of idle time (in milliseconds) after which the client under construction will send a PING frame
to the APNs server.
- setLaunchImageFileName(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the image to be shown when the receiving app launches in response to this push notification.
- setListener(MockApnsServerListener) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the listener to be notified when notifications are accepted or rejected by the server under construction.
- setLocalizedActionButtonKey(String) - Method in class com.turo.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.turo.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.
- setLocalizedAlertSubtitle(String, String...) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the key of the subtitle string in the receiving app's localized string list to be shown for the push
notification.
- setLocalizedAlertTitle(String, String...) - Method in class com.turo.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.
- setMaxConcurrentStreams(int) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the maximum number of concurrent HTTP/2 streams allowed by the server under construction.
- setMetricsListener(ApnsClientMetricsListener) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the metrics listener for the client under construction.
- setMutableContent(boolean) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets whether the receiving device may modify the content of the push notification before displaying it.
- setPreferStringRepresentationForAlerts(boolean) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets whether this payload builder will attempt to represent alerts as strings when possible.
- setProxyHandlerFactory(ProxyHandlerFactory) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the proxy handler factory to be used to construct proxy handlers when establishing a new connection to the
APNs gateway.
- setServerCredentials(File, File, String) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the credentials for the server under construction using the certificates in the given PEM file and the
private key in the given PKCS#8 file.
- setServerCredentials(InputStream, InputStream, String) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the credentials for the server under construction using the certificates in the given PEM input stream
and the private key in the given PKCS#8 input stream.
- setServerCredentials(X509Certificate[], PrivateKey, String) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the credentials for the server under construction.
- setShowActionButton(boolean) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets whether an "action" button should be shown if the push notification is displayed as an alert.
- setSigningKey(ApnsSigningKey) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the signing key for the client under construction.
- setSoundFileName(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the name of the sound file to play when the push notification is received.
- setThreadId(String) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the thread ID for this notification.
- setTrustedClientCertificateChain(File) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the trusted certificate chain for the server under construction using the contents of the given PEM
file.
- setTrustedClientCertificateChain(InputStream) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the trusted certificate chain for the server under construction using the contents of the given PEM
input stream.
- setTrustedServerCertificateChain(File) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the trusted certificate chain for the client under construction using the contents of the given PEM
file.
- setTrustedServerCertificateChain(InputStream) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the trusted certificate chain for the client under construction using the contents of the given PEM
input stream.
- setTrustedServerCertificateChain(X509Certificate...) - Method in class com.turo.pushy.apns.ApnsClientBuilder
-
Sets the trusted certificate chain for the client under construction.
- setTrustedServerCertificateChain(X509Certificate...) - Method in class com.turo.pushy.apns.server.MockApnsServerBuilder
-
Sets the trusted certificate chain for the server under construction.
- setUrlArguments(List<String>) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the list of arguments to populate placeholders in the urlFormatString associated with a Safari
push notification.
- setUrlArguments(String...) - Method in class com.turo.pushy.apns.util.ApnsPayloadBuilder
-
Sets the list of arguments to populate placeholders in the urlFormatString associated with a Safari
push notification.
- shutdown() - Method in class com.turo.pushy.apns.server.MockApnsServer
-
Shuts down this server and releases the port to which this server was bound.
- SimpleApnsPushNotification - Class in com.turo.pushy.apns.util
-
- SimpleApnsPushNotification(String, String, String) - Constructor for class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Constructs a new push notification with the given token, topic, and payload.
- SimpleApnsPushNotification(String, String, String, Date) - Constructor for class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Constructs a new push notification with the given token, topic, payload, and expiration time.
- SimpleApnsPushNotification(String, String, String, Date, DeliveryPriority) - Constructor for class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Constructs a new push notification with the given token, topic, payload, delivery expiration time, and delivery
priority.
- SimpleApnsPushNotification(String, String, String, Date, DeliveryPriority, String) - Constructor for class com.turo.pushy.apns.util.SimpleApnsPushNotification
-
Constructs a new push notification with the given token, topic, payload, delivery expiration time, delivery
priority, and "collapse identifier."
- Socks4ProxyHandlerFactory - Class in com.turo.pushy.apns.proxy
-
- Socks4ProxyHandlerFactory(SocketAddress) - Constructor for class com.turo.pushy.apns.proxy.Socks4ProxyHandlerFactory
-
Creates a new proxy handler factory that will create SOCKS4 proxy handlers that use the proxy at the given
address and that will not perform authentication.
- Socks4ProxyHandlerFactory(SocketAddress, String) - Constructor for class com.turo.pushy.apns.proxy.Socks4ProxyHandlerFactory
-
Creates a new proxy handler factory that will create SOCKS4 proxy handlers that use the proxy at the given
address and that will authenticate with the given username and password.
- Socks5ProxyHandlerFactory - Class in com.turo.pushy.apns.proxy
-
- Socks5ProxyHandlerFactory(SocketAddress) - Constructor for class com.turo.pushy.apns.proxy.Socks5ProxyHandlerFactory
-
Creates a new proxy handler factory that will create SOCKS5 proxy handlers that use the proxy at the given
address and that will not perform authentication.
- Socks5ProxyHandlerFactory(SocketAddress, String, String) - Constructor for class com.turo.pushy.apns.proxy.Socks5ProxyHandlerFactory
-
Creates a new proxy handler factory that will create SOCKS5 proxy handlers that use the proxy at the given
address and that will authenticate with the given username and password.
- start(int) - Method in class com.turo.pushy.apns.server.MockApnsServer
-
Starts this mock server and listens for traffic on the given port.