org.marre.sms.SmsUdhUtil Maven / Gradle / Ivy
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is "SMS Library for the Java platform".
*
* The Initial Developer of the Original Code is Markus Eriksson.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.marre.sms;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
/**
* Toolkit class for SmsUdhElement objects.
*
* @author Markus Eriksson
* @version $Id$
*/
public final class SmsUdhUtil
{
public static final int PDUMAXLENGTH = 140;
public static final int ASCIIMAXLENGTH = 159;
/**
* Constructor for SmsUdhUtil.
*/
private SmsUdhUtil()
{
}
/**
* Calculates the number of bytes needed for the supplied udh elements.
*
* @param udhElements The udh elements
* @return The size (in bytes)
*/
public static int getTotalSize(SmsUdhElement[] udhElements)
{
int totLength = 0;
if (udhElements == null)
{
return 0;
}
for (SmsUdhElement udhElement : udhElements) {
totLength += udhElement.getTotalSize();
}
return totLength;
}
/**
* Returns the whole udh as a byte array.
*
* The returned UDH is the same as specified when the message was created.
* No concat headers are added.
*
* TODO: Rename this function. The name is totally wrong.
*
* @return the UDH elements as a byte array.
*/
public static byte[] toByteArray(SmsUdhElement[] udhElements)
{
ByteArrayOutputStream baos = new ByteArrayOutputStream(100);
if (udhElements == null)
{
return new byte[0];
}
baos.write((byte) SmsUdhUtil.getTotalSize(udhElements));
try
{
for (SmsUdhElement udhElement : udhElements) {
udhElement.writeTo(baos);
}
}
catch (IOException ioe)
{
throw new RuntimeException(ioe);
}
return baos.toByteArray();
}
/**
* Calculates if the given data needs a concatenated SMS.
*
* @param ud User data
* @param udh UDH elements
* @return true if the message must be concatentated.
*/
public static boolean isConcat(SmsUserData ud, byte[] udh)
{
int udLength = ud.getLength();
int bytesLeft = PDUMAXLENGTH;
int maxChars;
if (udh != null)
{
bytesLeft -= udh.length;
}
switch (ud.getDcs().getAlphabet())
{
case GSM:
maxChars = (bytesLeft * 8) / 7;
break;
case UCS2:
maxChars = bytesLeft / 2;
break;
case ASCII:
maxChars = bytesLeft+ASCIIMAXLENGTH-PDUMAXLENGTH ;
break;
case LATIN1:
default:
maxChars = bytesLeft;
break;
}
return (udLength > maxChars);
}
/**
* Creates a "8Bit concatenated" UDH element using UDH_IEI_CONCATENATED_8BIT.
*
* This can be used to create a concatenated SMS.
*
* @param refNr The reference number of this SMS, must be the same in
* all SMS. Max 255.
* @param totalNumberOfSms Total number of SMS. Max 255.
* @param seqNr Sequence number. Max 255.
* @return A SmsUdhElement
*/
public static SmsUdhElement get8BitConcatUdh(int refNr, int totalNumberOfSms, int seqNr)
{
byte[] udh = new byte[3];
udh[0] = (byte) (refNr & 0xff);
udh[1] = (byte) (totalNumberOfSms & 0xff);
udh[2] = (byte) (seqNr & 0xff);
return new SmsUdhElement(SmsUdhIei.CONCATENATED_8BIT, udh);
}
/**
* Creates a "Message waiting" UDH element using UDH_IEI_SPECIAL_MESSAGE.
*
* If more than one type of message is required to be indicated within
* one SMS message, then multiple "Message waiting" UDH elements must
* be used.
*
* Special handling in concatenated messages:
*
* "In the case where this IEI is to be used in a concatenated SM then the
* IEI, its associated IEI length and IEI data shall be contained in the
* first segment of the concatenated SM. The IEI, its associated IEI length
* and IEI data should also be contained in every subsequent segment of the
* concatenated SM although this is not mandatory. However, in the case
* where these elements are not contained in every subsequent segment of
* the concatenated SM and where an out of sequence segment delivery
* occurs or where the first segment is not delivered then processing
* difficulties may arise at the receiving entity which may result in
* the concatenated SM being totally or partially discarded."
*
*
* @param storeMsg Set to true if the message should be stored
* @param msgType Message type, may be one of MESSAGE_WAITING_VOICE,
* MESSAGE_WAITING_FAX, MESSAGE_WAITING_EMAIL or MESSAGE_WAITING_OTHER.
* @param msgCount Number of messages waiting for retrieval. Max 255
* messages. The value 255 shall be taken to mean 255 or greater.
* @return A SmsUdhElement
*/
public static SmsUdhElement getMessageWaitingUdh(boolean storeMsg, int msgType, int msgCount)
{
byte[] udh = new byte[2];
udh[0] = (byte) (msgType & 0x7f);
if ( storeMsg )
{
udh[0] |= (byte) (0x80);
}
udh[1] = (byte) (msgCount & 0xff);
return new SmsUdhElement(SmsUdhIei.SPECIAL_MESSAGE, udh);
}
/**
* Creates a "8 bit Application Port Adressing" UDH element
* using UDH_IEI_APP_PORT_8BIT
*
* Note! Only values between 240 and 255 are usable, the rest of the port
* numbers are marked as reserved.
*
* Special handling in concatenated messages:
*
* In the case where this IE is to be used in a concatenated SM then the
* IEI, its associated IEI length and IEI data shall be contained in the
* first segment of the concatenated SM. The IEI, its associated IEI length
* and IEI data shall also be contained in every subsequent segment of the
* concatenated SM.
*
* @param destPort Destination port
* @param origPort Source port
* @return A SmsUdhElement
*/
public static SmsUdhElement get8BitApplicationPortUdh(SmsPort destPort, SmsPort origPort)
{
byte[] udh = new byte[2];
int destPortNo = destPort.getPort();
int origPortNo = origPort.getPort();
udh[0] = (byte) (destPortNo & 0xff);
udh[1] = (byte) (origPortNo & 0xff);
return new SmsUdhElement(SmsUdhIei.APP_PORT_8BIT, udh);
}
/**
* Creates a "16 bit Application Port Adressing" UDH element
* using UDH_IEI_APP_PORT_16BIT
*
* Note! Only values between 0 and 16999 are usable, the rest of the port
* numbers are marked as reserved.
*
* Special handling in concatenated messages:
*
* In the case where this IE is to be used in a concatenated SM then the
* IEI, its associated IEI length and IEI data shall be contained in the
* first segment of the concatenated SM. The IEI, its associated IEI length
* and IEI data shall also be contained in every subsequent segment of the
* concatenated SM.
*
* @param destPort Destination port
* @param origPort Source port
* @return A SmsUdhElement
*/
public static SmsUdhElement get16BitApplicationPortUdh(SmsPort destPort, SmsPort origPort)
{
byte[] udh = new byte[4];
int destPortNo = destPort.getPort();
int origPortNo = origPort.getPort();
udh[0] = (byte) ((destPortNo >> 8) & 0xff);
udh[1] = (byte) (destPortNo & 0xff);
udh[2] = (byte) ((origPortNo >> 8) & 0xff);
udh[3] = (byte) (origPortNo & 0xff);
return new SmsUdhElement(SmsUdhIei.APP_PORT_16BIT, udh);
}
/**
* Creates a "16Bit concatenated" UDH element using UDH_IEI_CONCATENATED_16BIT
*
* This can be used to create a concatenated SMS.
*
* @param refNr The reference number of this SMS, must be the same in
* all SMS. Max 65536
* @param totalNumberOfSms Total number of SMS. Max 255
* @param seqNr Sequence number. Max 255
* @return A SmsUdhElement
*/
public static SmsUdhElement get16BitConcatUdh(int refNr, int totalNumberOfSms, int seqNr)
{
byte[] udh = new byte[4];
udh[0] = (byte) ((refNr >> 8) & 0xff);
udh[1] = (byte) (refNr & 0xff);
udh[2] = (byte) (totalNumberOfSms & 0xff);
udh[3] = (byte) (seqNr & 0xff);
return new SmsUdhElement(SmsUdhIei.CONCATENATED_16BIT, udh);
}
}