net.rim.device.api.io.messaging
Class InboundDestinationConfigurationFactory

java.lang.Object
  extended by net.rim.device.api.io.messaging.InboundDestinationConfigurationFactory

public class InboundDestinationConfigurationFactory
extends Object

The InboundDestinationConfiguration objects generated by this class are used by DestinationFactory when creating ReceiverDestination objects. An InboundDestinationConfiguration object defines how a Message should be treated when it arrives on the device.

Configuration options include:

To create a ReceiverDestination, call the appropriate method in this class, then pass the resulting object to the appropriate receiver destination creation method in DestinationFactory.

Since:
BlackBerry API 6.0.0

Method Summary
static InboundDestinationConfiguration createBESConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode)
          Creates a BESInboundDestinationConfiguration object.
static InboundDestinationConfiguration createBPSConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode, String appId, String serverUrl)
          Creates a BPSInboundDestinationConfiguration object.
static InboundDestinationConfiguration createIPCConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode)
          Creates an IPCInboundDestinationConfiguration object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Method Detail

createIPCConfiguration

public static InboundDestinationConfiguration createIPCConfiguration(boolean autoStart,
                                                                     boolean exclusiveMode,
                                                                     boolean persistentMode)
Creates an IPCInboundDestinationConfiguration object. The configuration will be used by the inbound destinations created for consumption of incoming messages generated by other applications running on the same device (IPC messages).

Parameters:
autoStart - Indicates whether or not to auto-start when a message arrives.
exclusiveMode - Indicates whether or not to use exclusive URI mode. If enabled, attempts by other applications to listen on this URI will throw an exception. Similarly, if you attempt to listen to a URI locked exclusively in by another application, an exception will be thrown on createNonblockingReceiverDestination or createBlockingReceiverDestination.
persistentMode - Indicates whether or not persistent mode will be used. Persistent Mode is currently not supported. Attempt to set the parameter to "true" will cause UnsupportedOperationException.
Returns:
An InboundDestinationConfiguration object representing configuration used by local (IPC) inbound destinations.
Since:
BlackBerry API 6.0.0

createBESConfiguration

public static InboundDestinationConfiguration createBESConfiguration(boolean autoStart,
                                                                     boolean exclusiveMode,
                                                                     boolean persistentMode)
Creates a BESInboundDestinationConfiguration object. This configuration will be used by inbound destinations for incoming push messages created in a BlackBerry® Enterprise Server environment.

Parameters:
autoStart - Indicates whether or not to auto-start when a message arrives.
exclusiveMode - Indicates whether or not to use exclusive URI mode. If enabled, attempts by other applications to listen on this URI will throw an exception. Similarly, if you attempt to listen to a URI locked exclusively in by another application, an exception will be thrown on createNonblockingReceiverDestination or createBlockingReceiverDestination.
persistentMode - Indicates whether or not persistent mode will be used. Persistent Mode is currently not supported. Attempt to set the parameter to "true" will cause UnsupportedOperationException.
Returns:
An InboundDestinationConfiguration object representing configuration used by BlackBerry Push Server destinations.
Since:
BlackBerry API 6.0.0

createBPSConfiguration

public static InboundDestinationConfiguration createBPSConfiguration(boolean autoStart,
                                                                     boolean exclusiveMode,
                                                                     boolean persistentMode,
                                                                     String appId,
                                                                     String serverUrl)
Creates a BPSInboundDestinationConfiguration object. This configuration will be used by the inbound destinations created for incoming push messages created in a BlackBerry Push Service environment.

Parameters:
autoStart - Indicates whether or not to auto-start when a message arrives.
exclusiveMode - Indicates whether or not to use exclusive URI mode. If enabled, attempts by other applications to listen on this URI will throw an exception. Similarly, if you attempt to listen to a URI locked exclusively in by another application, an exception will be thrown on createNonblockingReceiverDestination or createBlockingReceiverDestination.
persistentMode - Indicates whether or not persistent mode will be used. Persistent Mode is currently not supported. Attempt to set the parameter to "true" will cause UnsupportedOperationException.
appId - An application ID required by the BlackBerry ® Push Service for client-side push application registration. For more information, see the Push API
serverUrl - A URL that points to the server which tracks client-side push applications. For more information, see the Push API
Returns:
A InboundDestinationConfiguration object representing configuration used by BlackBerry ® Push Service destinations
Since:
BlackBerry API 6.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal