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

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.DataInputStream
          extended by net.rim.device.api.io.http.PushInputStream
All Implemented Interfaces:
DataInput
Direct Known Subclasses:
MDSPushInputStream, TCPPushInputStream

public abstract class PushInputStream
extends DataInputStream

An abstract class providing a mechanism for push input streams.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

Field Summary
Category: Signed static int CONNECTION_IPPP_UID
          IPP/UID connection type.
Category: Signed static int CONNECTION_IPV4
          IPv4 connection type.
Category: Signed static int CONNECTION_SMSC
          SMSC connection type.
Category: Signed static int DECLINE_REASON_USERDCR
          Push message discarded due to resource shortage.
Category: Signed static int DECLINE_REASON_USERDCU
          Content type of Push message cannot be processed.
Category: Signed static int DECLINE_REASON_USERPND
          Push message cannot be delivered to intended destination.
Category: Signed static int DECLINE_REASON_USERREQ
          User refused Push message.
Category: Signed static int DECLINE_REASON_USERRFS
          User refused Push message.
 
Fields inherited from class java.io.DataInputStream
in
 
Constructor Summary
Category: Signed PushInputStream(InputStream in)
          Creates a new PushInputStream instance from a general input stream.
 
Method Summary
Category: Signed abstract  void accept()
          Accepts this push, possibly indicating this to the server if the bearer supports acknowledgement.
Category: Signed abstract  void decline(int reasonCode)
          Declines this push because of the reason provided.
Category: Signed abstract  int getConnectionType()
          Retrieves the connection type for this push.
Category: Signed  String getSender()
          Retrieves the sender for this push stream.
Category: Signed abstract  String getSource()
          Retrieves the source for this push stream.
Category: Signed 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, readUTF, readUTF, readUnsignedByte, readUnsignedShort, reset, skip, skipBytes
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

DECLINE_REASON_USERREQ

public static final int DECLINE_REASON_USERREQ
User refused Push message. No specific cause, retries allowed.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.2.0

DECLINE_REASON_USERRFS

public static final int DECLINE_REASON_USERRFS
User refused Push message. No specific cause, no retries.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

DECLINE_REASON_USERPND

public static final int DECLINE_REASON_USERPND
Push message cannot be delivered to intended destination.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

DECLINE_REASON_USERDCR

public static final int DECLINE_REASON_USERDCR
Push message discarded due to resource shortage.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

DECLINE_REASON_USERDCU

public static final int DECLINE_REASON_USERDCU
Content type of Push message cannot be processed.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

CONNECTION_SMSC

public static final int CONNECTION_SMSC
SMSC connection type.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

CONNECTION_IPV4

public static final int CONNECTION_IPV4
IPv4 connection type.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

CONNECTION_IPPP_UID

public static final int CONNECTION_IPPP_UID
IPP/UID connection type.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

getSender

public String getSender()
Retrieves the sender for this push stream. This can differ from the source of the message where the message originated.

Returns:
String form of the sender of this push.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

getConnectionType

public abstract int getConnectionType()
Retrieves the connection type for this push.

Returns:
Enumerated integer representing the types of pushes.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 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.
Throws:
IOException
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

accept

public abstract void accept()
                     throws IOException
Accepts this push, possibly indicating this to the server if the bearer supports acknowledgement.

Throws:
IOException
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

isChannelEncrypted

public abstract boolean isChannelEncrypted()
Determines if the channel is encrypted.

Returns:
True if this channel is encrypted; otherwise, false.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.