com.relayrides.pushy.apns

Class MockApnsServer

java.lang.Object

com.relayrides.pushy.apns.MockApnsServer

public class MockApnsServer
extends Object

A mock APNs server emulates the behavior of a real APNs server (but doesn't actually deliver notifications to their destinations). Mock servers are primarily useful for integration tests and benchmarks; most users will not need to interact with mock servers.

Mock servers maintain a registry of tokens for a variety of topics. When first created, no tokens are registered with a mock server, and all attempts to send notifications will fail until at least one token is registered via the registerDeviceTokenForTopic(String, String, Date) method.

Since:

0.8

Author:

Jon Chambers

Method Summary

Modifier and Type	Method and Description
void	clearPublicKeys() Unregisters all teams, topics, and public keys from this server.
void	clearTokens() Unregisters all tokens from this server.
void	registerDeviceTokenForTopic(String topic, String token, Date expiration) Registers a new token for a specific topic.
void	registerPublicKey(ECPublicKey publicKey, String teamId, String keyId, Collection<String> topics) Registers a public key for verifying authentication tokens for the given topics.
void	registerPublicKey(ECPublicKey publicKey, String teamId, String keyId, String... topics) Registers a public key for verifying authentication tokens for the given topics.
Future<Void>	shutdown() Shuts down this server and releases the port to which this server was bound.
Future<Void>	start(int port) Starts this mock server and listens for traffic on the given port.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

start

public Future<Void> start(int port)

Starts this mock server and listens for traffic on the given port.

Parameters:

port - the port to which this server should bind

Returns:

a Future that will succeed when the server has bound to the given port and is ready to accept traffic

registerPublicKey

public void registerPublicKey(ECPublicKey publicKey,
                              String teamId,
                              String keyId,
                              Collection<String> topics)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException

Registers a public key for verifying authentication tokens for the given topics. Clears any keys and topics previously associated with the given team.

Parameters:

publicKey - a public key to be used to verify authentication tokens

teamId - an identifier for the team to which the given public key belongs

keyId - an identifier for the given public key

topics - the topics belonging to the given team for which the given public key can be used to verify authentication tokens

Throws:

NoSuchAlgorithmException - if the required signing algorithm is not available

InvalidKeyException - if the given key is invalid for any reason

Since:

0.9

registerPublicKey

public void registerPublicKey(ECPublicKey publicKey,
                              String teamId,
                              String keyId,
                              String... topics)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException

Registers a public key for verifying authentication tokens for the given topics. Clears any keys and topics previously associated with the given team.

Parameters:

publicKey - a public key to be used to verify authentication tokens

teamId - an identifier for the team to which the given public key belongs

keyId - an identifier for the given public key

topics - the topics belonging to the given team for which the given public key can be used to verify authentication tokens

Throws:

NoSuchAlgorithmException - if the required signing algorithm is not available

InvalidKeyException - if the given key is invalid for any reason

Since:

0.9

clearPublicKeys

public void clearPublicKeys()

Unregisters all teams, topics, and public keys from this server.

registerDeviceTokenForTopic

public void registerDeviceTokenForTopic(String topic,
                                        String token,
                                        Date expiration)

Registers a new token for a specific topic. Registered tokens may have an expiration date; attempts to send notifications to tokens with expiration dates in the past will fail.

Parameters:

topic - the topic for which to register the given token

token - the token to register

expiration - the time at which the token expires (or expired); may be null, in which case the token never expires

clearTokens

public void clearTokens()

Unregisters all tokens from this server.

shutdown

public Future<Void> shutdown()

Shuts down this server and releases the port to which this server was bound. If a null event loop group was provided at construction time, the server will also shut down its internally-managed event loop group.

If a non-null EventLoopGroup was provided at construction time, mock servers may be reconnected and reused after they have been shut down. If no event loop group was provided at construction time, mock servers may not be restarted after they have been shut down via this method.

Returns:

a Future that will succeed once the server has finished unbinding from its port and, if the server was managing its own event loop group, its event loop group has shut down