oracle.sdp.messaging.driver
Enum DriverConfigPropertyNames

java.lang.Object
  java.lang.Enum<DriverConfigPropertyNames>
      oracle.sdp.messaging.driver.DriverConfigPropertyNames

All Implemented Interfaces:

Serializable, java.lang.Comparable<DriverConfigPropertyNames>

public enum DriverConfigPropertyNames
extends java.lang.Enum<DriverConfigPropertyNames>

Enumeration of required driver configuration properties to be provided by all driver resource adapters. For every config property name listed here, there must be a corresponding config-property entry in the driver's ra.xml. For example:

    <config-property>
      <config-property-name>SupportedDeliveryTypes</config-property-name>
      <config-property-type>java.lang.String</config-property-type>
      <config-property-value>SMS,WAP_PUSH</config-property-value>
    </config-property>
 

Since:

11.0.0

Enum Constant Summary

Capability
The driver capability.

Cost
The cost level.

DefaultSenderAddress
The default sender address.

InstanceName
The driver instance name.

SenderAddresses
The list of sender addresses that the driver supports.

SendingQueuesInfo
The information of the queues that this driver's DriverDispatcherBean MDB instances are listening to for sending (outbound) messages.

Speed
The speed level.

SupportedCarriers
The comma-separated list of supported carriers.

SupportedContentTypes
The comma-separated list of supported content types.

SupportedDeliveryTypes
The comma-separated list of supported delivery types.

SupportedProtocols
The comma-separated list of supported protocols.

SupportedStatusTypes
The types of status supported by the driver.

SupportsCancel
Indicates whether the driver supports the message cancel operation.

SupportsReplace
Indicates whether the driver supports the message replace operation.

SupportsStatusPolling
For certain protocols, an active polling of the remote gateway must be performed to check the status of a message previously sent.

SupportsTracking
Indicates whether the driver supports status tracking.

Method Summary

static DriverConfigPropertyNames	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DriverConfigPropertyNames[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Capability

public static final DriverConfigPropertyNames Capability

The driver capability. Supported Values: SEND, RECEIVE, BOTH (default).

See Also:

CapabilityType

Cost

public static final DriverConfigPropertyNames Cost

The cost level. Cost is an optional property used in message routing. Its value can be in [0 .. 10]. 0 is least expensive, 10 is most expensive. If the value is not in this range, cost is considered to be 0.

DefaultSenderAddress

public static final DriverConfigPropertyNames DefaultSenderAddress

The default sender address. This is the address the driver uses when sending a message that has no sender address specified, or when the specified sender address isn't in the sender addresses list and the driver doesn't support using the application provided sender address.

InstanceName

public static final DriverConfigPropertyNames InstanceName

The driver instance name. Recommended to use the JNDI name of the Driver RA's connection factory.

SenderAddresses

public static final DriverConfigPropertyNames SenderAddresses

The list of sender addresses that the driver supports. If provided by the driver, the Messaging Engine can use this to route a sending message to the driver by matching against the sender address of the message.

SendingQueuesInfo

public static final DriverConfigPropertyNames SendingQueuesInfo

The information of the queues that this driver's DriverDispatcherBean MDB instances are listening to for sending (outbound) messages.

The format for the SendingQueuesInfo value (BNF notation) is:

queuesInfo := queue-info *(";" queue-info)

queue-info := queue-connection-factory-jndi-name ":" queue-jndi-name *("," queue-jndi-name)

Note: "*(element)" means zero or more occurrences of element.

Examples:

• One queue connection factory with JNDI name "jms/MyQCF1" for one queue with JNDI name "jms/sdpm/MyQ1":

  jms/MyQCF1:jms/sdpm/MyQ1

• One queue connection factory with JNDI name "jms/MyQCF1" for two queues with JNDI names "jms/sdpm/MyQ1" and "jms/sdpm/MyQ2":

  jms/MyQCF1:jms/sdpm/MyQ1,jms/sdpm/MyQ2

• One queue connection factory with JNDI name "jms/MyQCF1" for one queue with JNDI name "jms/sdpm/MyQ1" and another queue connection factory with JNDI name "jms/MyQCF2" for a queue with JNDI name "jms/sdpm/MyQ2":

  jms/MyQCF1:jms/sdpm/MyQ1;jms/MyQCF2:jms/sdpm/MyQ2

Speed

public static final DriverConfigPropertyNames Speed

The speed level. Speed is an optional property used in message routing. Its value can be in [0 .. 10]. 0 is slowest, 10 is fastest. If the value is not in this range, speed is considered to be 0.

SupportedCarriers

public static final DriverConfigPropertyNames SupportedCarriers

The comma-separated list of supported carriers. This is an optional property used in message routing.

SupportedContentTypes

public static final DriverConfigPropertyNames SupportedContentTypes

The comma-separated list of supported content types.

SupportedDeliveryTypes

public static final DriverConfigPropertyNames SupportedDeliveryTypes

The comma-separated list of supported delivery types.

SupportedProtocols

public static final DriverConfigPropertyNames SupportedProtocols

The comma-separated list of supported protocols. This is an optional property used in message routing.

SupportedStatusTypes

public static final DriverConfigPropertyNames SupportedStatusTypes

The types of status supported by the driver. This depends on

1. what types the gateway supports,
2. what types the driver implements.

The types should be the common denominator of these two.

SupportsCancel

public static final DriverConfigPropertyNames SupportsCancel

Indicates whether the driver supports the message cancel operation.

SupportsReplace

public static final DriverConfigPropertyNames SupportsReplace

Indicates whether the driver supports the message replace operation.

SupportsStatusPolling

public static final DriverConfigPropertyNames SupportsStatusPolling

For certain protocols, an active polling of the remote gateway must be performed to check the status of a message previously sent. This property indicates whether the driver supports such status polling. If it does, the Messaging engine may invoke the driver connection's getStatus() operation.

SupportsTracking

public static final DriverConfigPropertyNames SupportsTracking

Indicates whether the driver supports status tracking.

Method Detail

valueOf

public static DriverConfigPropertyNames valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static DriverConfigPropertyNames[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DriverConfigPropertyNames c : DriverConfigPropertyNames.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared