Type alias MsgVpnJndiConnectionFactory

MsgVpnJndiConnectionFactory: {
    allowDuplicateClientIdEnabled?: boolean;
    clientDescription?: string;
    clientId?: string;
    connectionFactoryName?: string;
    dtoReceiveOverrideEnabled?: boolean;
    dtoReceiveSubscriberLocalPriority?: number;
    dtoReceiveSubscriberNetworkPriority?: number;
    dtoSendEnabled?: boolean;
    dynamicEndpointCreateDurableEnabled?: boolean;
    dynamicEndpointRespectTtlEnabled?: boolean;
    guaranteedReceiveAckTimeout?: number;
    guaranteedReceiveReconnectRetryCount?: number;
    guaranteedReceiveReconnectRetryWait?: number;
    guaranteedReceiveWindowSize?: number;
    guaranteedReceiveWindowSizeAckThreshold?: number;
    guaranteedSendAckTimeout?: number;
    guaranteedSendWindowSize?: number;
    messagingDefaultDeliveryMode?: messagingDefaultDeliveryMode;
    messagingDefaultDmqEligibleEnabled?: boolean;
    messagingDefaultElidingEligibleEnabled?: boolean;
    messagingJmsxUserIdEnabled?: boolean;
    messagingTextInXmlPayloadEnabled?: boolean;
    msgVpnName?: string;
    transportCompressionLevel?: number;
    transportConnectRetryCount?: number;
    transportConnectRetryPerHostCount?: number;
    transportConnectTimeout?: number;
    transportDirectTransportEnabled?: boolean;
    transportKeepaliveCount?: number;
    transportKeepaliveEnabled?: boolean;
    transportKeepaliveInterval?: number;
    transportMsgCallbackOnIoThreadEnabled?: boolean;
    transportOptimizeDirectEnabled?: boolean;
    transportPort?: number;
    transportReadTimeout?: number;
    transportReceiveBufferSize?: number;
    transportReconnectRetryCount?: number;
    transportReconnectRetryWait?: number;
    transportSendBufferSize?: number;
    transportTcpNoDelayEnabled?: boolean;
    xaEnabled?: boolean;
}

Type declaration

  • Optional allowDuplicateClientIdEnabled?: boolean

    Enable or disable whether new JMS connections can use the same Client identifier (ID) as an existing connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.3.

  • Optional clientDescription?: string

    The description of the Client. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional clientId?: string

    The Client identifier (ID). If not specified, a unique value for it will be generated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional connectionFactoryName?: string

    The name of the JMS Connection Factory.

  • Optional dtoReceiveOverrideEnabled?: boolean

    Enable or disable overriding by the Subscriber (Consumer) of the deliver-to-one (DTO) property on messages. When enabled, the Subscriber can receive all DTO tagged messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional dtoReceiveSubscriberLocalPriority?: number

    The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on the local broker that the Subscriber is directly connected to. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

  • Optional dtoReceiveSubscriberNetworkPriority?: number

    The priority for receiving deliver-to-one (DTO) messages by the Subscriber (Consumer) if the messages are published on a remote broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

  • Optional dtoSendEnabled?: boolean

    Enable or disable the deliver-to-one (DTO) property on messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional dynamicEndpointCreateDurableEnabled?: boolean

    Enable or disable whether a durable endpoint will be dynamically created on the broker when the client calls "Session.createDurableSubscriber()" or "Session.createQueue()". The created endpoint respects the message time-to-live (TTL) according to the "dynamicEndpointRespectTtlEnabled" property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional dynamicEndpointRespectTtlEnabled?: boolean

    Enable or disable whether dynamically created durable and non-durable endpoints respect the message time-to-live (TTL) property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional guaranteedReceiveAckTimeout?: number

    The timeout for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional guaranteedReceiveReconnectRetryCount?: number

    The maximum number of attempts to reconnect to the host or list of hosts after the guaranteed messaging connection has been lost. The value "-1" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1. Available since 2.14.

  • Optional guaranteedReceiveReconnectRetryWait?: number

    The amount of time to wait before making another attempt to connect or reconnect to the host after the guaranteed messaging connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000. Available since 2.14.

  • Optional guaranteedReceiveWindowSize?: number

    The size of the window for guaranteed messages received by the Subscriber (Consumer), in messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 18.

  • Optional guaranteedReceiveWindowSizeAckThreshold?: number

    The threshold for sending the acknowledgement (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of guaranteedReceiveWindowSize. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 60.

  • Optional guaranteedSendAckTimeout?: number

    The timeout for receiving the acknowledgement (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2000.

  • Optional guaranteedSendWindowSize?: number

    The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

  • Optional messagingDefaultDeliveryMode?: messagingDefaultDeliveryMode

    The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "persistent". The allowed values and their meaning are:

    "persistent" - The broker spools messages (persists in the Message Spool) as part of the send operation.
"non-persistent" - The broker does not spool messages (does not persist in the Message Spool) as part of the send operation.
  • Optional messagingDefaultDmqEligibleEnabled?: boolean

    Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional messagingDefaultElidingEligibleEnabled?: boolean

    Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional messagingJmsxUserIdEnabled?: boolean

    Enable or disable inclusion (adding or replacing) of the JMSXUserID property in messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional messagingTextInXmlPayloadEnabled?: boolean

    Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional transportCompressionLevel?: number

    The ZLIB compression level for the connection to the broker. The value "0" means no compression, and the value "-1" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1.

  • Optional transportConnectRetryCount?: number

    The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value "0" means a single attempt (no retries), and the value "-1" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional transportConnectRetryPerHostCount?: number

    The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value "0" means a single attempt (no retries), and the value "-1" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional transportConnectTimeout?: number

    The timeout for establishing an initial connection to the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 30000.

  • Optional transportDirectTransportEnabled?: boolean

    Enable or disable usage of Direct Transport mode. When enabled, NON-PERSISTENT messages are sent as direct messages and non-durable topic consumers and temporary queue consumers consume using direct subscriptions rather than from guaranteed endpoints. If disabled all messaging uses guaranteed transport. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional transportKeepaliveCount?: number

    The maximum number of consecutive application-level keepalive messages sent without the broker response before the connection to the broker is closed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional transportKeepaliveEnabled?: boolean

    Enable or disable usage of application-level keepalive messages to maintain a connection with the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional transportKeepaliveInterval?: number

    The interval between application-level keepalive messages, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000.

  • Optional transportMsgCallbackOnIoThreadEnabled?: boolean

    Enable or disable delivery of asynchronous messages directly from the I/O thread. Contact support before enabling this property. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional transportOptimizeDirectEnabled?: boolean

    Enable or disable optimization for the Direct Transport delivery mode. If enabled, the client application is limited to one Publisher (Producer) and one non-durable Subscriber (Consumer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional transportPort?: number

    The connection port number on the broker for SMF clients. The value "-1" means the port is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is -1.

  • Optional transportReadTimeout?: number

    The timeout for reading a reply from the broker, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

  • Optional transportReceiveBufferSize?: number

    The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 65536.

  • Optional transportReconnectRetryCount?: number

    The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value "-1" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional transportReconnectRetryWait?: number

    The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3000.

  • Optional transportSendBufferSize?: number

    The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 65536.

  • Optional transportTcpNoDelayEnabled?: boolean

    Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional xaEnabled?: boolean

    Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to "XAConnectionFactory", "XAQueueConnectionFactory" or "XATopicConnectionFactory". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

Settings

Member Visibility

Theme