ie.ncl.wap.push
Class WAPPush

java.lang.Object
  ie.ncl.wap.push.WAPPush

public class WAPPush
extends java.lang.Object

Object used to send WAP Push Requests messages. The transport bearer used is Short Message Service (SMS).

Author:

Michael Kerrin

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

Constructor Summary

WAPPush(Sender sender)
Create a WAP Push connection.

Method Summary

void	close() Close the WAP Push connection.
void	connect() Connect the underlying transport.
static int	extractTransactionIDFromDeliveryReceipt(Message msg) This static method is used to check if a delivery receipt is one from a WAP Push message and if so, extract the Transaction ID.
java.lang.String	getLastSentMessageId() The smsc id for the last message sent.
void	send(WSPRequest message, Address address) Send a WSPRequest to the specified address.
void	send(WSPRequest message, Address destination, Address source) Send a WSPRequest to the specified address.
void	send(WSPRequest message, Address destination, Address source, boolean registered) Send a WSPRequest to the specified address.
void	send(WSPRequest message, Address destination, Address source, boolean registered, boolean confirmed) Send a WSPRequest to the specified address.
void	send(WSPRequest message, Address address, boolean registered) Send a WSPRequest to the specified address.
void	send(WSPRequest message, Address destination, boolean registered, boolean confirmed) Send a WSPRequest to the specified address.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WAPPush

public WAPPush(Sender sender)
        throws ConnectionException

Create a WAP Push connection. Sender is the bearer used to send the messages. SMS bearer is currently supported. See the SMSJDK toolkit for more detail on how to create a ie.ncl.msg.Sender object.

Throws:

ConnectionException

Method Detail

close

public void close()

Close the WAP Push connection.

connect

public void connect()
             throws ConnectionException

Connect the underlying transport.

Throws:

ConnectionException

send

public void send(WSPRequest message,
                 Address destination,
                 boolean registered,
                 boolean confirmed)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings. Setting the registered flag will register the WAP Push message and a receipt will be received on delivery. Setting the confirmed flag will issue a Confirmed Push (instead of an unconfirmed Push). Push responses will be received on the corresponding receiver connection. The decoding of push responses are not supported at this time.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

send

public void send(WSPRequest message,
                 Address destination,
                 Address source,
                 boolean registered,
                 boolean confirmed)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings. Setting the registered flag will register the WAP Push message and a receipt will be received on delivery. Setting the confirmed flag will issue a Confirmed Push (instead of an unconfirmed Push). Push responses will be received on the corresponding receiver connection. The decoding of push responses are not supported at this time.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

getLastSentMessageId

public java.lang.String getLastSentMessageId()

The smsc id for the last message sent.

send

public void send(WSPRequest message,
                 Address address)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

send

public void send(WSPRequest message,
                 Address destination,
                 Address source)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

send

public void send(WSPRequest message,
                 Address address,
                 boolean registered)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. The request can be optionally registered in which case a delivery receipt will be generated. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

send

public void send(WSPRequest message,
                 Address destination,
                 Address source,
                 boolean registered)
          throws MessageException,
                 ConnectionException,
                 ie.ncl.wap.wsp.InvalidEncodingException,
                 ie.ncl.net.pdu.EncoderException,
                 ie.ncl.wap.wsp.UnImplementedException,
                 java.io.IOException

Send a WSPRequest to the specified address. The request can be optionally registered in which case a delivery receipt will be generated. A WSPRequest can be a bookmark, service indicator, service loading, cache operation or over the air settings.

Throws:

MessageException

ConnectionException

ie.ncl.wap.wsp.InvalidEncodingException

ie.ncl.net.pdu.EncoderException

ie.ncl.wap.wsp.UnImplementedException

java.io.IOException

See Also:

Bookmark, ServiceIndicator, ServiceLoading, CacheOperation, OTASettings

extractTransactionIDFromDeliveryReceipt

public static int extractTransactionIDFromDeliveryReceipt(Message msg)

This static method is used to check if a delivery receipt is one from a WAP Push message and if so, extract the Transaction ID. This only works with the some protocols (e.g SMPP) delivery receipt messages.

Parameters:

msg -

Returns: