Apns Component

Available as of Camel 2.8

The apns component is used for sending notifications to iOS devices. The apns components use javapns library.
The component supports sending notifications to Apple Push Notification Servers (APNS) and consuming feedback from the servers.

The consumer is configured with 3600 seconds for polling by default because it is a best practice to consume feedback stream from Apple Push Notification Servers only from time to time. For example: every 1 hour to avoid flooding the servers.

The feedback stream gives informations about inactive devices. You only need to get this informations every some hours if your mobile application is not a heavily used one.

Maven users will need to add the following dependency to their pom.xml for this component:

URI format

To send notifications:

To consume feedback:

Options

Producer

Property

Default

Description

tokens


Empty by default. Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma.

Consumer

Property

Default

Description

delay

3600

Delay in seconds between each poll.

initialDelay

10

Seconds before polling starts.

timeUnit

SECONDS

Time Unit for polling.

userFixedDelay

true

If true, use fixed delay between pools, otherwise fixed rate is used. See ScheduledExecutorService in JDK for details.

You can append query options to the URI in the following format, ?option=value&option=value&...

Component

The ApnsComponent must be configured with a com.notnoop.apns.ApnsService. The service can be created and configured using the org.apache.camel.component.apns.factory.ApnsServiceFactory. See further below for an example. And as well in the test source code.

Exchange data format

When Camel will fetch feedback data corresponding to inactive devices, it will retrieve a List of InactiveDevice objects. Each InactiveDevice object of the retrieved list will be setted as the In body, and then processed by the consumer endpoint.

Message Headers

Camel Apns uses these headers.

Property

Default

Description

CamelApnsTokens

 

Empty by default.

CamelApnsMessageType

STRING, PAYLOAD

In case you choose PAYLOAD for the message type, then the message will be considered as a APNS payload and sent as is. In case you choose STRING, message will be converted as a APNS payload

Samples

Camel Xml route

Camel Java route

Create camel context and declare apns component programmatically
ApnsProducer - iOS target device dynamically configured via header: "CamelApnsTokens"
ApnsProducer - iOS target device statically configured via uri
ApnsConsumer

See Also

© 2004-2014 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram