Solace Inbound Endpoint Reference¶ The following sections provide a detailed reference for the Solace Inbound Endpoint in WSO2 Integrator: MI. The inbound endpoint listens on a Solace queue or topic and injects each received message into a mediation sequence. In the synapse configuration, parameters are written as <parameter name="...">value</parameter> elements inside an <inboundEndpoint>. The inbound class is org.wso2.carbon.inbound.solace.SolaceEventListener. Generic parameters¶ ParameterDescriptionRequiredDefault nameA unique name for this inbound endpoint configuration.Yes- sequenceThe mediation sequence that processes consumed messages.Yes- onErrorThe error-handling sequence executed if message consumption or processing fails.No- inbound.behaviorThe message consumption mode. Fixed at eventBased for the Solace inbound endpoint.YeseventBased sequentialIf enabled, messages are processed one after another within the injecting sequence, preserving order.Notrue coordinationIn a clustered environment, set to true so that only a single worker node consumes messages at any time.Notrue suspendWhether the inbound endpoint starts in a suspended state.Nofalse Connection parameters¶ ParameterDescriptionRequiredDefault solace.hostSolace broker host, e.g. tcp://host:port or tcps://host:port for SSL.Yestcp://localhost:55555 solace.vpnNameSolace Message VPN name.Yesdefault solace.authenticationSchemeAuthentication scheme: BASIC, CLIENT_CERTIFICATE, or OAUTH2.YesBASIC solace.usernameUsername for broker authentication. Required when scheme is BASIC.Conditional- solace.passwordPassword for broker authentication. Required when scheme is BASIC. Supports Secure Vault expressions.Conditional- apiProvidedUsernameOptional. Used only when the VPN allows api-provided usernames. For CLIENT_CERTIFICATE, leave blank to use the certificate CN; for OAUTH2, leave blank.No- solace.oauth2AccessTokenOAuth2 access token. Used when scheme is OAUTH2.Conditional- solace.oidcIdTokenOIDC ID token (alternative to the access token).Conditional- solace.oauth2IssuerIdentifierOAuth2 issuer identifier (optional).No- solace.clientNameOptional client name for the session. The broker assigns one automatically if empty.No- Note When solace.authenticationScheme is OAUTH2, you must provide either solace.oauth2AccessToken or solace.oidcIdToken; otherwise the endpoint fails to start. Destination parameters¶ ParameterDescriptionRequiredDefault solace.destinationTypeType of Solace destination: QUEUE or TOPIC.YesQUEUE solace.subscriptionTypeFor topics: DIRECT (non-persistent) or DURABLE (persistent). Applies only when destinationType is TOPIC.ConditionalDIRECT solace.destinationNameName of the queue or topic. For TOPIC + DIRECT, comma-separated values create multiple subscriptions; wildcards (>, *) are supported.Yes- solace.dteNameName of the Durable Topic Endpoint (DTE) for persistent topic subscriptions. Required for TOPIC + DURABLE.Conditional- Consumer parameters¶ ParameterDescriptionRequiredDefault solace.contentTypeOverride content-type detection for the synapse message (application/json, application/xml, text/plain). Leave empty to auto-detect.No(auto-detect) solace.binaryPayloadAsBase64When enabled, raw bytes of a BytesMessage are base64-encoded instead of UTF-8 decoded (prevents corruption of binary data). Auto-sets content type to application/octet-stream.Nofalse solace.selectorOptional SQL-92 expression evaluated server-side on headers and user properties. Only matching messages are delivered. Applies to QUEUE and DTE destinations; ignored for direct topic subscribers. Example: priority >= 5 AND tenant = 'acme'.No- Guaranteed messaging parameters¶ These apply to QUEUE destinations and DURABLE topic subscriptions. ParameterDescriptionRequiredDefault solace.autoAckWhen enabled, messages are auto-acknowledged on receipt and the sequence cannot influence settlement. Leave false to call acknowledgeMessage / nackMessage from the sequence.Notrue solace.failureOutcomeFallback settlement used only when the sequence does not call ack/nack itself (e.g. unhandled exception). Ignored when autoAck is on. NONE: leave unsettled (broker redelivers after timeout). FAILED: redeliver immediately. REJECTED: route straight to the DMQ.NoNONE solace.subAckWindowSizeNumber of guaranteed messages the broker can have in flight before it must receive an acknowledgement. Raise for higher throughput, lower for stricter ordering or memory-constrained consumers.No255 Settlement outcomes For nackMessage to use FAILED or REJECTED, the broker must support negative acknowledgement and the queue should have a Dead Message Queue and max-redelivery configured so rejected/exhausted messages have somewhere to go. Connection retry parameters¶ ParameterDescriptionRequiredDefault solace.connectionTimeoutTimeout in milliseconds for the initial connection to the broker.No30000 solace.connectRetriesNumber of times to retry the initial connection.No3 solace.connectRetriesPerHostNumber of times to retry connection to each host in the host list.No3 solace.reconnectRetriesNumber of times to retry after a connection loss.No3 solace.reconnectRetryWaitWait time in milliseconds between reconnect attempts.No3000 Connection recovery On a connection loss the endpoint reconnects according to the retry parameters above. If reconnection is exhausted, or the broker reports a terminal session or flow failure, the endpoint tears itself down and the WSO2 Integrator: MI framework automatically resumes it, re-establishing the connection. No manual intervention or restart is required. Destination provisioning parameters¶ If enabled, the queue or DTE is auto-created on the broker if it does not already exist. Applies to QUEUE destinations and DURABLE topic subscriptions. ParameterDescriptionRequiredDefault solace.provisionDestinationAuto-provision the queue or DTE if it does not exist.Nofalse solace.queueAccessTypeAccess type for a provisioned queue: EXCLUSIVE or NON_EXCLUSIVE.NoEXCLUSIVE solace.queueQuotaMBMaximum spool usage in MB for the provisioned queue. 0 means broker default.No0 solace.queueMaxMsgSizeMaximum message size in bytes for the provisioned queue. 0 means broker default.No0 solace.queueRespectTTLIf enabled, the queue respects message TTL and discards expired messages.Nofalse solace.queueMaxMsgRedeliveryMaximum redelivery attempts before a message is moved to the DMQ. 0 means broker default.No0 Advanced session parameters¶ ParameterDescriptionRequiredDefault solace.generateReceiveTimestampsRecords the broker receive time on every inbound message, exposed in the sequence as the synapse property solace.receiveTimestamp (epoch milliseconds). Useful for end-to-end latency / SLA tracking.Nofalse SSL/TLS security parameters¶ Used with tcps:// hosts. ParameterDescriptionRequiredDefault solace.sslTrustStorePathPath to the JKS/PKCS12 file containing CAs trusted when validating the broker's server certificate. Leave empty to use the JVM default truststore.No- solace.sslTrustStorePasswordPassword for the trust store file.No- solace.sslTrustStoreFormatTrust store format: JKS or PKCS12.NoJKS solace.sslKeyStorePathPath to the JKS/PKCS12 file containing the client certificate and private key. Required when scheme is CLIENT_CERTIFICATE.Conditional- solace.sslKeyStorePasswordPassword for the key store file.No- solace.sslKeyStoreFormatKey store format: JKS or PKCS12.NoJKS solace.sslKeyPasswordPassword protecting the private key entry inside the key store. Often the same as the key-store password.No- solace.sslValidateCertificateValidate the broker's certificate chain (issuer, signature, hostname). Set false ONLY for self-signed brokers in dev/lab, never in production.Notrue solace.sslValidateCertificateDateValidate the broker certificate's notBefore/notAfter dates. Ignored when solace.sslValidateCertificate is false.Notrue Message properties¶ For each consumed message, the inbound endpoint sets the following solace.* properties on the synapse message context, which the injecting sequence can read (for example with the Property mediator). Conditional fields are set only when present on the message. PropertyDescription solace.messageIdBroker-assigned message ID. solace.destinationQueue or topic the message was received on. solace.deliveryModeDIRECT, PERSISTENT, or NON_PERSISTENT. solace.redeliveredtrue if the broker has redelivered this message. solace.deliveryCountNumber of delivery attempts, when the broker provides it. solace.correlationIdCorrelation ID carried on the message (if set). solace.replyToReply-to destination, if the message set one. solace.priorityMessage priority (if set). solace.dmqEligibleWhether the message is Dead-Message-Queue eligible. solace.receiveTimestampBroker receive time (epoch milliseconds). Set only when solace.generateReceiveTimestamps is enabled. solace.userProp.<key>One property per publisher-supplied user property, each prefixed with solace.userProp.. Sample inbound endpoint configuration¶ A queue listener using basic authentication with manual settlement: <?xml version="1.0" encoding="UTF-8"?> <inboundEndpoint name="OrderQueueListener" class="org.wso2.carbon.inbound.solace.SolaceEventListener" sequence="OrderQueueListener-inboundSequence" onError="OrderQueueListener-errorSequence"> <parameters xmlns="http://ws.apache.org/ns/synapse"> <parameter name="inbound.behavior">eventBased</parameter> <parameter name="sequential">true</parameter> <parameter name="coordination">true</parameter> <parameter name="suspend">false</parameter> <parameter name="solace.host">tcp://localhost:55555</parameter> <parameter name="solace.vpnName">default</parameter> <parameter name="solace.authenticationScheme">BASIC</parameter> <parameter name="solace.username">default</parameter> <parameter name="solace.password">default</parameter> <parameter name="solace.destinationType">QUEUE</parameter> <parameter name="solace.destinationName">Q.orders</parameter> <parameter name="solace.contentType">application/json</parameter> <parameter name="solace.autoAck">false</parameter> <parameter name="solace.failureOutcome">FAILED</parameter> <parameter name="solace.subAckWindowSize">255</parameter> </parameters> </inboundEndpoint> A direct topic subscriber (the request-reply replier): <?xml version="1.0" encoding="UTF-8"?> <inboundEndpoint name="SeatRequestListener" class="org.wso2.carbon.inbound.solace.SolaceEventListener" sequence="SeatRequestListener-inboundSequence" onError="SeatRequestListener-errorSequence"> <parameters xmlns="http://ws.apache.org/ns/synapse"> <parameter name="inbound.behavior">eventBased</parameter> <parameter name="sequential">true</parameter> <parameter name="coordination">true</parameter> <parameter name="solace.host">tcp://localhost:55555</parameter> <parameter name="solace.vpnName">default</parameter> <parameter name="solace.authenticationScheme">BASIC</parameter> <parameter name="solace.username">default</parameter> <parameter name="solace.password">default</parameter> <parameter name="solace.destinationType">TOPIC</parameter> <parameter name="solace.subscriptionType">DIRECT</parameter> <parameter name="solace.destinationName">airline/request/seats/></parameter> <parameter name="solace.contentType">application/json</parameter> </parameters> </inboundEndpoint>