Skip to content

Latest commit

 

History

History
 
 

jackson-payload-builder

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Jackson APNs payload builder for Pushy

This module provides an ApnsPayloadBuilder that uses Jackson to serialize APNs payloads. If you use Maven, you can add the payload builder to your project by adding the following dependency declaration to your POM:

<dependency>
    <groupId>com.eatthepath</groupId>
    <artifactId>pushy-jackson-payload-builder</artifactId>
    <version>0.14.1</version>
</dependency>

If you don't use Maven, you can add the .jar file and its dependencies to your classpath by the method of your choice. The Jackson payload builder for Pushy depends on Pushy itself (obviously enough) and version 2.12 of the Jackson databind library.

Using the Jackson payload builder

Callers can construct a payload builder that uses a default Jackson object mapper with JacksonPayloadBuilder's no-argument constructor:

final ApnsPayloadBuilder jacksonPayloadBuilder =
        new JacksonApnsPayloadBuilder();

jacksonPayloadBuilder.setAlertBody("Hello from Jackson!");

final String payload = jacksonPayloadBuilder.build();

Callers can also provide their own object mapper to customize how it serializes payloads:

final ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, true);

final ApnsPayloadBuilder customizedJacksonPayloadBuilder =
        new JacksonApnsPayloadBuilder(objectMapper);

License

The Jackson payload builder for Pushy is available under the MIT License.