net.rim.device.api.io.http
Class PushInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.DataInputStream
              |
              +--net.rim.device.api.io.http.PushInputStream

All Implemented Interfaces:

DataInput

Direct Known Subclasses:

MDSPushInputStream

public abstract class PushInputStream

extends DataInputStream

An abstract class providing a mechanism for push input streams.

Since:

JDE 4.0.0

Field Summary

static int	CONNECTION_IPPP_UID IPP/UID connection type.
static int	CONNECTION_IPV4 IPv4 connection type.
static int	CONNECTION_SMSC SMSC connection type.
static int	DECLINE_REASON_USERDCR Push message discarded due to resource shortage.
static int	DECLINE_REASON_USERDCU Content type of Push message cannot be processed.
static int	DECLINE_REASON_USERPND Push message cannot be delivered to intended destination.
static int	DECLINE_REASON_USERRFS User refused Push message.

Fields inherited from class java.io.DataInputStream

in

Constructor Summary

PushInputStream(InputStream in)
Creates a new PushInputStream instance from a general input stream.

Method Summary

abstract void	accept() Accepts this push, possibly indicating this to the server if the bearer supports acknowledgement.
abstract void	decline(int reasonCode) Declines this push because of the reason provided.
abstract int	getConnectionType() Retrieves the connection type for this push.
abstract String	getSource() Retrieves the source for this push stream.
abstract boolean	isChannelEncrypted() Determines if the channel is encrypted.

Methods inherited from class java.io.DataInputStream

available, close, mark, markSupported, read, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, readUTF, reset, skip, skipBytes

Methods inherited from class java.lang.Object

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

Field Detail

DECLINE_REASON_USERRFS

public static final int DECLINE_REASON_USERRFS

User refused Push message. No specific cause, no retries.

Since:

JDE 4.0.0

DECLINE_REASON_USERPND

public static final int DECLINE_REASON_USERPND

Push message cannot be delivered to intended destination.

Since:

JDE 4.0.0

DECLINE_REASON_USERDCR

public static final int DECLINE_REASON_USERDCR

Push message discarded due to resource shortage.

Since:

JDE 4.0.0

DECLINE_REASON_USERDCU

public static final int DECLINE_REASON_USERDCU

Content type of Push message cannot be processed.

Since:

JDE 4.0.0

CONNECTION_SMSC

public static final int CONNECTION_SMSC

SMSC connection type.

Since:

JDE 4.0.0

CONNECTION_IPV4

public static final int CONNECTION_IPV4

IPv4 connection type.

Since:

JDE 4.0.0

CONNECTION_IPPP_UID

public static final int CONNECTION_IPPP_UID

IPP/UID connection type.

Since:

JDE 4.0.0

Constructor Detail

PushInputStream

public PushInputStream(InputStream in)

Creates a new PushInputStream instance from a general input stream.

Parameters:

in - Super input stream.

Since:

JDE 4.0.0

Method Detail

getSource

public abstract String getSource()

Retrieves the source for this push stream.

Returns:

String form of the source of this push; it could be a UID for a connection, IPv4 address, or SMSC.

Since:

JDE 4.0.0

getConnectionType

public abstract int getConnectionType()

Retrieves the connection type for this push.

Returns:

Enumerated integer representing the types of pushes.

Since:

JDE 4.0.0

decline

public abstract void decline(int reasonCode)
                      throws IOException

Declines this push because of the reason provided.

Parameters:

reasonCode - Code for the reason why the push was declined.

Since:

JDE 4.0.0

accept

public abstract void accept()
                     throws IOException

Accepts this push, possibly indicating this to the server if the bearer supports acknowledgement.

Since:

JDE 4.0.0

isChannelEncrypted

public abstract boolean isChannelEncrypted()

Determines if the channel is encrypted.

Returns:

True if this channel is encrypted; otherwise, false.

Since:

JDE 4.0.0