com.notnoop.apns.SimpleApnsNotification Maven / Gradle / Ivy
/*
* 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.Arrays;
import com.notnoop.apns.internal.Utilities;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
/**
* Represents an APNS notification to be sent to Apple service. This is for legacy use only
* and should not be used in new development.
* https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/LegacyFormat.html
*
* This SimpleApnsNotification also only has limited error handling (by the APNS closing the connection
* when a bad message was received) This prevents us from location the malformed notification.
*
* As push messages sent after a malformed notification are discarded by APNS messages will get lost
* and not be delivered with the SimpleApnsNotification.
*
* @deprecated use EnhancedApnsNotification instead.
*/
@SuppressWarnings("deprecation")
@Deprecated
public class SimpleApnsNotification implements ApnsNotification {
private final static byte COMMAND = 0;
private final byte[] deviceToken;
private final byte[] payload;
/**
* Constructs an instance of {@code ApnsNotification}.
*
* The message encodes the payload with a {@code UTF-8} encoding.
*
* @param dtoken The Hex of the device token of the destination phone
* @param payload The payload message to be sent
*/
public SimpleApnsNotification(String dtoken, String payload) {
this.deviceToken = Utilities.decodeHex(dtoken);
this.payload = Utilities.toUTF8Bytes(payload);
}
/**
* Constructs an instance of {@code ApnsNotification}.
*
* @param dtoken The binary representation of the destination device token
* @param payload The binary representation of the payload to be sent
*/
public SimpleApnsNotification(byte[] dtoken, byte[] payload) {
this.deviceToken = Utilities.copyOf(dtoken);
this.payload = Utilities.copyOf(payload);
}
/**
* Returns the binary representation of the device token.
*
*/
public byte[] getDeviceToken() {
return Utilities.copyOf(deviceToken);
}
/**
* Returns the binary representation of the payload.
*
*/
public byte[] getPayload() {
return Utilities.copyOf(payload);
}
private byte[] marshall = null;
/**
* Returns the binary representation of the message as expected by the
* APNS server.
*
* The returned array can be used to sent directly to the APNS server
* (on the wire/socket) without any modification.
*/
public byte[] marshall() {
if (marshall == null)
marshall = Utilities.marshall(COMMAND, deviceToken, payload);
return marshall.clone();
}
/**
* Returns the length of the message in bytes as it is encoded on the wire.
*
* Apple require the message to be of length 255 bytes or less.
*
* @return length of encoded message in bytes
*/
public int length() {
int length = 1 + 2 + deviceToken.length + 2 + payload.length;
final int marshalledLength = marshall().length;
assert marshalledLength == length;
return length;
}
@Override
public int hashCode() {
return 21
+ 31 * Arrays.hashCode(deviceToken)
+ 31 * Arrays.hashCode(payload);
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof SimpleApnsNotification))
return false;
SimpleApnsNotification o = (SimpleApnsNotification)obj;
return Arrays.equals(this.deviceToken, o.deviceToken)
&& Arrays.equals(this.payload, o.payload);
}
public int getIdentifier() {
return -1;
}
public int getExpiry() {
return -1;
}
@Override
@SuppressFBWarnings("DE_MIGHT_IGNORE")
public String toString() {
String payloadString;
try {
payloadString = new String(payload, "UTF-8");
} catch (Exception ex) {
payloadString = "???";
}
return "Message(Token="+Utilities.encodeHex(deviceToken)+"; Payload="+payloadString+")";
}
}