|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.io.messaging.InboundDestinationConfigurationFactory
public class InboundDestinationConfigurationFactory
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:
ReceiverDestination
that this InboundConfigurationDestination
configures.
If enabled, other applications that attempt to listen on a given URI will receive an exception. If disabled, every
application that listens on the specific URI will receive a copy of the message.Message
objects for this
destination after they have been received. If "Persistent Mode" is true, messages are persisted on the device and
will survive device reboot. This functionality is not supported in BlackBerry Java SDK 6.0 and will be implemented
in the future. As result, all received messages are stored in the memory and will be lost on device reboot, if
application didn't have an opportunity to process them.
Note that when the Communication API processes messages received via BlackBerry Push Server, it will invoke
PushInputStream.accept()
to acknowledge receipt of a Push message on behalf of an application. However,
when Persistent mode is off, the message will be stored in memory. If an application does not process it before a reboot, the
message will be lost. In this case, the message reliability contract between an application and the BlackBerry Push Server
cannot be fulfilled. The proposed solution would be to enable Auto-Start mode to allow the Communication API to wake the
application to let it consume the outstanding incoming messages.
ReceiverDestination
, call the appropriate method in this
class, then pass the resulting object to the appropriate receiver destination creation method in
DestinationFactory
.
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 |
---|
public static InboundDestinationConfiguration createIPCConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode)
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).
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
.
InboundDestinationConfiguration
object representing configuration used by local (IPC)
inbound destinations.public static InboundDestinationConfiguration createBESConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode)
BESInboundDestinationConfiguration
object. This configuration will be used by inbound
destinations for incoming push messages created in a BlackBerry® Enterprise Server environment.
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
.
InboundDestinationConfiguration
object representing configuration used by BlackBerry
Push Server destinations.public static InboundDestinationConfiguration createBPSConfiguration(boolean autoStart, boolean exclusiveMode, boolean persistentMode, String appId, String serverUrl)
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
InboundDestinationConfiguration
object representing configuration used by BlackBerry ®
Push Service destinations
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.