forked from notnoop/java-apns
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathApnsService.java
171 lines (157 loc) · 6.86 KB
/
ApnsService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
* Copyright 2009, Mahmood Ali.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Mahmood Ali. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.notnoop.apns;
import java.util.Collection;
import java.util.Date;
import java.util.Map;
import com.notnoop.exceptions.NetworkIOException;
/**
* Represents the connection and interface to the Apple APNS servers.
*
* The service is created by {@link ApnsServiceBuilder} like:
*
* <pre>
* ApnsService = APNS.newService()
* .withCert("/path/to/certificate.p12", "MyCertPassword")
* .withSandboxDestination()
* .build()
* </pre>
*/
public interface ApnsService {
/**
* Sends a push notification with the provided {@code payload} to the
* iPhone of {@code deviceToken}.
*
* The payload needs to be a valid JSON object, otherwise it may fail
* silently. It is recommended to use {@link PayloadBuilder} to create
* one.
*
* @param deviceToken the destination iPhone device token
* @param payload The payload message
* @throws NetworkIOException if a network error occured while
* attempting to send the message
*/
ApnsNotification push(String deviceToken, String payload) throws NetworkIOException;
EnhancedApnsNotification push(String deviceToken, String payload, Date expiry) throws NetworkIOException;
/**
* Sends a push notification with the provided {@code payload} to the
* iPhone of {@code deviceToken}.
*
* The payload needs to be a valid JSON object, otherwise it may fail
* silently. It is recommended to use {@link PayloadBuilder} to create
* one.
*
* @param deviceToken the destination iPhone device token
* @param payload The payload message
* @throws NetworkIOException if a network error occurred while
* attempting to send the message
*/
ApnsNotification push(byte[] deviceToken, byte[] payload) throws NetworkIOException;
EnhancedApnsNotification push(byte[] deviceToken, byte[] payload, int expiry) throws NetworkIOException;
/**
* Sends a bulk push notification with the provided
* {@code payload} to iPhone of {@code deviceToken}s set.
*
* The payload needs to be a valid JSON object, otherwise it may fail
* silently. It is recommended to use {@link PayloadBuilder} to create
* one.
*
* @param deviceTokens the destination iPhone device tokens
* @param payload The payload message
* @throws NetworkIOException if a network error occurred while
* attempting to send the message
*/
Collection<? extends ApnsNotification> push(Collection<String> deviceTokens, String payload) throws NetworkIOException;
Collection<? extends EnhancedApnsNotification> push(Collection<String> deviceTokens, String payload, Date expiry) throws NetworkIOException;
/**
* Sends a bulk push notification with the provided
* {@code payload} to iPhone of {@code deviceToken}s set.
*
* The payload needs to be a valid JSON object, otherwise it may fail
* silently. It is recommended to use {@link PayloadBuilder} to create
* one.
*
* @param deviceTokens the destination iPhone device tokens
* @param payload The payload message
* @throws NetworkIOException if a network error occurred while
* attempting to send the message
*/
Collection<? extends ApnsNotification> push(Collection<byte[]> deviceTokens, byte[] payload) throws NetworkIOException;
Collection<? extends EnhancedApnsNotification> push(Collection<byte[]> deviceTokens, byte[] payload, int expiry) throws NetworkIOException;
/**
* Sends the provided notification {@code message} to the desired
* destination.
* @throws NetworkIOException if a network error occured while
* attempting to send the message
*/
void push(ApnsNotification message) throws NetworkIOException;
/**
* Starts the service.
*
* The underlying implementation may prepare its connections or
* datastructures to be able to send the messages.
*
* This method is a blocking call, even if the service represents
* a Non-blocking push service. Once the service is returned, it is ready
* to accept push requests.
*
* @throws NetworkIOException if a network error occurred while
* starting the service
*/
void start();
/**
* Stops the service and frees any allocated resources it created for this
* service.
*
* The underlying implementation should close all connections it created,
* and possibly stop any threads as well.
*/
void stop();
/**
* Returns the list of devices that reported failed-delivery
* attempts to the Apple Feedback services.
*
* The result is map, mapping the device tokens as Hex Strings
* mapped to the timestamp when APNs determined that the
* application no longer exists on the device.
* @throws NetworkIOException if a network error occurred
* while retrieving invalid device connection
*/
Map<String, Date> getInactiveDevices() throws NetworkIOException;
/**
* Test that the service is setup properly and the Apple servers
* are reachable.
*
* @throws NetworkIOException if the Apple servers aren't reachable
* or the service cannot send notifications for now
*/
void testConnection() throws NetworkIOException;
}