# Solace Platform Documentation > Full index: every per-area index file concatenated into one document. Each section corresponds to one documentation area from [llms.txt](https://docs.solace.com/llms.txt), with headings demoted one level so each area nests under this document. Links point to the Markdown version of each page. ## Getting Started > Orientation material for people new to the Solace Platform. Covers a high-level product overview, event-driven architecture and event-mesh fundamentals, best practices, and a glossary of terms. - [What Is Solace Platform?](https://docs.solace.com/Get-Started/solace-platform.md): High-level description of Solace Platform as a complete event-driven integration platform. - [What Is Event-Driven Integration?](https://docs.solace.com/Get-Started/event-mesh-basics.md): Introduces event-driven architecture (EDA) concepts and links to the topics that explain events, messaging, event brokers, topics, and event meshes in more depth. - [What Are Events?](https://docs.solace.com/Get-Started/understanding-events-messaging.md): Understand what events are and how event messaging and message routing work, as an overview before moving on to messaging basics. - [What Is Messaging?](https://docs.solace.com/Get-Started/what-is-messaging.md): Explains the basic participants in messaging (producer, message, messaging system, consumer), the three message types, and the header, properties, and body that make up a message. - [Message Exchange Patterns](https://docs.solace.com/Get-Started/message-exchange-patterns.md): Describes the publish-subscribe, point-to-point, and request-reply message exchange patterns used by messaging applications. - [What Are Event Brokers?](https://docs.solace.com/Get-Started/what-are-event-brokers.md): Explains what an event broker is, the hardware, software, and software-as-a-service (SaaS) forms it can take, and how client applications connect to it. - [Understanding Topics](https://docs.solace.com/Get-Started/what-are-topics.md): Explains how topics classify and route event messages, how to define topic hierarchies and wildcarded subscriptions, and the routing, filtering, access control, and event-handling benefits of a rich topic hierarchy. - [Message Delivery Modes](https://docs.solace.com/Get-Started/message-delivery-modes.md): Compares Direct and Guaranteed messaging, describing their characteristics and how messages are published and received under each mode. - [Topic Endpoints and Queues](https://docs.solace.com/Get-Started/topic-endpoints-queues.md): Compares queues and topic endpoints, the two types of endpoints used to store Guaranteed messages, and introduces durable and non-durable queues and message replay. - [Message VPNs](https://docs.solace.com/Get-Started/message-vpn.md): Explains how Message VPNs segregate topic space and clients on an event broker, including publishing and subscribing across Message VPNs, Message VPN bridges, and connecting to a Message VPN. - [Understanding Event Meshes](https://docs.solace.com/Get-Started/understanding-event-meshes.md): Explains how connecting multiple event brokers into an event mesh lets events be dynamically routed between applications regardless of where they're deployed. - [Dynamic Message Routing](https://docs.solace.com/Get-Started/dynamic-message-routing.md): Explains how Dynamic Message Routing (DMR) automatically forwards messages between event brokers, and describes horizontal scaling within a DMR cluster and multi-site scaling between clusters. - [How Do Micro-Integrations Enable Event-Driven Integration?](https://docs.solace.com/Get-Started/what-are-micro-integrations.md): Explains how Micro-Integrations connect legacy, SaaS, and other external systems to an event broker or event mesh to enable event-driven data exchange. - [Glossary](https://docs.solace.com/Get-Started/glossary.md): Reference glossary of terms used throughout the Solace Platform product and documentation. ## Getting Started & Account Management > Getting Started & Account Management: introductory tutorials for signing up, logging in, and building a first event-driven application in Solace Cloud, plus account administration topics covering user roles and permissions, group management, single sign-on (SSO), audit logs, environments, and the service classes, cloud providers, and regions available when creating event broker services. ### Getting Started with Solace Cloud Tutorials Tutorials describing tasks like how to log in to Solace Cloud, create an event broker service, and exchange both direct and guaranteed (queued) messages between a publisher and subscriber. - [What Is Solace Cloud?](https://docs.solace.com/Cloud/what-is-cloud.md): Introduces Solace Cloud as a software-as-a-service (SaaS) platform for event streaming, event management, and monitoring, and summarizes its component services (Mission Control, Event Portal, Insights). - [Accessing Solace Cloud](https://docs.solace.com/Cloud/ggs_login.md): Tutorial for logging in to the Solace Cloud Console and taking a guided tour of its navigation bar, tools, and account menus. - [Supported Web Browsers](https://docs.solace.com/Cloud/supported-web-browsers.md): Lists the web browsers (Chrome, Firefox, Safari, Edge) supported for using the Solace Cloud Console. - [Creating Your First Event Broker Service](https://docs.solace.com/Cloud/ggs_create_first_service.md): Tutorial for creating an event broker service using Cluster Manager and locating its client connection details. - [Trying Out Your Event Broker Service](https://docs.solace.com/Cloud/ggs_tryme.md): Tutorial for using the Try Me! tool to connect a publisher and subscriber and exchange a direct message over a topic. - [Creating Your First Queue](https://docs.solace.com/Cloud/ggs_queue.md): Tutorial for creating a queue, mapping a topic subscription to it, and publishing a guaranteed message into it. - [Consuming Messages from a Queue](https://docs.solace.com/Cloud/consuming-messages-from-queue.md): Tutorial for consuming guaranteed messages from a queue and understanding how queues retain messages when no consumer is connected. ### Managing Users, Groups, and Access Administration information for Solace Cloud account: assigning user roles and permissions, configuring dynamic group management and single sign-on (SSO) with an OpenID Connect identity provider, and reviewing audit logs of account activity. - [Managing Users, Groups, Roles, and Permissions](https://docs.solace.com/Cloud/cloud-user-management.md): Explains the Solace Cloud role-based access control (RBAC) model, including the available roles and permissions and how user groups can assign roles automatically. - [Configuring User Access](https://docs.solace.com/Cloud/configure-cloud-user-management.md): Procedures for administrators to manually invite, edit, and delete users and assign roles, or manage users through the Solace Cloud REST API. - [Configuring Group Management](https://docs.solace.com/Cloud/cloud-group-management.md): Procedures for creating user groups and mapping identity provider (IdP) claim values to groups so users are automatically assigned roles when they log in through SSO. - [Configuring Single Sign-On with OpenID Connect](https://docs.solace.com/Cloud/cloud-sso.md): Describes the OpenID Connect (OIDC) authentication flow used for single sign-on (SSO) to the Solace Cloud Console and for event broker service management. - [Enabling Single Sign-On for Solace Cloud](https://docs.solace.com/Cloud/selfserve-cloud-sso.md): Procedures for requesting a subdomain and configuring an OIDC-based identity provider, such as Okta, Auth0, PingIdentity, or Microsoft Entra ID, to enable SSO. - [Configuring Your OpenID Connect Identity Provider](https://docs.solace.com/Cloud/setup-claims-with-your-idp.md): Reference for configuring an OIDC application with common identity providers (Microsoft Entra ID, Okta, Auth0, PingIdentity, Amazon Cognito) to support Solace Cloud SSO and claim mapping. - [Using Audit Logs](https://docs.solace.com/Cloud/managing-audit-logs.md): Explains how administrators can view, filter, and download audit logs of user activity in a Solace Cloud account for security and compliance purposes. ### Environments and Private Regions Description of the organization of Solace Cloud resources into environments that represent operational stages, such as development, testing, and production, and managing private regions for customer-controlled deployments. - [Creating and Managing Environments](https://docs.solace.com/Cloud/environments.md): Explains how to create, rename, and set the default environment, and describes environment-specific settings for Event Portal, such as runtime configuration templates and user access. - [Private Regions](https://docs.solace.com/Cloud/private_regions_tab.md): Describes the Private Regions tab used to view and manage datacenters, request new datacenters, and download the Mission Control Agent Helm chart for customer-controlled (private cloud) deployments. ### Choosing Service Classes and Cloud Providers for Event Broker Services Guidance for choosing the service class, cloud provider, and region for a new event broker service based on connection limits, throughput, connectivity requirements, and data-residency needs. - [Choosing Service Classes and Cloud Providers for Event Broker Services](https://docs.solace.com/Cloud/ght_pick_service_type.md): Overview of the factors—connection limits, throughput, message type, cloud provider, and region—to weigh when configuring a new event broker service. - [Service Class Options for Event Broker Services](https://docs.solace.com/Cloud/service-class-limits.md): Reference of the connection, queue, storage, and other system limits for each Solace Cloud service class. - [Choosing the Right Cloud Provider](https://docs.solace.com/Cloud/choose-cloud-provider.md): Compares public cloud regions, Solace-dedicated private clouds, and customer-controlled private clouds—including supported Kubernetes providers—for deploying event broker services. - [Choosing the Right Cloud Region](https://docs.solace.com/Cloud/ght_regions.md): Explains how to select a physical datacenter region for an event broker service based on latency, proximity to client applications, and data-residency requirements. ## Cluster Manager > Creating and managing event broker services in Solace Cloud using Cluster Manager. Covers provisioning, service classes, configuration, authentication, messaging setup, upgrades, and lifecycle operations. ### Getting Started Create event broker services and choose the right service class, cloud provider, and region for your workload. - [Creating and Managing Event Broker Services](https://docs.solace.com/Cloud/Cluster-Manager.md): Overview of Cluster Manager capabilities within Mission Control for managing your event broker services. - [Creating Event Broker Services](https://docs.solace.com/Cloud/create-service.md): Step-by-step guide to provisioning a new event broker service in Solace Cloud. - [Choosing Service Classes and Cloud Providers for Event Broker Services](https://docs.solace.com/Cloud/ght_pick_service_type.md): Guidance on selecting the right service class, cloud provider, and region based on performance needs and compliance requirements. - [Service Class Options for Event Broker Services](https://docs.solace.com/Cloud/service-class-limits.md): Detailed comparison of service class tiers including connection limits, queue counts, message rates, and spool sizes. ### Service Configuration Configure core service settings including hostnames, ports, Message VPN, client profiles, spool sizes, and high availability. - [Configuring Event Broker Services](https://docs.solace.com/Cloud/manage-event-broker-services.md): Overview of configuration options available for event broker services. - [Configuring Custom Hostnames for an Event Broker Service](https://docs.solace.com/Cloud/configure-hostnames.md): Set up custom DNS hostnames for client connections instead of default Solace-provided hostnames. - [Changing the Port Configuration for Event Broker Services](https://docs.solace.com/Cloud/edit-port-configuration.md): Modify listening ports for messaging protocols including SMF, AMQP, MQTT, REST, and WebSocket. - [Viewing and Managing the Message VPN](https://docs.solace.com/Cloud/Broker-Manager/message-vpn-settings.md): Access Message VPN settings including authentication, authorization, and messaging limits. - [Using Client Profiles and Client Usernames](https://docs.solace.com/Cloud/client-profiles.md): Configure client profiles to control connection behavior, resource limits, and permissions for messaging clients. - [Configuring Message Spool Sizes](https://docs.solace.com/Cloud/Configure-Message-Spools.md): Adjust spool allocation for Guaranteed messaging persistence and queue depth. - [High Availability in Solace Cloud](https://docs.solace.com/Cloud/ha_concept.md): Understand HA redundancy groups, active-standby failover, and availability guarantees for event broker services. - [High Availability Switchover for Event Broker Services](https://docs.solace.com/Cloud/ha-switchover.md): Trigger manual HA switchover between active and backup nodes for maintenance or testing. - [Forwarding Logs to an External System](https://docs.solace.com/Cloud/cloud-syslog-forwarding.md): Configure syslog forwarding to send system, command, and event logs to external SIEM or monitoring platforms. - [Enabling the Solace Event Broker CLI for Event Broker Services](https://docs.solace.com/Cloud/enable-cli-for-cloud.md): Enable CLI access for advanced configuration and troubleshooting via SSH. - [Configuring Custom Domain Names for Event Broker Services](https://docs.solace.com/Cloud/configure-domain-name.md): Set up a custom domain for your organization so event broker services use your company's domain instead of the default Solace-provided domain. ### Access and Authentication Configure user access, client authentication, OAuth, SSO, and certificate-based security for your event broker services. - [Managing Access and Authentication](https://docs.solace.com/Cloud/access-and-auth-event-broker-services.md): Overview of authentication and authorization options for both management and messaging access. - [Configuring User Access to Event Broker Services](https://docs.solace.com/Cloud/mission-control-rbac.md): Assign roles and permissions to control who can view, configure, or manage event broker services. - [Selecting the Right Credentials to Access Event Broker Services](https://docs.solace.com/Cloud/ght_select_correct_username_pw.md): Understand when to use admin credentials, client usernames, or OAuth tokens for different access scenarios. - [Rotating Event Broker Service Passwords](https://docs.solace.com/Cloud/rotate-password.md): Rotate admin and client credentials without service interruption. - [Configuring Authentication for Messaging Clients](https://docs.solace.com/Cloud/auth-client.md): Set up authentication methods for messaging clients including basic auth, client certificates, and OAuth. - [Managing Client Access with ACL Profiles](https://docs.solace.com/Cloud/Broker-Manager/acl-profiles-cloud.md): Control client publish and subscribe permissions using Access Control List profiles. - [Configuring Single Sign-On for Event Broker Services](https://docs.solace.com/Cloud/configure-oauth-for-broker-services.md): Enable SSO for management access using OAuth 2.0 identity providers. - [Configuring an Event Broker Service to Use OAuth Identity Provider Authorization](https://docs.solace.com/Cloud/enable_oauth_for_broker.md): Configure OAuth-based authorization for messaging clients using JWT tokens. - [Managing Domain and Client Certificate Authorities](https://docs.solace.com/Cloud/server_certs.md): Upload and manage CA certificates for TLS and client certificate authentication. - [Configuring an Event Broker Service to use Client Certificate Authentication](https://docs.solace.com/Cloud/ght_client_certs.md): Enable mutual TLS authentication where clients present certificates to connect. - [Configuring User Authentication to Event Broker Services](https://docs.solace.com/Cloud/ght_authentication.md): Configure authentication for both messaging clients and management access to event broker services. - [Configuring OAuth Profiles for Management Access to Event Broker Services](https://docs.solace.com/Cloud/enable-oauth-profiles-on-service.md): Set up OAuth profiles to control management access to event broker services using identity provider tokens. - [Managing Custom TLS Server Certificates for an Event Broker Service](https://docs.solace.com/Cloud/selfserve-server-certs.md): Upload and manage your own TLS server certificates for event broker services instead of using Solace-provided certificates. ### Messaging Configuration Configure queues, topic endpoints, bridges, Kafka integration, REST delivery, and distributed tracing. - [Configuring and Managing Messaging](https://docs.solace.com/Cloud/configure-messaging.md): Overview of messaging configuration options in Broker Manager. - [Configuring Queues](https://docs.solace.com/Cloud/Broker-Manager/configuring-queues-broker-manager.md): Create and configure queues for Guaranteed messaging with settings for persistence, access type, and quotas. - [Configuring Partitioned Queues](https://docs.solace.com/Cloud/Broker-Manager/configuring-partitioned-queues.md): Set up partitioned queues for ordered, parallel message processing across multiple consumers. - [Configuring Dead Message Queues](https://docs.solace.com/Cloud/Broker-Manager/configuring-dmqs-broker-manager.md): Configure dead message queues (DMQs) to capture messages that cannot be delivered or exceed TTL limits. - [Configuring Topic Endpoints](https://docs.solace.com/Cloud/Broker-Manager/configuring-topic-endpoints.md): Create topic endpoints for durable subscriptions to guaranteed messages on specific topics. - [Creating REST Delivery Points](https://docs.solace.com/Cloud/Broker-Manager/config-rdps-cloud.md): Configure REST delivery points to forward messages from queues to HTTP endpoints. - [Configuring and Using Message Replay](https://docs.solace.com/Cloud/Broker-Manager/message-replay-cloud.md): Enable and use message replay to re-deliver historical messages from a replay log. - [Creating a Message VPN Bridge](https://docs.solace.com/Cloud/Broker-Manager/vpn-bridge-ctc.md): Connect event broker services across regions or environments using Message VPN bridges. - [Configuring Kafka Bridging](https://docs.solace.com/Cloud/Broker-Manager/config-kafka-bridge.md): Set up bidirectional message bridging between Solace and Apache Kafka clusters. - [Enabling Distributed Tracing](https://docs.solace.com/Cloud/enable-dt-for-cloud.md): Enable OpenTelemetry-based distributed tracing to track messages across your event mesh. - [Viewing Client Configuration Information](https://docs.solace.com/Cloud/Broker-Manager/Viewing-Client-Config-Info.md): View details about connected client applications including connection state, subscriptions, and resource usage. ### Operations and Maintenance Upgrade, scale, back up, and maintain your event broker services. Includes disaster recovery and version management. - [Updating and Maintaining Your Event Broker Services](https://docs.solace.com/Cloud/cloud-versions-upgrades-upscaling.md): Overview of maintenance operations including upgrades, scaling, and version management. - [Version Adoption in Solace Cloud](https://docs.solace.com/Cloud/understand-event-broker-releases.md): Understand how Solace Cloud adopts new software event broker versions and the upgrade timeline. - [Software Event Broker Versions and Support in Solace Cloud](https://docs.solace.com/Cloud/cloud-event-broker-releases.md): Current and supported software versions available for event broker services. - [Upgrading Event Broker Services in Solace Cloud](https://docs.solace.com/Cloud/upgrade-event-broker.md): How to upgrade event broker services to newer software versions. - [Self-Serve Event Broker Service Upgrades in Solace Cloud](https://docs.solace.com/Cloud/SelfServeUpgrades/selfserve-broker-upgrade.md): Perform upgrades on your schedule using the Cloud Console or REST API. - [Event Broker Service Maintenance Validation Checks](https://docs.solace.com/Cloud/SelfServeUpgrades/ssupgrade-validation-checks.md): Pre-upgrade validation checks that ensure service readiness and identify potential issues. - [Upscaling Event Broker Services](https://docs.solace.com/Cloud/scaling_services.md): Increase service class tier to handle higher connection counts, message rates, or spool requirements. - [Backing up Event Broker Services](https://docs.solace.com/Cloud/backup-brokers-messaging.md): Export configuration for disaster recovery and environment migration. - [Using Replication for Disaster Recovery of Event Broker Services](https://docs.solace.com/Cloud/DR-Replication/cloud-dr-lp.md): Configure cross-region replication for business continuity and disaster recovery. ### Service Lifecycle Clone and delete event broker services, with deletion protection to prevent accidental removal. - [Cloning an Event Broker Service](https://docs.solace.com/Cloud/cloud-clone-service.md): Create a copy of an existing event broker service with the same configuration for testing or migration. - [Deleting Event Broker Services](https://docs.solace.com/Cloud/delete_service.md): Permanently remove an event broker service and release associated resources. - [Using Deletion Protection](https://docs.solace.com/Cloud/ght_service_deletion_protection.md): Enable deletion protection to prevent accidental removal of critical event broker services. ## Mesh Manager > Building and managing event meshes visually with Mesh Manager — creating, viewing, health-checking, modifying, and deleting event meshes. The event meshes are created using Dynamic Message Routing (DMR). The event meshes created using Mesh Manager use external DMR links only. This means that each DMR node, is it's onwn DMR cluster. #### Understanding and Creating an Event Mesh in Solace > Event Meshes in Solace Cloud can be created using Mesh Manager. It allows you do this in the Cloud Console rather than issuing Solace Event Broker CLI commands. - [Understanding Event Meshes and Mesh Manager](https://docs.solace.com/Cloud/Event-Mesh/about_event_meshes.htm): An event mesh is a configurable and dynamic infrastructure layer for distributing events among decoupled applications, cloud services, and devices. This topic explains how event meshes work, key DMR concepts, and the considerations you need to know before creating one. - [Creating an Event Mesh](https://docs.solace.com/Cloud/Event-Mesh/ght_event_mesh.md): Step-by-step instructions for creating an event mesh in Mesh Manager by connecting two or more Enterprise event broker services into a full DMR mesh. ### Managing Event Meshes in Cloud How to view, modify, and remove event meshes in Solace Cloud. - [Viewing Event Mesh Details](https://docs.solace.com/Cloud/Event-Mesh/view_mesh_information.md): View the status, health check results, link details, and event broker service information for an event mesh in Mesh Manager. Also covers how to discover manually configured meshes and refresh the mesh view. - [Running Event Mesh Health Checks](https://docs.solace.com/Cloud/Event-Mesh/run_health_check.md): An event mesh health check validates that events can be exchanged between all nodes in a mesh by pinging each link and checking topic propagation. This topic also covers how to handle failed health checks and troubleshoot link issues. - [Modifying an Event Mesh](https://docs.solace.com/Cloud/Event-Mesh/modify_mesh.md): Add or remove event broker services from an existing event mesh, switch the DMR link initiator, or rename the event mesh. Requires the Mission Control Manager role. - [Deleting an Event Mesh](https://docs.solace.com/Cloud/Event-Mesh/deleting_mesh.md): Deleting an event mesh removes the connectivity (or links) between each event broker service. ## Developing with Solace Cloud using the Cloud REST APIs > Developing using the Solace Cloud v2 REST APIs. Includes information about how to authenticate with API tokens, handle versioning, pagination, filtering, error handling, and SEMP objects. Also includes step-by-step recipes for building applications that provision and use event broker services. You can also also use the REST APIs to create event portal objects, manage Mirco-Integrations, manage audit logs, and manage users. ### Understanding Solace Cloud v2 REST APIs Reference for the Solace Cloud v2 REST APIs: getting started, authentication, versioning, pagination, filtering, error handling, and SEMP objects. - [Using the Solace Cloud REST APIs](https://api.solace.dev/cloud/reference/using-the-v2-rest-apis-for-pubsub-cloud.md): Getting started with the Solace Cloud v2 REST APIs — base URLs, request structure, and how to make calls. - [Authentication](https://api.solace.dev/cloud/reference/authentication): Information about using API tokens is also available in the Solace Cloud v2 REST API documentation. - [Versioning](https://api.solace.dev/cloud/reference/versioning.md): How the Solace Cloud v2 REST APIs are versioned and how to target a specific API version. - [Pagination](https://api.solace.dev/cloud/reference/pagination.md): Paging through large REST API result sets using page/cursor parameters. - [Filtering](https://api.solace.dev/cloud/reference/filtering.md): Filtering and querying REST API collections to narrow the results returned. - [Error Handling](https://api.solace.dev/cloud/reference/error-handling.md): REST API error responses — HTTP status codes and the error payload structure. - [SEMP Objects](https://api.solace.dev/cloud/reference/objects.md): Working with SEMP objects through the REST APIs to configure event broker services. ### Sample Code of Using the APIs Step-by-step descriptions of how to use the Solace Cloud v2 REST APIs. There are more tutorials but the ones listed here are most comprehensive. - [Create an Event Broker Service](https://api.solace.dev/cloud/recipes/create-an-event-broker-service.md): Step-by-step recipe to create an event broker service via the Solace Cloud v2 REST APIs. - [Create and deploy a Micro-Integration](https://api.solace.dev/cloud/recipes/create-and-deploy-a-micro-integration.md): Step-by-step recipe to create and deploy a Micro-Integration via the Solace Cloud v2 REST APIs. - [Managing Audit Logs with the Solace Cloud REST API](https://docs.solace.com/Cloud/ght_use_rest_api_audit_logs.md): Step-by-step to use retrieve the audit logs from an event broker service in Solace Cloud. ## Deploying Solace Cloud > Deployment options and networking for Solace Cloud: ownership models, connectivity requirements, cloud providers and regions, and deploying and operating Solace Cloud on Kubernetes. - [Components of Solace Cloud](https://docs.solace.com/Cloud/Deployment-Considerations/ps-cloud-overview.md): Diagrams and describes the components of Solace Cloud, including Mission Control, event broker services, and the Mission Control Agent used for private and customer-controlled deployments. ### Deployment Options for Solace Cloud Choosing an ownership model, connectivity approach, and region for deploying Solace Cloud, along with the roles and process for each deployment type. - [Deployment Options for Solace Cloud](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-options.md): Explains the ownership, connectivity, and region choices to consider when planning a Solace Cloud deployment for an event-driven application. - [Solace Cloud Deployment Ownership Models](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-options-ownership.md): Compares the Public Region, Dedicated Region, and Customer-Controlled Region ownership models and who manages the underlying infrastructure in each. - [Solace Cloud Connectivity Requirements](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-options-connectivity.md): Describes the messaging, management, and operational connectivity that must be configured between Solace Cloud and your network. - [Networking Options for Dedicated Cluster Deployments](https://docs.solace.com/Cloud/Deployment-Considerations/dedicated-networking-options.md): Compares VPC/VNet peering, hub-and-spoke, unidirectional endpoints, and site-to-site VPN options for connecting to a Dedicated Region. - [Static IP Availability for Messaging Connectivity in Public Clusters and Dedicated Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-dedicated-source-target-ips.md): Lists which cloud providers and deployment types support static IP addresses for inbound and outbound event broker connections. - [Using AWS Transit Gateway for EKS Connectivity](https://docs.solace.com/Cloud/Deployment-Considerations/aws_transit_gateway_CA.md): Describes using AWS Transit Gateway to connect a Dedicated Region running on EKS to your VPCs. - [Deployment Regions](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-options-customer-regions.md): Explains how to choose the physical datacenter region for a Solace Cloud deployment. - [Deployment Roles and Responsibilities](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-roles-responsibilities.md): Outlines which deployment tasks Solace performs and which tasks require the customer, for Customer-Controlled Region deployments. - [Process to Deploy Solace Cloud in a Dedicated Cluster](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-process-for-dedicated-overview.md): Outlines the steps and timeline for deploying Solace Cloud to a Dedicated Region. - [Process to Deploy Solace Cloud in a Customer-Controlled Cluster](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-process-overview.md): Outlines the steps, from configuring connectivity to installing the Mission Control Agent, for deploying Solace Cloud to a Customer-Controlled Region. - [Monitoring Traffic for Customer-Controlled Clusters](https://docs.solace.com/Cloud/proxy_agent.md): Explains the outbound connectivity required for event broker monitoring data to reach Solace's centralized monitoring service (Datadog). ### Deploying Solace Cloud with Kubernetes Overview of deploying and architecting Solace Cloud on a customer's Kubernetes cluster, including supported versions and installation prerequisites. - [Deploying Solace Cloud with Kubernetes](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-k8s-overview.md): Overview of the steps to deploy Solace Cloud to a Customer-Controlled Region, from installing the Kubernetes cluster through creating a test event broker service. - [Deployment Architecture for Kubernetes](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-architecture-k8s.md): Describes how the Mission Control Agent and event broker pods are deployed across availability zones in a Kubernetes cluster, including the StatefulSets used for high-availability groups. - [Environment Architecture for Dedicated Cluster and Customer-Controlled Cluster Deployments](https://docs.solace.com/Cloud/Deployment-Considerations/deploying_with_environments.md): Recommends assigning one datacenter per environment, such as development, test, and production, and explains the reliability and compliance benefits of doing so. - [Supported Kubernetes Versions](https://docs.solace.com/Cloud/Deployment-Considerations/cloud-broker-k8s-versions-support.md): Lists the Kubernetes providers and distributions supported for Customer-Controlled Region deployments and their compatible event broker versions. - [Kubernetes Cluster Installation](https://docs.solace.com/Cloud/Deployment-Considerations/installing-ps-cloud-k8s.md): Describes the steps to install a Kubernetes cluster that meets Solace Cloud's version, provider, and resource requirements before deployment. - [Common Kubernetes Prerequisites](https://docs.solace.com/Cloud/Deployment-Considerations/prerequisites-k8s.md): Lists the worker node sizing, dynamic volume provisioning, and networking prerequisites a Kubernetes cluster must meet before deploying Solace Cloud. ### Kubernetes Resource Requirements Compute, memory, storage, and load balancer resources required to run Solace Cloud in a Customer-Controlled Region. - [General Resource Requirements for Kubernetes and Default Port Configuration](https://docs.solace.com/Cloud/Deployment-Considerations/resource-requirements-k8s.md): Overview of the pod types and resource requirements for event broker, monitoring, and Mission Control Agent pods in a Kubernetes cluster. - [Compute Requirements in Customer-Controlled Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-cluster-requirements/compute-reqs.md): Reference tables of CPU requests and limits by service class for standalone and high-availability event broker deployments. - [Memory Requirements in Customer-Controlled Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-cluster-requirements/memory-reqs.md): Reference tables of memory requirements by event broker version and service class, including the additional memory needed for Message Retain. - [Storage Requirements in Customer-Controlled Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-cluster-requirements/storage-reqs.md): Reference tables of ephemeral and persistent storage requirements by service class for event broker pods. - [Load Balancer Rules per Service (Default Protocols and Port Configuration)](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-cluster-requirements/LB-config.md): Reference for the default protocols and ports that load balancer rules must expose for each event broker service. - [Resource Requirements for Kubernetes for On-Premises Deployments in Customer-Controlled Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/resource-requirements-on-prem.md): Describes the additional storage and volume performance requirements for on-premises Kubernetes deployments. - [Resource Requirements for Additional Solace Service Deployments](https://docs.solace.com/Cloud/Deployment-Considerations/resource-reqs-k8s-add-ons.md): Lists the CPU and memory requirements for the add-on pods deployed alongside event brokers for Distributed Tracing, Managed Micro-Integrations, and Event Portal Connections. ### Kubernetes Networking and Connectivity Configuring node scheduling, proxies, and load balancing to connect Kubernetes-based event broker services to your network. - [Support for nodeSelector, Labels, Taints, and Tolerations](https://docs.solace.com/Cloud/Deployment-Considerations/k8s_labels_taints.md): Explains how to use Kubernetes scheduling constraints to control which nodes host the Mission Control Agent and event broker pods. - [Connectivity Model for Kubernetes Deployments](https://docs.solace.com/Cloud/Deployment-Considerations/connectivity-model-k8s.md): Describes the operational, management, and messaging connectivity required between a Kubernetes cluster and Solace Cloud, including the hosts and ports to allow. - [Using Proxies](https://docs.solace.com/Cloud/Deployment-Considerations/k8s-using-proxyservers.md): Describes configuring HTTP, HTTPS, and SOCKS5 proxies for Solace Cloud connectivity, including limitations for Mission Control Agent traffic. - [Exposing Event Broker Services to External Traffic](https://docs.solace.com/Cloud/Deployment-Considerations/deployment-exposecluster-k8s.md): Compares using an integrated load balancer versus NodePort to expose event broker services outside a Kubernetes cluster. - [Using an Integrated Load Balancer Solution](https://docs.solace.com/Cloud/Deployment-Considerations/k8s-using-loadbalancer.md): Describes exposing event broker services with a Kubernetes LoadBalancer service, including the recommended externalTrafficPolicy setting. - [Using NodePort](https://docs.solace.com/Cloud/Deployment-Considerations/k8s-using-nodeport.md): Describes exposing event broker services with a Kubernetes NodePort service fronted by a manually provisioned external load balancer. - [Using NAT with Static IP Addresses for Outbound Connections for Kubernetes-Based Deployments](https://docs.solace.com/Cloud/Deployment-Considerations/k8s-connectivity-outbound.md): Recommends configuring a NAT with a static IP address so outbound event broker connections use a consistent, allow-listable source IP. ### Installing the Mission Control Agent in Kubernetes Validating a Kubernetes cluster and installing the Mission Control Agent that manages event broker services within it. - [Kubernetes Cluster Validation](https://docs.solace.com/Cloud/Deployment-Considerations/installing-ps-cloud-k8s-validate.md): Describes the validation tool Solace runs with the customer to confirm a Kubernetes cluster is ready for deployment. - [Mission Control Agent Installation](https://docs.solace.com/Cloud/Deployment-Considerations/installing-agent.md): Overview of the steps to install the Mission Control Agent with Solace after a Kubernetes cluster has been validated. - [Installing the Mission Control Agent](https://docs.solace.com/Cloud/Deployment-Considerations/installing-ps-cloud-k8s-install-mca.md): Describes the Helm chart commands used to install the Mission Control Agent into a validated Kubernetes cluster. - [Service Accounts in Kubernetes](https://docs.solace.com/Cloud/Deployment-Considerations/service-accounts-k8s.md): Describes the service accounts and permissions the Mission Control Agent's Helm chart automatically creates for the agent and event broker pods. ### Kubernetes Upgrades in Solace Cloud Keeping the Mission Control Agent and Kubernetes cluster version up to date. - [Upgrading the Mission Control Agent in Kubernetes](https://docs.solace.com/Cloud/Deployment-Considerations/upgrading_cloud_agent_kubernetes.md): Describes the Helm commands used to upgrade the Mission Control Agent when it isn't self-upgrading. - [Kubernetes Upgrades in Solace Cloud](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-adoption-policy.md): Explains Solace's policy for validating, adopting, and deprecating support for Kubernetes versions, and the upgrade notifications and responsibilities for each region type. - [Viewing and Scheduling Kubernetes Version Upgrades in Dedicated Clusters](https://docs.solace.com/Cloud/Deployment-Considerations/K8s-Cluster-Upgrades/k8s-cluster-upgrades.md): Describes using the Private Regions tab of the Console to view Kubernetes version support dates and schedule, reschedule, or cancel a cluster upgrade. ## Security in Solace Cloud > Security in Solace Cloud: security architecture and ownership/deployment models, customer roles and responsibilities, VPC/VNet isolation, component-level security (Cloud Console, Mission Control / Event Management / Insights agents, Broker Manager, event broker services), authentication and authorization (OpenID Connect SSO, API tokens), client connectivity and authorization, data encryption, audit and system logs, and industry-standard compliance. - [Security in Solace Cloud](https://docs.solace.com/Cloud/Security/cloud-security-overview.md): Solace Cloud is secure by default. ### Security Architecture for Solace Cloud The general architecture of Solace Cloud and how security is handled. - [Security Architecture for Solace Cloud](https://docs.solace.com/Cloud/Security/security-architecture.md): How deployment choices — ownership model and connectivity — shape the security architecture and where event brokers reside. - [VPC/VNet Isolation](https://docs.solace.com/Cloud/Security/vpc-isolation.md): Deploying event broker services in an isolated Kubernetes VPC/VNet to separate brokers from client applications for added security. - [Solace Home Cloud Security](https://docs.solace.com/Cloud/Security/security-home-cloud.md): The Home Cloud control-plane microservices — Mission Control, Event Portal, Insights — fronted by the Solace Cloud Console. - [Solace Cloud Console Security](https://docs.solace.com/Cloud/Security/cloud-console-security.md): Security of the single-pane Cloud Console UI for managing services, event meshes, Insights monitoring, and Event Portal. - [Mission Control Agent Security](https://docs.solace.com/Cloud/Security/mission-control-agent-security.md): The Mission Control Agent is required to deploy and manage Solace Event Broker Services. - [Broker Manager Security](https://docs.solace.com/Cloud/Security/security-broker-manager.md): Broker Manager is a browser-based administration console used with an event broker. - [Event Broker Service Security](https://docs.solace.com/Cloud/Security/event-broker-security.md): Event broker services are created to be secure. - [Authentication and Authorization to Solace Cloud](https://docs.solace.com/Cloud/Security/authentication_authorization_cloud.md): User and application access via roles, OpenID Connect single sign-on (SSO), and API tokens. - [Data Protection in Solace Cloud](https://docs.solace.com/Cloud/Security/cloud-security-encryption.md): Management, monitoring, and messaging data flow through Solace Cloud. - [Central Monitoring Service and Insights Agents](https://docs.solace.com/Cloud/Security/security-centralized-monitoring-service.md): How Insights Agents send system-level metrics and logs to the central monitoring service; no personally-identifiable data collected. ### Client Application Connectivity and Security Security operations and operations for client connectivity. Includes how operations and management of Solace Cloud. - [Client Application Connectivity and Security](https://docs.solace.com/Cloud/Security/security-client-connectivity.md): How messaging and management client applications connect to event broker services, including protocols and ports. - [Client Authorization for Messaging Access](https://docs.solace.com/Cloud/Security/client-authorization-cloud.md): Authorizing clients after authentication using client usernames, ACL profiles, and client profiles for messaging access. - [Using Audit Logs and System Logs](https://docs.solace.com/Cloud/Security/security-audit.md): Audit logs and per-service system logs, SysLog forwarding, and Insights monitoring for tracking security events. - [Connection Details for Deployment](https://docs.solace.com/Cloud/Security/summary_of_connections.md): Operational connectivity reference — ports and access points required for Kubernetes deployments (AKS, GKE, EKS). - [Additional Steps and Best Practices for Security](https://docs.solace.com/Cloud/Security/security-considerations-all.md): Extra customer-managed hardening for Customer-Controlled Clusters — OS patching, access hardening, and best practices. ## Software Event Brokers > Deploying and Maintaining Solace Software Event Brokers: the software event broker delivered as a container image, runnable on on-premises servers, cloud environments, Kubernetes clusters, and virtual machines. Covers editions and packaging, getting-started test deployments, container requirements and production deployment, container configuration, operation, and software upgrades. - [Solace Software Event Brokers](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Setting-Up-SW-Brokers.md): Compares the Standard and Enterprise editions of the software event broker and links the setup steps. - [Packaging of the Software Event Broker](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Release-Packages.md): Explains software event broker image packaging, tarball format, and supported Docker, Podman, and CRI-O runtime versions. ### Getting Started Quick-start examples for standing up a software event broker container for testing, proofs of concept, and developer environments (not for production). - [Deployment Quick Starts](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/QuickStarts.md): Open-source deployment quick-start templates (Kubernetes operator/Helm, OpenShift, GKE, AWS, Azure, GCP) for self-managed software event brokers. - [Docker Desktop for Mac](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Docker-Container-macOS.md): How to run a single-node software event broker container with Docker Compose on macOS using Docker Desktop. - [Docker Desktop for Windows](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Docker-Container-Windows.md): How to run a single-node software event broker container with Docker Compose on Windows using Docker Desktop. - [Docker for Linux](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Docker-Container-Linux.md): How to pull, load, and run a single-node software event broker Docker container in a non-cloud Linux environment. - [Docker with Amazon Linux on AWS](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Docker-Container-AMI-EC2.md): How to launch an Amazon Linux instance on AWS EC2, install Docker, and run a single-node software event broker container. - [Rootful Podman with RHEL8 on AWS](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Podman-Container-RHEL-EC2.md): How to launch a RHEL 8 host on AWS EC2 and run a single-node software event broker container with rootful Podman. - [Rootless Podman for Ubuntu](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Podman-Container-Ubuntu.md): How to run a single-node software event broker container with rootless Podman on non-cloud Ubuntu, including UID mapping and systemd. ### Software Event Broker Container Requirements What to provision and plan before deploying a container, including system resources, storage, core files, and networking, culminating in production deployment. - [System Resource Requirements](https://docs.solace.com/Software-Broker/System-Resource-Requirements.md): Minimum CPU, memory, shared-memory, and storage-element requirements and open-file limits for software event broker container deployments. - [Managing Software Event Broker Storage](https://docs.solace.com/Software-Broker/Configuring-Storage.md): Explains the storage-group construct and its six storage-elements (jail, var, diagnostics, spool, spool-cache, spool-cache-backup) and their mount points. - [Managing Storage for Container Images](https://docs.solace.com/Software-Broker/Container-Tasks/Config-Container-Storage.md): How to persist a container's storage-group using volumes or bind mounts, with Docker and Podman examples for Linux, Windows, and Mac. - [Managing Core Files](https://docs.solace.com/Software-Broker/Managing-Core-Files.md): How to configure core-file resource limits and kernel behavior for reliable diagnostic capture in software event broker containers. - [Container Networking](https://docs.solace.com/Software-Broker/Container-Tasks/Config-Container-Networking.md): Describes supported rootful and rootless container networking modes (bridge, host, slirp4netns), port mapping, and HA considerations. - [Deploying Solace Software Event Brokers in a Production Environment](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Deploying-Container-in-Production.md): How to deploy highly available software event broker containers in production VMs, covering resources, storage, networking, and systemd. ### Configuring Software Event Broker Containers Configuring a software event broker container, covering initialization, users, secrets, logging, timezone, and scaling parameters. - [Initializing a Software Event Broker Container](https://docs.solace.com/Software-Broker/Container-Tasks/Config-SW-Broker-Container-Cfg-Keys.md): How to initialize a software event broker container by passing configuration keys and environment variables to docker/podman create. - [Configuring the Solace Event Broker CLI for Software Event Broker Containers](https://docs.solace.com/Software-Broker/Container-Tasks/Config-CLI-Users-for-Software-Brokers.md): How to configure Solace CLI management users for a software event broker container via the CLI, SEMP, or configuration keys. - [Configuring Container Users](https://docs.solace.com/Software-Broker/Container-Tasks/Config-Arbitrary-User.md): How to run a software event broker container as a non-zero UID, with Linux capabilities, ulimits, privileged ports, and volume ownership. - [Rootless Containers](https://docs.solace.com/Software-Broker/Container-Tasks/rootless-containers.md): Explains rootless container concepts for software event brokers, such as user namespaces and UID/GID mapping. - [Configuring Secrets](https://docs.solace.com/Software-Broker/Container-Tasks/Config-Secrets.md): How to create a host secrets directory for certificates and passwords and mount it into a software event broker container using configuration keys. - [Configuring Container Logging](https://docs.solace.com/Software-Broker/Container-Tasks/Configuring-VMR-Container-Logging.md): How to configure container logging destinations and formats and forward software event broker log streams to external aggregators. - [Setting the Timezone](https://docs.solace.com/Software-Broker/Timezone.md): How to set a software event broker container's timezone with the TZ environment variable and verify it using the show clock CLI command. - [Using System Scaling Parameters](https://docs.solace.com/Software-Broker/System-Scaling-Parameters.md): Reference for system scaling parameters (max connections, queue messages, subscriptions, bridges, Kafka, message size) and their per-edition limits. - [Setting Scaling Parameters Using Configuration Keys](https://docs.solace.com/Software-Broker/Config-Key-Scaling-Params.md): How to set scaling parameters at container creation using configuration keys such as system_scaling_maxconnectioncount. ### Configuration Reference Reference for the default configuration and the full set of container configuration keys. - [Default Configuration for Software Event Brokers on Virtual Machines](https://docs.solace.com/Software-Broker/SW-Broker-Configuration-Defaults.md): The default configuration for software event brokers including message spool, default Message VPN, enabled services, and default port numbers. - [Configuration Keys](https://docs.solace.com/Software-Broker/Configuration-Keys-Reference.md): Comprehensive reference of container configuration keys covering logging, Message VPN services, redundancy, TLS, scaling, and usernames. ### Operating and Monitoring Software Event Brokers Accessing a running software event broker, scaling up an HA group, and gathering diagnostics for troubleshooting. - [Accessing the Solace Event Broker CLI](https://docs.solace.com/Software-Broker/Access-Solace-CLI.md): How to access the Solace CLI to configure and manage a software event broker, via SSH to port 2222 or the container runtime. - [Accessing the Container Shell](https://docs.solace.com/Software-Broker/Access-Solace-App-Shell.md): How to access the software event broker container's Linux shell using docker exec. - [Scaling Up an Existing HA Group](https://docs.solace.com/Software-Broker/Set-Scaling-Params-HA.md): How to increase scaling parameters on both software event brokers in an HA group, with redundancy checks. - [Gathering Diagnostics from Software Event Broker Containers](https://docs.solace.com/Software-Broker/Container-Tasks/Gath-SW-Broker-Container-Rtr-Diagnostics.md): How to gather encrypted diagnostic files and debug logs from a software event broker container using gather-diagnostics-host or the CLI gather-diagnostics command. - [Transferring Diagnostic Logs from the Software Event Broker](https://docs.solace.com/Software-Broker/Container-Tasks/transferring-diagnostic-logs-software.md): How to transfer diagnostic logs off a software event broker container with SFTP/SCP tools or the copy command. ### Upgrading Software Event Brokers Upgrading standalone and HA software event brokers to supported versions. - [Upgrade Procedures](https://docs.solace.com/Software-Broker/SW-Broker-Upgrade/SW-Broker-Upgrade.md): Describes upgrade prerequisites, free-space checks, and how to select standalone or redundant upgrade procedures. - [Docker Upgrade](https://docs.solace.com/Software-Broker/SW-Broker-Upgrade/Docker-Upgrade-Current-Release.md): Step-by-step upgrade procedures for standalone, HA-group, and orchestrated deployments. ## Appliance Event Brokers > Deploying and Maintaining Solace Appliance Event Brokers: procedures covering 3530 and 3560 appliance event broker hardware installation and cabling, initial CLI setup and basic messaging configuration, software upgrades, hardware-component replacement, powering and restarting, chassis replacement and migration, diagnostics, and health checks. - [Appliance Event Broker Models](https://docs.solace.com/Appliance/Appliance-Set-Up/appliance-models.md): Overview of the 3530 and 3560 appliance event broker models. ### Setting Up Appliance Event Brokers Installing, cabling, and initializing 3530 and 3560 appliance event brokers, from hardware installation through basic messaging configuration. #### Setting Up Solace 3530 Appliance Event Brokers > Site prep, cabling specs, and connections/LEDs reference for 3530 appliance event brokers. - [Before Installing](https://docs.solace.com/Appliance/3530-Hardware-Installation/Before-Installing-3530.md): Pre-installation requirements for 3530 appliance event brokers including safety, environmental and IP requirements, cabling recommendations, and four-post 19-inch rack requirements. - [Management Interface Port Specifications](https://docs.solace.com/Appliance/3530-Hardware-Installation/Mgt-Int-Port-Specs.md): Management interface port specifications (eth1/eth2 RJ-45 Auto-MDIX, CAT-5e) and supported bandwidths for 3530 appliance event brokers. - [NAB Port and Cable Specifications](https://docs.solace.com/Appliance/3530-Hardware-Installation/NAB-Port-Cabling-3530.md): Ethernet port and CAT-5e cabling specifications, faceplate LEDs, and slot placement for the Network Acceleration Blades (NAB) in 3530 appliance event brokers. - [ADB and HBA Port and Cable Specifications](https://docs.solace.com/Appliance/3530-Hardware-Installation/ADB-and-HBA-Cabling.md): Optical port and cabling specifications, faceplate LEDs, and deployment examples for the Assured Delivery Blade (ADB) and Host Bus Adapter (HBA) in 3530 appliance event brokers. - [External Disk Storage Array Requirements](https://docs.solace.com/Appliance/3530-Hardware-Installation/External-Disk-Arrays.md): External disk storage array requirements (RAID, LUN size, sector size, Fibre Channel, WWN) for a 3530 appliance event broker using an ADB and HBA. - [Connections, LEDs, and Specifications](https://docs.solace.com/Appliance/3530-Hardware-Installation/Connections-LEDs-Specs.md): Reference for 3530 appliance event brokers including front/rear panel connections, PCIe blade slot assignments, LED status indicators, and specifications. #### Setting Up Solace 3560 Appliance Event Brokers > Site prep, cabling specs, and connections/LEDs reference for 3560 appliance event brokers. - [Before Installing](https://docs.solace.com/Appliance/3560-Hardware-Installation/Before-Installing-3560.md): Pre-installation checklist for 3560 appliance event brokers including safety, environmental requirements, cabling recommendations, and four-post 19-inch rack requirements. - [Management Interface Port Specifications](https://docs.solace.com/Appliance/3560-Hardware-Installation/Management-Interface-Por.md): Management interface port specifications for 3560 appliance event brokers. - [NAB Port and Cabling Specifications](https://docs.solace.com/Appliance/3560-Hardware-Installation/NAB-Cabling.md): Port and cabling specifications for Network Acceleration Blades (NAB) in 3560 appliance event brokers, covering SFP+ 10GigE fiber and Twinax connections. - [ADB and HBA Port and Cabling Specifications](https://docs.solace.com/Appliance/3560-Hardware-Installation/ADB-and-HBA-Specs-and-Cabling.md): Optical port and cabling specifications for Assured Delivery Blade (ADB) and Host Bus Adapter (HBA) in 3560 appliance event brokers, including SFP modules and Fibre Channel deployments. - [External Disk Storage Array Requirements](https://docs.solace.com/Appliance/3560-Hardware-Installation/External-Disk-Storage-Ar.md): External disk storage array requirements (RAID, LUN size, sector size, Fibre Channel, WWN) for a 3560 appliance event broker using an ADB and HBA. - [Connections, LEDs, and Specifications](https://docs.solace.com/Appliance/3560-Hardware-Installation/Connections-LEDs-Specs.md): Reference for 3560 appliance event brokers: front/rear panel views, slot/blade configurations, LED behavior, and technical specifications. ### Initializing Appliance Event Brokers Connecting a management console and performing initial CLI setup and basic messaging configuration on an installed appliance event broker. - [Connecting a Management Console](https://docs.solace.com/Appliance/Appliance-Set-Up/Connecting-M-Consoles.md): How to set up and cable a serial management console to configure an appliance event broker via the CLI without an IP address. - [Initial Setup](https://docs.solace.com/Appliance/Appliance-Set-Up/Initializing-Appliances.md): Initial CLI setup of an installed appliance event broker including admin login and configuring hostname, IP interfaces, gateway, time zone, NTP, DNS, and product keys. - [Setting Basic Configurations](https://docs.solace.com/Appliance/Appliance-Set-Up/Setting-Basic-Configurations.md): How to configure a powered-up appliance event broker for basic messaging. ### Upgrading Appliance Event Brokers Upgrading standalone and redundant appliance event brokers to supported software versions. - [Upgrade Procedures](https://docs.solace.com/Appliance/Appliance-Upgrade/Appliance-Upgrade.md): How to select the correct upgrade procedure based on standalone/redundant configuration and whether Guaranteed Messaging is used. - [Standalone Appliance Event Broker](https://docs.solace.com/Appliance/Appliance-Upgrade/Upgrade-Standalone-Appliance.md): Step-by-step procedures for upgrading a standalone appliance event broker to a supported software version, with and without Guaranteed Messaging. - [Redundant Appliance Event Brokers](https://docs.solace.com/Appliance/Appliance-Upgrade/Upgrade-Redundant-Appliances.md): Step-by-step procedures for upgrading redundant appliance event brokers to a supported software version, with and without Guaranteed Messaging. ### Maintaining Appliance Event Brokers Servicing, operating, and maintaining deployed 3530/3560 appliance event brokers. #### Replacing Hardware Components > Replacing field-replaceable components (blades, disk drives, fans, power supplies) in 3530/3560 appliance event brokers. - [Blade Replacement in Solace 3560s and Solace 3530s](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Physically-Replacing-Bla-1.md): How to physically replace NAB, ADB, and HBA blades in CHS-3530AC, CHS-3560AC-05, and CHS-3560AC-06 appliance event brokers using the blade carrier and Blade Removal Tool. - [Blade Replacement in 3560AC-08 Appliance Event Brokers](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Physically-Replacing-Blades-in-3560AC-08s.md): How to physically replace ADB, HBA, and NAB blade cartridges in the CHS-3560AC-08 appliance event broker. - [ADB Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-ADBs.md): How to replace Assured Delivery Blades (ADBs) in standalone and redundant-pair appliance event brokers while preserving spooled messages. - [HBA Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-HBAs.md): How to replace Host Bus Adapters (HBAs) in standalone and redundant appliance event brokers. - [HBA Replacement in Solace 3560s](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Physically-Replacing-HBAs-in-3560s.md): How to physically remove and install HBA blades in 3560 appliance event brokers. - [NAB Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-NABs.md): How to replace a Network Acceleration Blade (NAB) with a model having fewer Ethernet ports in 3560 appliance event brokers, including the required CLI reconfiguration. - [Disk Drive Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-Disk-Drives.md): How to hot-swap a failed disk drive in 3530/3560 appliance event brokers and rebuild it with RAID redundancy. - [Fan Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-Fans.md): How to replace one of the four 60mm cooling fans in a 3530/3560 appliance event broker. - [Power Supply Replacement](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-Power-Supplies.md): How to hot-swap an AC power supply in 3530/3560 appliance event brokers without powering down. #### Powering and Restarting Appliance Event Brokers > Powering appliance event brokers up or down, restarting, and safely shutting down redundant Guaranteed Messaging pairs. - [On / Standby Button](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Turning-Appliance-Power.md): The physical on/standby button on the rear panel of 3530/3560 appliance event brokers, and how to power on and off with it. - [Powering an Appliance Event Broker Up or Down](https://docs.solace.com/Appliance/Turn-Off-Power.md): How to power an appliance event broker up or down with the power-down command and on/standby button, including Wake-on-LAN (Magic Packet) remote power-on. - [Restarting Appliance Event Brokers](https://docs.solace.com/Appliance/Restarting-Appliances.md): How to shut down and automatically restart an appliance event broker using the CLI reload command. - [Shutting Down Guaranteed Messaging Redundant Appliance Event Brokers](https://docs.solace.com/Appliance/Shut-Down-Guaranteed-Msging-HA-Appliances.md): Step-by-step CLI procedure to safely shut down and restart a redundant pair of appliance event brokers that use Guaranteed Messaging. #### Changing Software and Configuration > Changing the SolOS software load and low-level settings such as serial baud rate and msg-backbone IPs. - [Changing Appliance Event Broker Software](https://docs.solace.com/Appliance/Changing-Software-Loads.md): How to manage SolOS software loads on appliance event brokers including displaying versions, reloading or downgrading standalone and redundant deployments, and deleting loads. - [Configuring the Baud Rate of the Serial Console Port](https://docs.solace.com/Appliance/Changing-Appliance-Baud-Rates.md): How to configure the serial console port baud rate on 3530/3560 appliance event brokers. - [Changing Msg-Backbone IPs for Replicated Appliance Event Brokers](https://docs.solace.com/Appliance/Changing-MSG-Backbone-IP.md): Step-by-step CLI procedure to change the msg-backbone IP addresses on a redundant pair of appliance event brokers that are part of a replicated site. #### Replacing and Migrating Appliance Event Brokers > Replacing or migrating entire appliance event brokers, including standalone units and redundant HA pairs, in or out of service. - [Out-of-Service Replacement of Solace Appliance Event Brokers](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-Solace-Appliances.md): Service-affecting procedure to replace standalone or redundant-pair appliance event brokers with newer compatible hardware. - [In-Service Migration of a Redundant Pair of Appliance Event Brokers](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-Redundant-Appliances-In-Service.md): Non-service-affecting migration to replace older CHS-3560AC chassis in a redundant pair with the newer CHS-3560AC-08-A. - [In-Service Replacement of a Failed Appliance Event Broker in a Redundant Pair](https://docs.solace.com/Appliance/Hardware-Maintenance-Tasks/Replacing-a-Failed-Appli.md): Non-service-affecting procedure to replace a failed appliance event broker in a redundant pair. #### Diagnostics > Gathering appliance event broker diagnostics and transferring diagnostic logs for troubleshooting. - [Gathering Appliance Event Broker Diagnostics](https://docs.solace.com/Appliance/Gathering-Appliance-Diagnostics.md): How to collect appliance event broker diagnostic files and debug logs with the gather-diagnostics command from the Linux host shell. - [Transferring Diagnostic Logs from an Appliance Event Broker](https://docs.solace.com/Appliance/transferring-diagnostic-logs.md): How to transfer diagnostic logs off an appliance event broker using SFTP/SCP tools or the CLI copy command. ### Performing Health Checks on Appliance Event Brokers Performing health checks on self-managed appliance event brokers, with a step-by-step checklist. - [Appliance Event Broker Health Check](https://docs.solace.com/Appliance/broker-appliance-health-check.md): How to perform a health check on self-managed appliance event brokers. - [Appliance Event Broker Health Checklist](https://docs.solace.com/Appliance/appliance-health-checklist.md): Provides a step-by-step checklist for performing a health check on your appliance event brokers. ## Administering Event Brokers > Day-to-day administration of self-managed event brokers: CLI and configuration management, users and access, backups, and operational tasks. ### Managing User Access to Self-Managed Event Brokers Controlling who can manage a self-managed event broker: CLI, SEMP, file transfer, and Linux shell users, authentication methods (internal, RADIUS, LDAP, and OAuth), CLI access levels, and account management. - [Managing User Access to Self-Managed Event Brokers](https://docs.solace.com/Admin/Configuring-Mgmt-and-Shell-Users.md): Covers managing authentication and authorization settings for management users and creating and configuring Linux shell users. - [User Authentication and Authorization](https://docs.solace.com/Admin/Mgmt-User-Authen-Auth-Overview.md): Compares basic authentication and OAuth 2.0 (interactive and automated) for management users, and which user classes each supports. - [CLI User Access Levels](https://docs.solace.com/Admin/CLI-User-Access-Levels.md): Explains CLI command scopes and the global and Message VPN access levels assigned to CLI users, how to assign them, and how to look up the minimum access level a command requires. - [Authentication Methods](https://docs.solace.com/Admin/Authentication-Methods.md): Lists the user authentication methods supported for each management user class: internal, RADIUS, LDAP, or OAuth for CLI users, and internal only for file transfer users. - [Setting CLI User Authentication Types](https://docs.solace.com/Admin/Setting-CLI-User-Authentication-Types.md): How to set the authentication type (internal, RADIUS, or LDAP) used for CLI users; internal authentication is always attempted first. - [Configuring LDAP Authentication](https://docs.solace.com/Admin/Configuring-LDAP-Authentication.md): How to enable LDAP authentication for CLI users (and LDAP authorization for clients) by configuring external LDAP servers and LDAP profiles. - [Configuring OAuth Authentication](https://docs.solace.com/Admin/Configuring-OAuth-for-Management-Access.md): Event brokers support OAuth 2.0 and OpenID Connect (OIDC) to grant management access, either interactively through Broker Manager or in an automated context using SEMPv2. - [Disabling Basic Authentication for SEMP and Broker Manager](https://docs.solace.com/Admin/Disabling-Basic-Authentication-SEMP-Manager.md): How to disable password-based basic authentication for SEMP and Broker Manager (version 10.25.18 and later) so management access uses OAuth; SSH CLI access is unaffected. - [Configuring Brute Force Protection](https://docs.solace.com/Admin/Configuring-Brute-Force-Protection.md): How to enable temporary lockout of local Linux and CLI accounts after repeated failed authentication attempts (10 failures in 15 minutes triggers a 15-minute lockout) as a brute force mitigation. - [Configuring Default CLI User Access Levels with External Authentication](https://docs.solace.com/Admin/Configuring-Default-Access-Levels-Externally.md): How to configure the default global and Message VPN access levels (and per-VPN exceptions) applied to RADIUS- or LDAP-authenticated CLI users when their assigned levels cannot be determined. - [Configuring Internal CLI User Accounts](https://docs.solace.com/Admin/Configuring-Internal-CLI-User-Accounts.md): Create and edit CLI user accounts that are authenticated through the internal database on the event broker, including setting passwords and global and Message VPN access levels. - [Disconnecting CLI User Sessions](https://docs.solace.com/Admin/Disconnecting-CLI-User-Sessions.md): You can forcibly disconnect a Solace CLI user session from the event broker to free access for other CLI users. - [Configuring File Transfer User Accounts](https://docs.solace.com/Admin/Configuring-File-Transfer-User-Accounts.md): How to create, edit, rename, and delete File Transfer user accounts (used for SFTP/SCP access), change their passwords, and recover lost passwords. - [Displaying User Authentication Details](https://docs.solace.com/Admin/Displaying-User-Authentication-Info.md): Use show User EXEC commands to monitor and validate user account and authentication configurations and statistics on event brokers. - [Configuring Multiple Linux Shell Users](https://docs.solace.com/Admin/Configuring-Multiple-Shell-Users.md): In addition to the built-in root and default support users, you can create extra sysadmin, support, and restricted shell accounts to add operational flexibility on appliances. ### Backing Up and Restoring Event Broker Configurations Protecting and recovering an event broker's configuration with local and external backups, scheduled backups, restores, and HA appliance and software broker scenarios. - [Backing Up and Restoring Event Broker Configurations](https://docs.solace.com/Admin/Managing-Event-Broker-Configurations.md): Overview of configuration backup and restore for appliances and software event brokers, covering what a backup contains, local and external backups, and scheduled backups. - [Creating Local Backups of Configuration Files](https://docs.solace.com/Admin/Creating-Local-Backups.md): How to manually create a local backup of a configuration file to /configs/backup and schedule automatic daily or weekly local backups. - [Backing Up Configuration Files to External File Servers](https://docs.solace.com/Admin/Backing-Up-Config-Files-Externally.md): How and when to back up configuration files to an external SFTP or SCP file server, using either the CLI copy command or a File Transfer user account. - [Restoring Configuration Files](https://docs.solace.com/Admin/Restoring-Config-Files.md): How to restore a standalone appliance or software event broker from a local or external backup, including when to restore and the compatibility requirements (identical software version, sufficient disk, matching hardware). - [Backing Up and Restoring HA Appliance Event Broker Configurations](https://docs.solace.com/Admin/Backup-Restore-HA-Configs.md): Back up and restore configuration for paired high-availability (HA) appliances running Guaranteed Messaging. - [Backing Up and Restoring HA Software Event Broker Configurations](https://docs.solace.com/Admin/Backup-Restore-SW-EventBroker-HA-Configs.md): Back up and restore configuration for high-availability (HA) software event brokers running Guaranteed Messaging. ### Resource Consumption Managing and monitoring an event broker's resource usage, including Message VPN resource limits, overbooking, and disk consumption. - [Resource Consumption](https://docs.solace.com/Admin/Managing-Consumption-of-Event-Broker-Resources.md): How to manage event broker resource consumption on a per-Message VPN basis, including system-level limits and full, partial, and no overbooking of resources. - [Monitoring & Managing Disk Consumption](https://docs.solace.com/Admin/Mon-Mgmt-Disk-Con.md): Solace recommends limiting and monitoring disk space usage (for example, with the SYSTEM_CHASSIS_DISK_UTILIZATION_HIGH event) to avoid high-utilization conditions such as sparse message spool files. ### Clock Synchronization Keeping an event broker's system clock synchronized using NTP or PTP. - [Configuring PTP for an Appliance Event Broker](https://docs.solace.com/Admin/Configuring-PTP.md): PTP and NTP time synchronization are mutually exclusive on an appliance; this provides the steps to disable NTP and enable PTP. - [Synchronizing Clocks with NTP Servers](https://docs.solace.com/Admin/Synchronizing-Message-Broker-Clocks.md): How to synchronize an event broker's clock with networked NTP servers, with separate procedures for appliances and software event brokers (host OS time). ### IP Interface Configuration Configuring and monitoring the IP interfaces on appliances and software event brokers, including physical interfaces, VRFs, IP routes, and LAGs. - [Appliance Event Broker Interfaces](https://docs.solace.com/Admin/IP-Interfaces/Appliance-Interfaces.md): An appliance relies on several physical and IP interfaces and internal routing components, including Management and Message Backbone VRF objects, to transfer management and message traffic. - [Configuring the Management Interface and Message Backbone Interface on Appliance event brokers](https://docs.solace.com/Admin/IP-Interfaces/Configuring-Mgmt-and-MBackbone-Interfaces.md): An appliance uses a Management VRF for out-of-band management and a Message Backbone VRF for client connections; configure the IP interfaces and IP routes for each. - [Monitoring Physical Interfaces & IP VRFs on Solace Appliance Event Brokers](https://docs.solace.com/Admin/IP-Interfaces/Monitoring-Physical-Interfaces-and-IP-VRFs.md): Use show commands to monitor and validate physical interface and IP VRF configurations and status on appliances. - [Configuring LAGs on Appliance Event Brokers](https://docs.solace.com/Admin/IP-Interfaces/Configuring-LAGs.md): Configure Link Aggregation Groups (LAGs) for the management and NAB network interfaces on appliances, including active/backup mode on management ports. - [IP Addressing in Cloud Instances](https://docs.solace.com/Admin/IP-Interfaces/IP-Addressing-in-Cloud-Instances.md): Explains how cloud providers assign public and private IP addresses to a software event broker (which cannot set them itself), with addressing considerations and best practices for multi-node routing and HA. - [Monitoring Software Event Broker Interfaces](https://docs.solace.com/Admin/IP-Interfaces/Monitoring-Sw-Msg-Broker-Interfaces.md): Use show commands to monitor and validate the physical interface and its status on software event brokers. ### Network Configuration Configuring an event broker's network identity and connectivity: default ports, DNS, hostname and router name, and forward proxy. - [Default Port Numbers](https://docs.solace.com/Admin/Default-Port-Numbers.md): Lists the default port numbers for the services on appliances and software event brokers. - [DNS Configuration](https://docs.solace.com/Admin/Configuring-DNS.md): How to provision DNS servers on an appliance (so hostnames resolve to network object IP addresses) and configure the polled domain name on both appliances and software event brokers. - [Hostname Configuration](https://docs.solace.com/Admin/Configuring-Host-Names.md): How to change an event broker's hostname (default solace) from the Solace CLI on appliances, and how to set it at container creation for software event brokers. - [Router Name Configuration](https://docs.solace.com/Admin/Configuring-Event-Broker-Names.md): How to configure a router name separate from the hostname (which it mirrors by default) using the Solace CLI or a configuration key. - [Global Forward Proxy Configuration](https://docs.solace.com/Admin/Configuring-Global-Forward-Proxy.md): How to create a global forward proxy to route event broker egress traffic through a proxy server when the broker is behind a firewall; handles system-level communication such as management user authentication. ### Other Administration Tasks General event broker administration tasks that fall outside the other sections: file management, product keys, and health checks. - [Event Broker File Management](https://docs.solace.com/Admin/Managing-Event-Broker-Files.md): Describes the event broker root directory structure and how to use the Solace CLI to change directories and copy configuration and software files to and from the broker. - [Product Keys](https://docs.solace.com/Admin/Product-Key.md): Explains which locked features require a product key on appliances (such as higher-performance ADBs) and software event brokers (such as upgrading the edition), and how to enter keys to unlock them. - [Health Checks and Readiness Probes](https://docs.solace.com/Admin/Health-Checks-Readiness-Probes.md): Discusses the event broker's response to load balancer HTTP health checks and the health check endpoints used by readiness and liveness probes. ## Configuring Services > Configuring services on self-managed event brokers: enabling and managing services including the REST, MQTT, and AMQP 1.0 messaging protocols, the Microgateway feature, and TCP connection tuning. - [Services](https://docs.solace.com/Services/Managing-Services.md): System-level management of the SMF, SEMP, Web, REST, MQTT, and AMQP services, including listen ports and event thresholds. - [TCP Settings](https://docs.solace.com/Services/Configuring-TCP-Settings.md): How to configure TCP parameters (keepalive, congestion window, MSS, slow-start-after-idle) for client-to-broker and broker-to-broker connections. ### REST Messaging Management Configuring REST messaging and REST Delivery Points (RDPs), and connecting the event broker to cloud services over REST. - [REST Messaging Management](https://docs.solace.com/Services/Configuring-EventBroker-for-REST.md): Overview of configuring an event broker to receive and publish REST messages using HTTP, RDPs, and REST consumers. - [Managing REST Service](https://docs.solace.com/Services/Managing-REST-Service.md): How to configure per-Message VPN REST service for incoming and outgoing connections, including authorization and client certificates. - [Managing REST Delivery Points Using the Solace Event Broker CLI](https://docs.solace.com/Services/Managing-RDPs.md): CLI reference for configuring REST Delivery Points (RDPs), queue bindings, REST consumers, POST request targets, and authentication. - [Creating REST Delivery Points Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/Cloud-Connector-Click-to-Connect.md): How to use the Broker Manager Connector Wizard to create REST Delivery Points on software and appliance event brokers. #### Connecting to Cloud Services Using REST > Step-by-step examples of RDP REST connectors to specific Azure, AWS, and Google cloud services. - [Connecting to Azure Event Hubs or Azure Service Bus Using REST](https://docs.solace.com/Services/OAuth-Authentication-Azure-Event-Hub.md): How to configure an RDP OAuth REST connector to stream event broker messages into Azure Event Hubs or Azure Service Bus. - [Connecting to Azure Functions Using REST](https://docs.solace.com/Services/HTTP-Header-Authentication-Azure-Functions.md): How to build a REST connector that triggers Azure serverless Functions from event broker messages. - [Connecting to AWS Lambda via Amazon API Gateway Using REST](https://docs.solace.com/Services/HTTP-Header-Authentication-AWS-API-Gateway.md): How to configure an RDP REST connector that sends event broker messages through Amazon API Gateway to invoke AWS Lambda functions. - [Connecting to AWS S3 Data Lakes Using REST](https://docs.solace.com/Services/AWS-S3-Data-Lakes-Connector.md): How to set up an RDP REST connector to write event broker messages as objects into AWS S3 data lake buckets. - [Connecting to Google Cloud Functions Using REST](https://docs.solace.com/Services/OAuth-Authentication-Google-Functions.md): How to build an RDP REST connector that triggers Google Cloud Functions from event broker messages. - [Connecting to Google Cloud Run Using REST](https://docs.solace.com/Services/OAuth-Authentication-Google-Run.md): How to build an RDP REST connector that invokes a Google Cloud Run service from event broker messages. ### MQTT Messaging Management Enabling and configuring the MQTT service, sessions, and retained messages. - [MQTT Messaging Management](https://docs.solace.com/Services/Managing-MQTT-Messaging.md): How to configure per-Message VPN MQTT service such as listen ports, transports, and client certificates. - [Managing MQTT Sessions](https://docs.solace.com/Services/Managing-MQTT-Sessions.md): How to create and configure MQTT session objects, including queues, topic subscriptions, and QoS levels. - [Managing MQTT Retained Messages](https://docs.solace.com/Services/Managing-MQTT-Retained-Messages.md): How to configure and monitor MQTT retain caches, covering limitations, memory usage, redundancy, and message lifetime. ### AMQP Messaging Management Enabling and configuring the AMQP 1.0 messaging service, per broker and per Message VPN. - [AMQP 1.0 Messaging Management](https://docs.solace.com/Services/Managing-AMQP-Messaging.md): Overview of enabling the AMQP 1.0 messaging service on an event broker, including ports, Message VPNs, and virtual hostnames. - [Managing AMQP Service on VPNs](https://docs.solace.com/Services/AMQP-on-VPN-Management.md): How to configure per-Message VPN AMQP settings such as listen ports, maximum connections, and TLS/SSL. ### Microgateways Understanding and configuring the Microgateway feature for REST request/reply through the event broker. - [Microgateways](https://docs.solace.com/Services/Microgateways-Overview.md): Overview of the Microgateway feature for REST request/reply through the broker, and when to use it versus REST messaging or an API gateway. - [Microgateway Use Cases](https://docs.solace.com/Services/Microgateway-Use-Cases.md): Microgateway scenarios such as traffic management, multi-protocol delivery, and request/reply migration. - [Microgateway Request Handling](https://docs.solace.com/Services/Microgateway-Request-Handling.md): How Microgateways encode REST method and path into topics to enable authorization, load balancing, prioritization, and burst absorption. - [Microgateway Configuration](https://docs.solace.com/Services/Managing-Microgateway.md): How to configure a Microgateway, including limitations, VPN gateway mode, queue setup, and passing OAuth tokens to REST consumers. #### Microgateway Examples > Worked CLI examples of common Microgateway deployments. - [Traffic Management to Microservices Example](https://docs.solace.com/Services/Microgateway-Traffic-Mgmt-Example.md): CLI example configuring queues, subscriptions, RDPs, and REST consumers for prioritized POST-request traffic to a microservice. - [Eavesdropping Application Example](https://docs.solace.com/Services/Microgateway-Eavesdropping-App-Example.md): CLI example adding an eavesdropping application to a Microgateway by creating a queue with matching request and reply-to subscriptions. ## Securing Event Brokers > Securing self-managed event brokers: TLS, client authentication and authorization, and hardening. - [Security Overview](https://docs.solace.com/Security/Security-Solace.md): Overview of event broker security goals—restricting data access, preventing loss, separating roles, and auditing—and the authentication, authorization, and encryption capabilities used to secure the network, host, and data at rest. ### Client Authentication for REST Authenticating connecting clients using Basic, Client Certificate, Kerberos, or OAuth schemes, including a two-way SSL/mutual TLS tutorial for REST clients. - [Client Authentication](https://docs.solace.com/Security/Client-Authentication-Overview.md): Describes the four client authentication schemes—Basic, Client Certificate (mTLS), Kerberos, and OAuth—used to authenticate a client connecting to a Message VPN. - [Configuring Client Authentication](https://docs.solace.com/Security/Configuring-Client-Authentication.md): CLI reference for configuring the Basic, Client Certificate, Kerberos, and OAuth authentication schemes for a Message VPN, including OAuth profile settings such as OAuth endpoints, client ID/secret, and required claims. - [Two-way SSL Authentication for REST](https://docs.solace.com/Security/Two-Way-SSL-Authentication.md): Tutorial for setting up two-way SSL/mutual TLS authentication with self-signed certificates for REST and other client connections, using OpenSSL, Postman, and SDKPerf examples. ### Client Authorization Authorizing clients through client profiles, ACL profiles, client usernames, LDAP groups, and OAuth claims, and viewing or disconnecting connected clients. - [Client Authorization](https://docs.solace.com/Security/Client-Authorization-Overview.md): Describes authorizing clients through the internal database, OAuth, or LDAP groups, and lists which authentication and authorization method combinations are supported. - [Configuring Clients with Client Profiles](https://docs.solace.com/Security/Assigning-Client-Profiles.md): Explains client profiles, which assign a common set of configuration properties—such as resource allocation, TCP tuning, and persistent messaging—to authorized clients. - [Controlling Client Access with ACL Profiles](https://docs.solace.com/Security/Granting-Clients-Access.md): Describes ACL profiles, which control a client's connection and topic publish/subscribe access using a default action plus exceptions. - [Configuring Client Authorization](https://docs.solace.com/Security/Configuring-Client-Authorization.md): Explains that, after authentication, a client is authorized using the client profile and ACL profile assigned through its client username or LDAP authorization group. - [Configuring Client Usernames Using the CLI](https://docs.solace.com/Security/Configuring-Client-Usernames.md): CLI reference for creating and editing client username accounts, including assigning ACL and client profiles, subscription managers, endpoint permission overrides, and passwords. - [Creating Client Usernames Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/broker-manager-create-client-username.md): Describes creating and configuring client username accounts in Broker Manager to manage the authentication and permissions of connecting client applications. - [Configuring ACL Profiles Using the CLI](https://docs.solace.com/Security/Managing-Access-Control-Lists.md): CLI reference for creating ACL profiles and configuring client-connect, topic publish/subscribe, and share-name subscribe permissions, plus ACL topic matching modes. - [Configuring ACL Profiles Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/acl-profiles-core.md): Describes creating and updating ACL profiles in Broker Manager and associating them with a client username or an authorization group. - [Configuring Client Profiles](https://docs.solace.com/Security/Configuring-Client-Profiles.md): Describes the range of configuration tasks available for client profiles, including bridging, shared subscriptions, guaranteed messaging parameters, TCP settings, and message eliding. - [Configuring Client LDAP Authorization](https://docs.solace.com/Security/Configuring-LDAP-Groups.md): Describes configuring LDAP authorization groups on a Message VPN to authorize clients based on external LDAP group membership or OAuth token claims. - [Configuring OAuth Authorization](https://docs.solace.com/Security/Configuring-OAuth-Authorization.md): Describes the access_token and id_token types supported for OAuth and the OAuth profile, authorization group claim, and authorization group configurations required to implement OAuth authorization. - [Viewing Client Configuration Information](https://docs.solace.com/Security/Viewing-Client-Config-Info.md): Reference for show commands used to monitor client, client-profile, and client-username configuration, status, and aggregated statistics. - [Disconnecting Specific Clients](https://docs.solace.com/Security/Disconnecting-Specific-Clients.md): Describes the Admin EXEC commands used to disconnect a specific client from the event broker. ### TLS / SSL Encryption Encrypting connections with TLS/SSL: cryptographic keys, server certificates, certificate authorities, revocation checking, cipher suites, and monitoring. - [TLS / SSL Encryption](https://docs.solace.com/Security/TLS-SSL-Message-Encryption-Overview.md): Describes TLS/SSL encrypted connections, supported cipher suites and signature algorithms for TLS 1.2/1.3, and certificate authorities and revocation checking. - [Managing Cryptographic Keys](https://docs.solace.com/Security/Managing-Cryptographic-Keys.md): Describes the three categories of cryptographic keys—TLS server, TLS client, and TLS pre-shared—and how to generate, transfer, store, and manage their lifetime. - [TLS / SSL Service Configuration](https://docs.solace.com/Security/Managing-TLS-SSL-Service.md): Overview of configuring and monitoring the TLS/SSL facility so clients can use encrypted connections, including the supported TLS versions. - [Managing Server Certificates](https://docs.solace.com/Security/Managing-Server-Certs.md): Describes loading and setting the TLS/SSL server certificate file the event broker presents during the TLS handshake. - [Configuring Certificate Authorities](https://docs.solace.com/Security/Managing-Certificate-Authorities.md): Describes configuring the standard, domain validation, and client authentication certificate authority lists, and enabling CRL, OCSP, or OCSP-CRL certificate revocation checking. - [Configuring OCSP Certificate Revocation Checking](https://docs.solace.com/Security/Configuring-OCSP-Certificate-Revocation.md): Step-by-step procedure for configuring a certificate authority to use OCSP certificate revocation checking, including override URLs, responder common names, and timeouts. - [Configuring CRL Certificate Revocation Checking](https://docs.solace.com/Security/Configuring-CRL-Certificate-Revocation.md): Step-by-step procedure for configuring a certificate authority to use CRL certificate revocation checking, including the CRL URL and refresh schedule. - [Configuring OCSP-CRL Certificate Revocation Checking](https://docs.solace.com/Security/Configuring-OCSP-CRL-Certificate-Revocation.md): Step-by-step procedure for configuring a certificate authority to use combined OCSP-CRL certificate revocation checking. - [Viewing Certificate Authorities](https://docs.solace.com/Security/Monitoring-Certificate-Authorities.md): Reference for show commands used to view the configuration and statistics of standard, domain validation, and client authentication certificate authorities. - [TLS/SSL Service Connections](https://docs.solace.com/Security/TLS-SSL-Service-Connections.md): Describes enabling TLS/SSL-encrypted connections for publishing and receiving messages, Message VPN bridges, replication/Config-Sync bridges, and SEMP (Solace Element Management Protocol). - [Configuring TLS Service Connection Settings](https://docs.solace.com/Security/Configuring-TLS-Service-Connect-Settings.md): Describes the TLS service connection settings the event broker supports, including TLS 1.2 and TLS 1.3. - [Configuring CRIME Exploit Protection](https://docs.solace.com/Security/Configuring-CRIME-Exploit-Protect.md): Describes CRIME exploit protection for TLS connections that use compression, and the considerations before disabling it for performance. - [Configuring Server Certificate Validation Settings](https://docs.solace.com/Security/Configuring-Server-Cert-Validation.md): Describes the server certificate validation settings you can configure to make certificate validation more or less secure. - [Configuring Cipher Suites for Inbound Connections](https://docs.solace.com/Security/Configuring-Cipher-Suites-for-Inbound-Connections.md): Describes how to configure the cipher suites offered for inbound TLS connections. - [Enabling TLS/SSL Connection Downgrades on Message VPNs](https://docs.solace.com/Security/Enabling-TLS-Downgrade.md): Describes the option that lets clients downgrade an authenticated TLS/SSL connection to plaintext after login, to avoid encrypting subsequent data for performance. - [Re-establishing Secure Connections After MessageBroker Failovers](https://docs.solace.com/Security/Re-establish-Secure-Connects.md): Explains that after a high-availability (HA) event broker failover, the time required to reconnect clients increases significantly when a large public key size or a cipher suite using ECDHE is used for key establishment. - [Monitoring TLS/SSL Configuration and Connections](https://docs.solace.com/Security/Monitoring-TLS-SSL-Service.md): Reference for show commands used to monitor TLS/SSL certificate files, the server certificate, supported and configured cipher suites, SSL statistics, and allowed TLS versions. ## Monitoring Event Brokers > Monitoring self-managed event brokers: metrics, logs, events, alarms, and health. - [Feature-Specific Monitoring Information](https://docs.solace.com/Monitoring/Monitor-Index.md): Reference table indexing which documentation section covers the monitoring capabilities available for each event broker feature. ### Configuring Monitoring Configuring event generation, thresholds, logs, and message-bus event notifications for monitoring an event broker. - [Configuring Monitoring](https://docs.solace.com/Monitoring/Monitoring-and-Management.md): Overview of the event broker monitoring configuration options covered in this section, including event thresholds, logs, message-bus events, and health monitoring. - [Configuring Events and Thresholds](https://docs.solace.com/Monitoring/Configuring-Client-Event-Output-and-Thresholds.md): Explains the set and clear thresholds that determine when threshold-based events are generated and cleared, and links to the topics for customizing and configuring them. - [Customizing Event Generation](https://docs.solace.com/Monitoring/Customizing-Generation-of-Events.md): Describes customizing event severity levels, the Message VPN events are published to, log tags, and the syslog timestamp format. - [Clearing One-Shot Events](https://docs.solace.com/Monitoring/Clearing-One-Shot-Events.md): Describes clearing and resetting one-shot events, which are sent only once per occurrence, for clients and Message VPN bridges using the CLI. - [Configuring System Event Thresholds](https://docs.solace.com/Monitoring/Configuring-System-Event-Thresholds.md): Describes configuring the set and clear thresholds for system-wide service connection, memory usage, and message spool events. - [Configuring VPN Event Thresholds](https://docs.solace.com/Monitoring/Configuring-VPN-Event-Thresholds.md): Describes configuring the set and clear thresholds for a Message VPN's connections, egress and ingress message rate, large message, service, and subscription events. - [Configuring VPN Message Spool Event Thresholds](https://docs.solace.com/Monitoring/Configuring-VPN-M-Spool-Event-Thresholds.md): Describes configuring the set and clear thresholds for a Message VPN's egress and ingress flow, endpoint, spool usage, transacted session, transaction, and queue events. - [Configuring Client Event Thresholds](https://docs.solace.com/Monitoring/Configuring-Client-Event-Thresholds.md): Describes configuring the set and clear thresholds for a client profile's endpoint spool usage, connections, flow, and service events. - [Displaying and Clearing Logs](https://docs.solace.com/Monitoring/Displaying-Logs.md): Describes displaying and clearing the ACL, command, event, system, no-subscription-match, and REST logs using the CLI. - [Last Restart Reason](https://docs.solace.com/Monitoring/Last-Restart-Reason.md): Explains how to use the show system CLI command to identify the type and reason for an event broker's last shutdown and restart. - [Monitoring Events Using Syslog](https://docs.solace.com/Monitoring/Monitoring-Events-Using-Syslog.md): Describes the format and components of the syslog messages an event broker generates for routine operations, failures, and critical conditions. - [Configuring the Log File Retention Policy](https://docs.solace.com/Monitoring/Configuring-Log-Retention-Policy.md): Describes configuring an event broker to delete syslog files after a maximum number of days instead of by log file size, such as to comply with GDPR. - [Monitoring Hardware Blades](https://docs.solace.com/Monitoring/Monitoring-Blades.md): Describes using the show hardware CLI command to display the serial number, firmware version, and error counts for the hardware blades in an appliance. - [Receiving Message Bus Events](https://docs.solace.com/Monitoring/Receiving-Message-Bus-Events.md): Describes the system, Message VPN, client, and subscription event messages an event broker can publish to well-known topics on the message bus. - [Monitoring the Health of the Solace Software Event Broker](https://docs.solace.com/Monitoring/SW-Health-Monitoring.md): Describes using the POST utility at startup and configuring runtime metric thresholds to monitor infrastructure issues that affect software event broker stability. - [Subscribing to Message Bus Events](https://docs.solace.com/Monitoring/Subscribing-to-MBus-Events.md): Describes the system, Message VPN, client, subscribe, and unsubscribe event topics an application can subscribe to in order to receive event messages. ### SEMP and Syslog Monitoring Best Practices Recommended monitoring approaches, event-handling guidelines, and events to monitor using SEMP and syslog. - [SEMP and Syslog Monitoring Best Practices](https://docs.solace.com/Monitoring/Monitoring-BP.md): Compares the SEMP and syslog-based monitoring options available for an event broker and recommends the protocols and ports best suited to different integration requirements. - [Monitoring Events](https://docs.solace.com/Monitoring/Monitoring-Events.md): Describes the client, VPN, and system events an event broker generates, and guidelines for handling them using message-bus subscriptions or SEMP request/reply monitoring. - [Monitoring Using Syslog](https://docs.solace.com/Monitoring/Monitoring-Using-Syslog.md): Describes the command, event, and system syslog logging categories an event broker writes to, and the CLI commands used to view them. - [Minimum Recommended Events for Monitoring](https://docs.solace.com/Monitoring/Min-Events.md): Lists the minimum set of system and Message VPN events Solace recommends monitoring applications watch for in the system syslog. - [Gathering Statistics with SEMP](https://docs.solace.com/Monitoring/Gathering-Stats-SEMP.md): Tutorial for using SEMP over HTTP to gather event broker and Message VPN statistics, with an example command and a list of important statistics to monitor. - [Appliance Event Broker Alarms](https://docs.solace.com/Monitoring/Appl-HW-Alrm.md): Describes the deprecated hardware alarm notifications for appliance event brokers and recommends monitoring events instead. - [Network Monitoring](https://docs.solace.com/Monitoring/Net-Mon.md): Lists the categories of CLI commands used to display network statistics and troubleshoot network problems on an event broker. - [Latency Monitoring](https://docs.solace.com/Monitoring/Latency-Mon.md): Describes building a publish/subscribe tool to measure end-to-end latency across a messaging infrastructure. - [Thresholds](https://docs.solace.com/Monitoring/Thresholds.md): Explains the set and clear threshold model, and the hysteresis zone between them, used to trigger and clear events on an event broker. - [Performance Monitoring](https://docs.solace.com/Monitoring/Perf-Mon.md): Describes the ingress and egress message and byte rate metrics available for endpoints, clients, and Message VPNs using the CLI or SEMP. - [Client Statistics](https://docs.solace.com/Monitoring/Client-Stats.md): Lists the per-session statistics methods available in each Solace messaging API for debugging client applications. ### Syslog Event Reference Reference documentation for the individual syslog events an event broker can generate. - [Syslog Event Reference](https://docs.solace.com/Monitoring/PubSub-Event-Reference.md): Links to the reference of syslog messages for system-wide, Message VPN, and client and subscriber events generated by an event broker. - [Solace Syslog Events](https://docs.solace.com/Admin-Ref/Solace-PubSub-Event-Reference/event_ref_boiler.md): Comprehensive reference of Solace Message Bus Management syslog events, including event descriptions, severity levels, recommended actions, and message formats. ## Management Tools > The interfaces used to administer event brokers. Covers the browser-based Solace Cloud Console and Broker Manager, the Solace CLI (with its command reference), and SEMP, the RESTful programmatic management API. - [Event Broker Management Tools](https://docs.solace.com/Admin/management-tools-lp.md): Solace provides several tools to help you configure and manage your event brokers. - [Solace Cloud Console](https://docs.solace.com/Cloud/cloud-console.md): Describes the Solace Cloud Console, the primary browser-based tool for accessing Solace Cloud and managing event broker services, Event Portal, and Insights. ### Broker Manager Broker Manager, the browser-based tool for configuring, viewing, and troubleshooting event brokers, including its authentication, sessions, and secure access settings. - [Using Broker Manager with Event Broker Services](https://docs.solace.com/Cloud/using-broker-manager-cloud.md): Describes opening Broker Manager from the Solace Cloud Console to configure Message VPN settings, ACL profiles, queues, and other event broker service settings. - [Pre-Authentication for Broker Manager](https://docs.solace.com/Cloud/manage-cloud-authentication.md): Explains the pre-authentication setting that lets users open Broker Manager from the Solace Cloud Console without logging in separately, and the considerations for disabling it. - [Using Broker Manager with Self-Managed Event Brokers](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Overview.md): Describes accessing and logging in to Broker Manager, including with OAuth, for appliance and software event brokers. - [Broker Manager Sessions](https://docs.solace.com/Admin/Broker-Manager/PubSub-Manager-Sessions.md): Explains how Broker Manager sessions are created and terminated, and how to view, delete, and configure idle timeout and maximum lifetime settings for sessions. - [Configuring HTTP-to-HTTPS Redirect for Broker Manager](https://docs.solace.com/Admin/configure-TLS-broker-manager.md): Describes enabling or disabling automatic redirection of HTTP connections to HTTPS, and overriding the default HTTPS port, when accessing Broker Manager. ### Solace Event Broker CLI The Solace CLI, a text-based interface for event broker administration, configuration, and troubleshooting, along with its quick and full command references and access requirements. - [Solace Event Broker CLI](https://docs.solace.com/Admin/Solace-CLI/Using-Solace-CLI.md): Describes logging in to and navigating the Solace CLI on appliance, software, and cloud event brokers, including session limits and authentication. - [Solace Event Broker CLI Quick Reference](https://docs.solace.com/Admin/Solace-CLI/cli-quick-reference.md): Reference for the most commonly used CLI commands and the four command levels that make up the CLI hierarchy. - [Solace Event Broker CLI Command Reference](https://docs.solace.com/Admin/Solace-CLI/Command-Line-Reference.md): Explains the notation conventions, such as required, optional, and mutually exclusive parameters, used throughout the CLI command documentation. - [Appliance CLI Commands](https://docs.solace.com/Admin-Ref/CLI-Reference/APPL_CLI_Commands.md): Comprehensive reference for all CLI commands available for configuring, monitoring, and troubleshooting appliance event brokers. - [Software Event Broker CLI Commands](https://docs.solace.com/Admin-Ref/CLI-Reference/VMR_CLI_Commands.md): Comprehensive reference for all CLI commands available for configuring, monitoring, and troubleshooting software event brokers. - [CLI Commands Scope and Access Level Requirements](https://docs.solace.com/Admin-Ref/CLI-Summary/CLI-permissions-summary.md): Summarizes the required scope and access levels needed to run each Solace CLI command on an event broker. - [Show the CLI Sequence for the Current Configuration](https://docs.solace.com/Admin/Generating-CLI-Config-Sequences.md): Tutorial for generating the sequence of CLI commands needed to recreate an event broker's or Message VPN's current configuration on another event broker. ### SEMP SEMP, the RESTful API for programmatically configuring and monitoring event brokers, including its versions, security, features, error handling, and API references. - [SEMP](https://docs.solace.com/Admin/SEMP/Using-SEMP.md): Overview of SEMP v2, the RESTful API for provisioning, configuring, and monitoring event brokers, and the Configuration, Monitoring, and Action APIs it comprises. - [SEMP API Versions](https://docs.solace.com/Admin/SEMP/SEMP-API-Versions.md): Explains the current SEMP API version, how SEMP versions map to event broker versions, and Solace's approach to compatibility across releases. - [SEMP API Architecture](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.md): Describes the Configuration, Action, and Monitoring APIs that make up SEMP v2 and the purpose each one serves. - [SEMP Security](https://docs.solace.com/Admin/SEMP/SEMP-Security.md): Describes SEMP's basic and OAuth authentication, session management, and role-based access control features. - [SEMP Features](https://docs.solace.com/Admin/SEMP/SEMP-Features.md): Describes SEMP v2 features such as the select and where query parameters, retrieving object and message counts, opaque passwords, and paging. - [SEMP Error Handling](https://docs.solace.com/Admin/SEMP/SEMP-Error-Handling.md): Reference for the HTTP response codes and error object fields SEMP returns for failed requests, including a table of common error codes. - [SEMP API Reference](https://docs.solace.com/Admin/SEMP/SEMP-API-Ref.md): Links to the SEMP Configuration, Action, and Monitoring API references, viewable directly on an event broker or through the online Swagger UI. - [Declarative SEMP](https://docs.solace.com/Admin/SEMP/Declarative-SEMP.md): Describes Declarative SEMP (dSEMP), which configures an event broker's Message VPN objects by declaring a target state and synchronizing the broker to it using generate, plan, apply, and destroy operations. - [Legacy SEMP](https://docs.solace.com/Admin/SEMP/Using-Legacy-SEMP.md): Describes SEMP v1 (Legacy SEMP), the XML-based request/reply protocol for managing and monitoring event brokers, superseded by the SEMP v2 RESTful API. ## Solace Event Portal > Solace Event Portal: cloud-based event management tool for discovering, creating, designing, sharing, managing, and governing the assets and resources in event-driven architectures. It includes Designer for modeling applications, events, and event flows, Catalog for finding and sharing objects, and Runtime Event Manager for configuring and auditing runtime event brokers. It also has several REST APIs. - [Event Portal Overview](https://docs.solace.com/Cloud/Event-Portal/event-portal-overview.md): Overview of what Event Portal does and how to use it. ### Event Portal User Access Managing access to Event Portal resources with role-based access control. - [Managing User Access to Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-user-access.md): How user roles and permissions control access to environments and application domains. - [Creating and Managing Environments](https://docs.solace.com/Cloud/environments.htm): Using environments in Solace Cloud, including Event Portal. Setting Event Portal runtime configuration options and user access at the environment level. ### Connecting Event Portal to Runtime Event Brokers Connecting Event Portal to runtime event brokers, either within the same Solace Cloud account or externally through an Event Management Agent. - [Connecting Event Portal to Runtime Event Brokers](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-connect.md): Overview of the ways Event Portal connects to runtime event brokers. - [Connecting Event Broker Services to Event Portal Through Solace Cloud](https://docs.solace.com/Cloud/Event-Portal/event-portal-cloud-ema.md): Connecting Event Portal to runtime event broker services in the same Solace Cloud account. - [Connecting External Event Brokers to Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-setup-ema-connection.md): Connecting Event Portal to event brokers that are not part of the Solace Cloud account through an Event Management Agent. ### Designer Modeling and viewing the objects that make up an event-driven architecture. - [Designer](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-tool.md): Overview of how to use Designer to design and view your event-driven architecture (EDA). - [Application Domains](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-application-domains.md): Organizing applications, events, and other objects into domains for deployment, governance, and reuse. - [Applications](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-applications.md): Modeling the applications that publish and subscribe to events in an event-driven architecture. - [Configuring Event Brokers in Event Portal](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-config.md): How model applications configured in Designer can be used to configure queues and ACLs for client applications connecting to runtime event brokers. - [Creating and Managing Standard Solace Applications](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-standard.md): Creating and configuring standard Solace applications and their event associations. - [Creating and Managing RDPs (Webhooks)](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-rdp.md): Creating and configuring REST Delivery Points (RDPs) for webhook-based applications. - [Creating and Managing Kafka Applications](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-apps-kafka.md): Creating and configuring Kafka applications and their topics in Event Portal. - [Events](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-events.md): Modeling events, including the schemas and topic addresses associated with them. - [Topic Addresses](https://docs.solace.com/Cloud/Event-Portal/event-portal-topic-addresses.md): Understand how topic addresses in Event Portal define the topics for actual events in the runtime. - [Managing Event Data Access](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-events-access.md): Controlling which applications can publish and subscribe to events that contain sensitive information. - [Schemas](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-schemas.md): Defining the structure and format of event payloads. - [Enumerations](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-enums.md): Defining reusable sets of allowed values for use in topic addresses. - [Event APIs](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-event-apis.md): Grouping events into an event API that describes how applications interact with an event broker. - [Event API Products](https://docs.solace.com/Cloud/Event-Portal/event-portal-designer-event-api-products.md): Bundling event APIs into products for distribution to API consumers. - [Catalog](https://docs.solace.com/Cloud/Event-Portal/event-portal-catalog-tool.md): Catalog is a library for all of the objects and object versions created in Event Portal. ### Runtime Event Manager Connecting the design in Event Portal to runtime event brokers, and auditing runtime configuration against that design. - [Runtime Event Manager](https://docs.solace.com/Cloud/Event-Portal/event-portal-manager-tool.md): Overview of Runtime Event Manager, the tool for configuring and auditing runtime event brokers. - [Modeled Event Meshes](https://docs.solace.com/Cloud/Event-Portal/modeled-event-mesh.md): Creating and maintaining models of your runtime event meshes. - [Building a Modeled Event Mesh](https://docs.solace.com/Cloud/Event-Portal/modeled-event-mesh-runtime-data.md): Adding runtime data, such as queues and subscriptions, to a modeled event mesh. - [Reviewing Promotions to Event Brokers](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-approval.md): Reviewing and approving configuration changes before they are promoted to a runtime event broker. - [Discovering Runtime Data](https://docs.solace.com/Cloud/Event-Portal/event-portal-collect-runtime-data.md): Collecting configuration data from a runtime event broker for review in Runtime Event Manager. - [Auditing and Importing Runtime Data](https://docs.solace.com/Cloud/Event-Portal/event-portal-audit-runtime-data.md): Comparing discovered runtime data against the modeled event mesh and importing differences. - [Runtime Configuration Templates](https://docs.solace.com/Cloud/Event-Portal/event-portal-runtime-templates.md): Defining reusable templates for configuring queues and other runtime objects. ### Event Portal REST API Automating Event Portal tasks and integrating with CI/CD pipelines using REST APIs. - [Pushing Runtime Configuration with Event Portal REST APIs](https://docs.solace.com/Cloud/Event-Portal/event-portal-cicd.md): Using REST APIs to push runtime configuration for CI/CD automation. - [Event Portal REST API](https://docs.solace.com/Cloud/Event-Portal/event-portal-v2-REST-API.md): Reference for the Event Portal v2 REST API. ## Solace Agent Mesh > The event-driven agentic-AI framework for building, deploying, and operating AI agents and workflows. Covers concepts and architecture, installation, building agents and the models, tools, connectors, and entrypoints they use, day-two administration, reference material, and creating and managing agent meshes in Solace Cloud. ### Overview Start here for what Solace Agent Mesh is and how it fits together. - [Solace Agent Mesh](https://docs.solace.com/Agent-Mesh/agent-mesh.md): Overview of Solace Agent Mesh, an agent development and runtime platform that supports MCP and A2A and works with any LLM; introduces the architecture, entrypoints for governance and access control, agents, and horizontal scaling over a Solace event mesh. ### Getting Started What Agent Mesh is, where to run it, and how to get a first agent working. - [What Is Agent Mesh?](https://docs.solace.com/Agent-Mesh/Framework/getting-started/what-is-sam.md): Explains Agent Mesh as a platform for building, testing, deploying, monitoring, and improving agents and agent workflows, and how its components (agents, tools, and others) communicate over an event broker. - [Choosing Your Installation Path](https://docs.solace.com/Agent-Mesh/Framework/getting-started/choosing-your-path.md): Helps you pick an installation path, with an "I want to…" table that maps goals to a path and a comparison of the paths by purpose, event broker, configuration method, and complexity. - [Create Your First Agent](https://docs.solace.com/Agent-Mesh/Framework/getting-started/your-first-agent.md): Walkthrough that creates an agent from the UI, deploys it into a running deployment, and chats with it, with no code or YAML. ### Install and Deploy Installation from prerequisites through the desktop bundle and Kubernetes deployments, then configuration and fixing deploy-time failures. - [Before You Begin](https://docs.solace.com/Agent-Mesh/Framework/installing/before-you-begin.md): Prerequisites that apply to every installation path: an event broker, an LLM provider, system requirements, how to obtain the delivery package, and network requirements. - [Installing the Desktop Bundle](https://docs.solace.com/Agent-Mesh/Framework/installing/desktop.md): Installs Agent Mesh as a single laptop application that bundles the runtime and an in-memory event broker, so only an LLM provider connection is needed; covers supported environments, verification, using the sam CLI, data and logs, and moving to production. - [Kubernetes Quick Start](https://docs.solace.com/Agent-Mesh/Framework/installing/kubernetes/quickstart.md): Minimal Helm-based Kubernetes deployment with an embedded event broker and bundled PostgreSQL and object storage, intended for evaluation and proof of concept only; covers post-install steps (pod status, port-forward, opening the UI, setting the LLM API key). - [Installing Kubernetes for Production](https://docs.solace.com/Agent-Mesh/Framework/installing/kubernetes/production.md): Production Kubernetes deployment using an external event broker, external persistent storage, TLS, and authentication; covers Helm values, workload identity for cloud storage, trusting custom CA certificates, deploying, and verifying. - [Configuring Agent Mesh](https://docs.solace.com/Agent-Mesh/Framework/installing/configure.md): Post-install configuration through Helm values for the event broker, LLM provider, artifact storage, session storage, authentication, and secrets, plus validating the result; the desktop bundle is not configured here. - [Troubleshooting Your Installation](https://docs.solace.com/Agent-Mesh/Framework/installing/troubleshoot.md): Diagnoses deploy-time failures, including startup and YAML validation errors, LLM provider authentication, port conflicts, event broker connection, authentication, and TLS failures at boot, session-store and artifact-path problems, and toolset discovery errors. ### Concepts How Agent Mesh is built: the workload classes, the event broker fabric, the wire protocol, and the core building blocks of agents, entrypoints, tools, and workflows. - [Architecture Overview](https://docs.solace.com/Agent-Mesh/Framework/concepts/architecture.md): High-level tour of the three long-running workload classes (Entrypoint Executor, Agent-Workflow Executor, Secure Tool Runtime), trust and authentication, the event broker as connective tissue, where state lives, and where a deployment runs. - [How Agent Mesh Manages Workloads](https://docs.solace.com/Agent-Mesh/Framework/concepts/managing-workloads.md): What each of the three workload classes owns, how they meet over the event broker, their trust boundaries, and how they run in production versus in desktop mode. - [What Is an Agent?](https://docs.solace.com/Agent-Mesh/Framework/concepts/what-is-an-agent.md): An agent is the primary building block: a role, a language model, and a list of tools, described through the UI or as a YAML resource, with the loop each task follows. - [What Is an Entrypoint?](https://docs.solace.com/Agent-Mesh/Framework/concepts/what-is-an-entrypoint.md): How people and other systems reach agents; an entrypoint translates a transport's protocol into a task for an agent, authenticates the caller, and streams the response back. Introduces the eight built-in entrypoint types. - [What Are Tools?](https://docs.solace.com/Agent-Mesh/Framework/concepts/what-are-tools.md): Introduces the four kinds of tools an agent can call (built-in, MCP, OpenAPI, and custom), the choice between configuration and code, and the Secure Tool Runtime. - [What Are Workflows? (Early Access)](https://docs.solace.com/Agent-Mesh/Framework/concepts/what-are-workflows.md): A workflow is a deterministic, multi-step recipe, in contrast to an agent where the model decides each step; explains when to choose one over the other and what a workflow is made of. - [The Event-Driven Mesh](https://docs.solace.com/Agent-Mesh/Framework/concepts/event-driven-mesh.md): Why every cross-process message travels on an event broker; covers the namespace as an isolation boundary, the topic tree, queues versus direct subscriptions, and the in-memory event broker used on the desktop. - [Agent-to-Agent Protocol](https://docs.solace.com/Agent-Mesh/Framework/concepts/a2a-protocol.md): Wire-format reference for A2A, a JSON-RPC 2.0 dialect carried over event broker topics, including the envelope, topic naming, user properties, signal taxonomy, task states, and JWT signing and trust. - [Sessions](https://docs.solace.com/Agent-Mesh/Framework/concepts/sessions.md): The persistent conversation thread between a user and an agent; covers the three session-store backends, how each entrypoint type derives a session ID, persistent versus run-based sessions, and history compaction. - [Platform Service](https://docs.solace.com/Agent-Mesh/Framework/concepts/platform-service.md): The control plane deployed beside the runtime workloads, which stores agent and entrypoint configuration, drives deployments, and provides authorization and audit; a deployment also works without it, using YAML files loaded at startup. ### Building Agents and Their Resources Create agents and the resources they depend on (models, tools, toolsets, skills, connectors, entrypoints, workflows, external agents) in the UI or as YAML. - [Creating Agents](https://docs.solace.com/Agent-Mesh/Framework/building/agents/index.md): Creates and manages agents in the UI, including agent configuration, creating an agent using AI or manually, and pointers to defining agents as code. - [Creating Agents with the CLI](https://docs.solace.com/Agent-Mesh/Framework/building/agents/cli.md): Authors an agent as declarative-config YAML using a release-notes-assistant example, including settings not yet modeled as fields, then applies and verifies it with the sam CLI. - [Configuring Models](https://docs.solace.com/Agent-Mesh/Framework/building/models/index.md): Model configurations tell Agent Mesh which LLM provider and model to call and which credentials to use, referenced by agents through an alias; covers adding, managing, and using models, plus decision models (Early Access). - [Configuring Models with the CLI](https://docs.solace.com/Agent-Mesh/Framework/building/models/cli.md): Defines a model configuration as YAML using an Anthropic example, including a decision model (Early Access), then applies and verifies it. - [Configuring Tools](https://docs.solace.com/Agent-Mesh/Framework/building/tools.md): Covers the four tool kinds declared on an agent: built-in tools and groups, MCP tools (transports, auth, hardening), OpenAPI tools, and remote tools written in Python or Go, plus tool scopes and authorization and the tool sandbox model. - [Creating Toolsets](https://docs.solace.com/Agent-Mesh/Framework/building/toolsets.md): Hands-on flow for shipping custom tool code as a toolset: author tools with the SDK, test locally, package with `sam toolset package`, upload through the Toolsets page, and attach the toolset to an agent. - [Creating Skills](https://docs.solace.com/Agent-Mesh/Framework/building/skills.md): Hands-on flow for building a skill, a named bundle of instructions (SKILL.md), reference material, and optional tools that an agent loads on demand; covers authoring, testing, packaging with `sam skill package`, uploading, and attaching it to an agent. - [Configuring Connectors](https://docs.solace.com/Agent-Mesh/Framework/building/connectors/index.md): Connectors give agents access to external data sources and services; covers the connector types (Apps, Custom, Experimental), creating and managing connectors, the shared credential model, assigning connectors to agents, and access control. - [MCP Connectors](https://docs.solace.com/Agent-Mesh/Framework/building/connectors/mcp/index.md): Connects agents to remote MCP servers over SSE or Streamable HTTP and discovers their tools; covers authentication options (none, API key, HTTP, OAuth2/OIDC), tool selection, and troubleshooting. Local stdio MCP servers are not supported. - [OpenAPI Connectors](https://docs.solace.com/Agent-Mesh/Framework/building/connectors/openapi/index.md): Turns each operation in an OpenAPI 3.0 or 3.1 specification (JSON or YAML) into a tool agents can call; covers authentication options and troubleshooting. OpenAPI 2.0 is not supported. - [Configuring Entrypoints](https://docs.solace.com/Agent-Mesh/Framework/building/entrypoints/index.md): The shared model for every entrypoint type: creating and deploying entrypoints, status fields, drift detection, connection status, credential handling, routing traffic to an agent, and access control. - [Event Mesh Entrypoints](https://docs.solace.com/Agent-Mesh/Framework/building/entrypoints/event-mesh/index.md): Subscribes to event broker topics and dispatches each message to an agent or workflow using event rules; covers system versus data-plane event brokers, payload decoding, targets, identity attribution, acknowledgment policy, and outputs. - [MCP Entrypoints](https://docs.solace.com/Agent-Mesh/Framework/building/entrypoints/mcp/index.md): Exposes agents as MCP tools to clients such as Claude Code and MCP Inspector over Streamable HTTP; covers connecting a client, filtering which agents are exposed, identity under RBAC, and troubleshooting. - [Creating Workflows (Early Access)](https://docs.solace.com/Agent-Mesh/Framework/building/workflows/index.md): A workflow is a directed acyclic graph of typed nodes that runs in a defined order; covers workflow nodes, the two ways to build one (including Quick Build), and viewing and managing workflows. - [Creating Workflows with the CLI (Early Access)](https://docs.solace.com/Agent-Mesh/Framework/building/workflows/cli.md): Authors a workflow as declarative-config YAML, including agent nodes that call existing agents by name and tool nodes that call tools directly, then applies and verifies it. - [Connecting External Agents](https://docs.solace.com/Agent-Mesh/Framework/building/external-agents/index.md): Connects an agent that speaks A2A and runs outside Agent Mesh so peers can delegate to it; covers the three-step connection flow, deploying and managing, and troubleshooting. For a generic HTTP API, use an OpenAPI tool instead. - [Managing Users and Roles](https://docs.solace.com/Agent-Mesh/Framework/building/user-management/index.md): How access resolves through roles (collections of scopes), claim mappings, and direct grants; covers granting a group access to an agent, managing roles, default roles, claim mappings, users, and system users. - [Managing Users and Roles with the CLI](https://docs.solace.com/Agent-Mesh/Framework/building/user-management/cli.md): Authors roles, claim mappings, default roles, and system users as declarative-config YAML; needs the super administrator grant, and is the only way to create a system user. - [Managing Configuration as Code (Early Access)](https://docs.solace.com/Agent-Mesh/Framework/building/declarative-config/index.md): Overview of declarative config, which describes agents, entrypoints, workflows, models, toolsets, and connectors as version-controlled YAML that `sam config plan`, `apply`, and `pull` reconcile with the Platform service. - [The Configuration Repo](https://docs.solace.com/Agent-Mesh/Framework/building/declarative-config/the-config-repo.md): Layout of a declarative-config repo and its resource files: the top-level manifest, one directory per resource kind, the name as the diff key, how resources reference each other, and discovering a kind's fields. - [Planning and Applying Changes](https://docs.solace.com/Agent-Mesh/Framework/building/declarative-config/planning-and-applying.md): The day-to-day `sam config plan` and `apply` workflow, including flags, deleting resources, running in CI and CD, and exit codes and JSON output. ### Using Agent Mesh Working with a running deployment in the Agent Mesh UI: chatting with agents and watching tasks execute. - [Chatting with Agents](https://docs.solace.com/Agent-Mesh/Framework/using-agent-mesh/chatting.md): Covers selecting an agent, sending messages, working with and branching sessions, attaching files, working with artifacts, sharing a session, and giving feedback. - [Monitoring Activity](https://docs.solace.com/Agent-Mesh/Framework/using-agent-mesh/monitoring-activity.md): The Activities page is a live monitor for every running task, with a flow graph, step-by-step view, raw event stream, and Gantt timeline, plus tracing a task end to end and viewing artifacts. ### Evaluating Agent Performance Measure whether agents keep producing the right answers. - [Evaluating Agent Performance](https://docs.solace.com/Agent-Mesh/Framework/evaluating-agent-performance/index.md): Run an agent against a fixed dataset of prompts, score outputs with evaluators, and compare scores across runs, using the `sam eval` CLI or the Platform service evaluations API; clarifies what evaluation is not (observability, a unit-test runner, or a backup). ### Administering Agent Mesh Secure, monitor, and operate a running deployment: pre-production sign-off, access control and SSO, secrets and TLS, observability, and day-two troubleshooting. - [Production Readiness Checklist](https://docs.solace.com/Agent-Mesh/Framework/administering/production-readiness-checklist.md): Yes/no checklist a deployment passes before carrying production traffic, covering topology, authentication and access control, secrets, TLS, persistence and backups, observability, health probes, runbooks, and rollback and upgrade. - [Enabling Role-Based Access Control (RBAC)](https://docs.solace.com/Agent-Mesh/Framework/administering/enabling-rbac.md): RBAC is allowlist only and a fresh deployment is permissive until you turn it on; covers what RBAC gates, trying agent-invocation control without an identity provider, enforcing every surface once SSO is enabled, and system users for machine entrypoints. - [Enabling Single Sign-On (SSO)](https://docs.solace.com/Agent-Mesh/Framework/administering/enabling-sso.md): Configures OpenID Connect login on the Web UI entrypoint; covers the login flow, registering Microsoft Entra ID, Google, Okta, Auth0, or Keycloak, the redirect URI, turning on RBAC after login, verification, and troubleshooting. - [Managing Secrets](https://docs.solace.com/Agent-Mesh/Framework/administering/secrets-management.md): How the runtime reads secrets from the environment or mounted files, `${VAR}` substitution in YAML, the secret-bearing fields to track, rotation procedures for local and Kubernetes deployments, and keeping secrets out of logs. - [Configuring TLS](https://docs.solace.com/Agent-Mesh/Framework/administering/tls.md): Covers the three independent TLS surfaces (the entrypoint HTTP and SSE listener, event broker TLS, and outbound connections to OIDC providers, LLM providers, and MCP servers), trust stores, proxy settings, and troubleshooting certificate errors. - [Monitoring Your Agent Mesh](https://docs.solace.com/Agent-Mesh/Framework/administering/observability.md): Operational logs, OpenTelemetry metrics with a Prometheus /metrics endpoint and optional OTLP exporters, traceID correlation, health endpoints, and shipping telemetry to an aggregator such as Prometheus or Datadog. Agent Mesh does not run a metrics backend. - [Troubleshooting a Running Deployment](https://docs.solace.com/Agent-Mesh/Framework/administering/scenario-troubleshooting.md): Day-two playbook organized by what broke: event broker connectivity failures, executor crash loops, agents that stop serving while the workload reports healthy, persistence-layer failures, and tool execution failures. ### Reference Exact commands, configuration keys, environment variables, chart values, scopes, and tool names. - [CLI Reference](https://docs.solace.com/Agent-Mesh/Framework/reference/cli.md): Every `sam` command and flag, including `sam task send`, `api`, `auth`, `config` (apply, plan, pull, migrate, schema), `eval`, `toolset`, `skill`, and `doctor`, plus global flags. - [Configuration Schema](https://docs.solace.com/Agent-Mesh/Framework/reference/config-schema.md): Reference for the startup YAML files each server process reads (broker, model, and artifact service blocks, entrypoint executor, Platform service, Secure Tool Runtime sandbox, trust and identity, logging), distinguished from declarative configuration. - [Environment Variables](https://docs.solace.com/Agent-Mesh/Framework/reference/env-vars.md): Catalog of environment variables the runtime reads, grouped by concern (runtime, connectivity, LLM providers, storage, authentication, observability, diagnostics, entrypoints), plus the `${VAR}` substitution forms. - [Helm Values Reference](https://docs.solace.com/Agent-Mesh/Framework/reference/helm-values.md): Chart values for Kubernetes deployments, including global settings, event broker, LLM service, tool API keys, service and ingress networking, external datastores, shared volumes, pre-flight check, and the bundled persistence layer and embedded event broker. - [RBAC Reference](https://docs.solace.com/Agent-Mesh/Framework/reference/rbac-reference.md): The scope grammar (three colon-delimited segments), the platform-shipped scope catalog, system users, authoring surfaces such as YAML role files, IdP claim mapping, and diagnosing a denial. - [Built-In Tools](https://docs.solace.com/Agent-Mesh/Framework/reference/built-in-tools.md): Catalog of built-in tools with parameters, return values, and scope requirements, grouped into artifact management, general, image and audio, web and research, data analysis, and document, diagram, and media tools. ### Solace Cloud: Agent Mesh Manager Create, deploy, secure, and manage agent meshes from Solace Cloud, where Solace hosts and manages Agent Mesh Manager. - [Managing Solace Agent Mesh in Solace Cloud](https://docs.solace.com/Agent-Mesh/Cloud/agent-mesh-manager.md): Landing page for Agent Mesh Manager covering prerequisites (Admin or Agent Mesh Manager role, Dedicated Region, enterprise service class event broker service), a six-step getting-started path, and how release schedules and the combined version number work. - [Deploying and Managing Solace Agent Mesh from Solace Cloud](https://docs.solace.com/Agent-Mesh/Cloud/agent-mesh-deployment.md): Architecture and networking: what Solace manages versus what you manage, HTTPS endpoint access on port 443, and outbound connections to the event broker (SMF over TLS), AI model providers, and the IdP. - [Configuring User Access to Agent Mesh](https://docs.solace.com/Agent-Mesh/Cloud/agent-mesh-user-access.md): Covers the Admin and Agent Mesh Manager roles, enabling and disabling SSO per instance (which restarts the instance), and viewing SSO status across all instances. - [Creating an Agent Mesh Instance](https://docs.solace.com/Agent-Mesh/Cloud/create-agent-mesh.md): Steps to create an instance in Agent Mesh Manager, including requirements (Dedicated Region, enterprise service class, same environment as the event broker service), the create form fields, and post-create setup such as configuring AI models. - [Working with Agent Meshes](https://docs.solace.com/Agent-Mesh/Cloud/manage-agent-meshes.md): Day-two management: the Details tab, opening the Agent Mesh UI, editing the name and description, and the undeploy-then-delete flow. ## Solace Insights > Observability and analytics for Solace event brokers. Covers built-in dashboards, Datadog-based advanced monitoring, notifications, metrics forwarding, and monitoring for self-managed brokers. ### Getting Started What Insights offers and the difference between basic and advanced monitoring features. - [Insights Overview](https://docs.solace.com/Cloud/Insights/Insights.md): Introduction to Insights capabilities and feature availability. ### Built-in Dashboards Basic monitoring dashboards available to all Insights subscribers through the Cloud Console. - [Using the Account Overview Dashboard](https://docs.solace.com/Cloud/Insights/account-overview.md): High-level estate status including alerts, warnings, broker counts, and message volumes. - [Using Service-Level Dashboards for Event Broker Services](https://docs.solace.com/Cloud/Insights/insights-servicelevel.md): Per-broker monitoring for message rates, spool usage, and resource utilization. ### Advanced Monitoring Datadog-based monitoring for subscribers with Advanced Monitoring entitlement. Provides estate-wide visibility, customizable dashboards, and pre-configured monitors. - [Solace Insights Advanced Monitoring](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/using-dashboards.md): How to use the predefined Datadog dashboards for estate-wide monitoring. - [Enabling Solace Insights Advanced Monitoring](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/access-datadog.md): Granting user access to the Datadog sub-organization. - [Understanding Solace Insights Dashboards for Advanced Monitoring](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/about-dashboards.md): Detailed descriptions of each predefined dashboard and what metrics they display. - [Extending Advanced Monitoring](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/clone-customization-for-advanced-insights.md): Cloning and customizing dashboards and monitors for your specific needs. ### Monitors and Metrics Reference Reference documentation for the metrics collected and monitors available in Advanced Monitoring. - [Solace Insights Monitors for Datadog Reference](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/insights-monitors.md): All available monitor types including log-based, metric-based, and status-based monitors. - [Insights Metrics Reference](https://docs.solace.com/Cloud/Insights/Advanced-Monitoring/insights-metrics.md): Complete list of metrics collected from event brokers. ### Notifications Configure alerts and integrate with third-party incident management tools. - [Understanding Insights Notifications](https://docs.solace.com/Cloud/Insights/insights-notifications.md): Email alerts, severity levels, and integrations with OpsGenie, PagerDuty, Slack, and ServiceNow. ### Self-Managed Brokers Extend Insights monitoring to software event brokers and appliances outside Solace Cloud. - [Insights for Self-Managed Event Brokers](https://docs.solace.com/Cloud/Insights/insights-self-serve-broker.md): Deploy the Insights Agent to monitor Kubernetes, container, or appliance-based brokers. ### Forwarding and Integration Send Insights data to external observability platforms or integrate with distributed tracing. - [Forwarding Solace Insights Metrics and Logs](https://docs.solace.com/Cloud/Insights/insights_data_forwarding.md): Export to Dynatrace, Splunk, Elasticsearch, New Relic, Prometheus, or OTLP endpoints. - [Sending Application Traces to Insights](https://docs.solace.com/Cloud/DistributedTracing/send-app-trace-insights.md): Integrate application-level distributed traces with Insights. ## Cloud-Managed Micro-Integrations > Micro-Integrations that Solace runs for you in Solace Cloud, which you create, deploy, and monitor in the Solace Cloud Console. #### Micro-Integrations in Solace Cloud > What Micro-Integrations in Solace Cloud are, the types available, and how they are structured. - [Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/managed-micro-integrations-overview.md): Introduces Micro-Integrations in Solace Cloud: the types available, their structure, resource requirements, and how to use them in the Solace Cloud Console. #### Creating Micro-Integrations in Solace Cloud > Create a Micro-Integration, handle failed messages, and map headers and payloads between systems. - [Creating Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/create-micro-integration.md): Walks through creating a Micro-Integration in Solace Cloud, including prerequisites. - [Error Handling for Micro-Integration Flows](https://docs.solace.com/Micro-Integrations/Managed/error-handling.md): Explains how failed messages are resolved in a Micro-Integration flow and how to configure error handling. - [Mapping Headers and Payloads](https://docs.solace.com/Micro-Integrations/Managed/create-message-headers.md): Explains how to map header and payload values between systems, including constants, dynamic values, payloads, and transformations. #### Managing Micro-Integrations in Solace Cloud > Edit, deploy, monitor, and troubleshoot a Micro-Integration after you create it. - [Editing Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/edit-micro-integrations.md): Explains how to change the configuration of an existing Micro-Integration. - [Deploying and Undeploying Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/deploy-micro-integrations.md): Explains deployment states and how to deploy and undeploy a Micro-Integration. - [Monitoring Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/monitor-micro-integrations.md): Explains how to view Micro-Integration metrics to check deployment state and overall health. - [Troubleshooting Micro-Integrations in Solace Cloud](https://docs.solace.com/Micro-Integrations/Managed/managed-micro-integrations-troubleshooting.md): Covers viewing error logs, common issues and solutions, and best practices for diagnosing Micro-Integration problems. #### Connection and Vendor-Specific Configuration > Look up the event broker service connection parameters and the connection and flow parameters for a specific external system. - [Event Broker Service Configuration](https://docs.solace.com/Micro-Integrations/Managed/configure-event-broker-service.md): Describes the event broker service connection parameters and flow parameters you configure for a Micro-Integration. - [Vendor-Specific Configuration](https://docs.solace.com/Micro-Integrations/Managed/create-micro-integration-details.md): Index of the external systems you can configure, each linking to its connection and flow parameters. - [Amazon Bedrock LLM Processor (Beta)](https://docs.solace.com/Micro-Integrations/Managed/mi-details/llm-bedrock.md): Covers Micro-Integration parameters and flow parameters for the Amazon Bedrock LLM Processor (Beta). - [Amazon S3](https://docs.solace.com/Micro-Integrations/Managed/mi-details/awss3.md): Covers connection parameters and flow parameters for the Amazon S3 Micro-Integration. - [Amazon SNS](https://docs.solace.com/Micro-Integrations/Managed/mi-details/awssns.md): Covers connection parameters and flow parameters for the Amazon SNS Micro-Integration. - [Amazon SQS](https://docs.solace.com/Micro-Integrations/Managed/mi-details/awssqs.md): Covers connection parameters and flow parameters for the Amazon SQS Micro-Integration. - [Azure Blob Storage](https://docs.solace.com/Micro-Integrations/Managed/mi-details/azureblobstorage.md): Covers connection parameters and flow parameters for the Azure Blob Storage Micro-Integration. - [Azure Cosmos DB](https://docs.solace.com/Micro-Integrations/Managed/mi-details/cosmosdb.md): Covers connection parameters, flow parameters, and additional properties for the Azure Cosmos DB Micro-Integration. - [Azure Service Bus](https://docs.solace.com/Micro-Integrations/Managed/mi-details/azureservicebus.md): Covers connection parameters and flow parameters for the Azure Service Bus Micro-Integration. - [Databricks Zerobus](https://docs.solace.com/Micro-Integrations/Managed/mi-details/databrickszerobus.md): Covers prerequisites, connection parameters, flow parameters, monitoring with Databricks system tables, and troubleshooting for the Databricks Zerobus Micro-Integration. - [Google Cloud Pub/Sub](https://docs.solace.com/Micro-Integrations/Managed/mi-details/googlepubsub.md): Covers connection parameters and flow parameters for the Google Cloud Pub/Sub Micro-Integration. - [Google Cloud Storage](https://docs.solace.com/Micro-Integrations/Managed/mi-details/google-storage.md): Covers connection parameters and flow parameters for the Google Cloud Storage Micro-Integration. - [IBM Db2 Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-db2cdc.md): Covers connection parameters, flow parameters, and additional properties for the IBM Db2 Bulk CDC Micro-Integration. - [IBM Db2 CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/db2cdc.md): Covers connection parameters, flow parameters, and additional properties for the IBM Db2 CDC Micro-Integration. - [IBM MQ](https://docs.solace.com/Micro-Integrations/Managed/mi-details/ibmmq.md): Covers connection parameters and flow parameters for the IBM MQ Micro-Integration. - [LLM Processor (Beta)](https://docs.solace.com/Micro-Integrations/Managed/mi-details/llm-openai.md): Covers Micro-Integration parameters and flow parameters for the LLM Processor (Beta). - [Microsoft SQL Server](https://docs.solace.com/Micro-Integrations/Managed/mi-details/sqlserver.md): Covers prerequisites, connection parameters, flow parameters, and troubleshooting for the Microsoft SQL Server Micro-Integration. - [Microsoft SQL Server Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-sqlservercdc.md): Covers connection parameters, flow parameters, and additional properties for the Microsoft SQL Server Bulk CDC Micro-Integration. - [Microsoft SQL Server CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/sqlservercdc.md): Covers connection parameters, flow parameters, and additional properties for the Microsoft SQL Server CDC Micro-Integration. - [MongoDB](https://docs.solace.com/Micro-Integrations/Managed/mi-details/mongodb.md): Covers prerequisites, connection parameters, flow parameters, supported payload types, and troubleshooting for the MongoDB Micro-Integration. - [MongoDB Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-mongodbcdc.md): Covers connection parameters, flow parameters, and additional properties for the MongoDB Bulk CDC Micro-Integration. - [MongoDB CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/mongodbcdc.md): Covers connection parameters, flow parameters, and additional properties for the MongoDB CDC Micro-Integration. - [MQTT](https://docs.solace.com/Micro-Integrations/Managed/mi-details/mqtt.md): Covers connection parameters and flow parameters for the MQTT Micro-Integration. - [MySQL Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-mysqlcdc.md): Covers connection parameters, flow parameters, and additional properties for the MySQL Bulk CDC Micro-Integration. - [MySQL CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/mysqlcdc.md): Covers connection parameters, flow parameters, and additional properties for the MySQL CDC Micro-Integration. - [Oracle AQ](https://docs.solace.com/Micro-Integrations/Managed/mi-details/oracleaq.md): Covers connection parameters and flow parameters for the Oracle AQ Micro-Integration. - [Oracle Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-oraclecdc.md): Covers prerequisites, Oracle datatype handling, connection parameters, flow parameters, additional properties, and troubleshooting for the Oracle Bulk CDC Micro-Integration. - [Oracle CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/oraclecdc.md): Covers prerequisites, Oracle datatype handling, connection parameters, flow parameters, additional properties, and troubleshooting for the Oracle CDC Micro-Integration. - [PostgreSQL](https://docs.solace.com/Micro-Integrations/Managed/mi-details/postgresql.md): Covers prerequisites, connection parameters, flow parameters, and troubleshooting for the PostgreSQL Micro-Integration. - [PostgreSQL Bulk CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/bulk-postgrescdc.md): Covers connection parameters, flow parameters, and additional properties for the PostgreSQL Bulk CDC Micro-Integration. - [PostgreSQL CDC](https://docs.solace.com/Micro-Integrations/Managed/mi-details/postgrescdc.md): Covers connection parameters, flow parameters, and additional properties for the PostgreSQL CDC Micro-Integration. - [Qdrant (Beta)](https://docs.solace.com/Micro-Integrations/Managed/mi-details/qdrant.md): Covers connection parameters for the Qdrant (Beta) Micro-Integration. - [Salesforce](https://docs.solace.com/Micro-Integrations/Managed/mi-details/salesforce.md): Covers connection parameters, flow parameters, the platform event schema and payload format, testing, and troubleshooting for the Salesforce Micro-Integration. - [SFTP](https://docs.solace.com/Micro-Integrations/Managed/mi-details/sftp.md): Covers connection parameters and flow parameters for the SFTP Micro-Integration. - [Snowflake](https://docs.solace.com/Micro-Integrations/Managed/mi-details/snowflake.md): Covers prerequisites, connection parameters, flow parameters, and troubleshooting for the Snowflake Micro-Integration. - [Solace Transform Processor](https://docs.solace.com/Micro-Integrations/Managed/mi-details/messagetransformprocessor.md): Covers Micro-Integration parameters and flow parameters for the Solace Transform Processor. #### Message Header and Transformation Function Reference > How message headers map between external systems and event broker services, plus the available transformation functions. - [Message Header Reference](https://docs.solace.com/Micro-Integrations/Managed/mi-ref/message-header-ref.md): Explains how message headers map between external systems and event broker services. The headers you can map depend on the external system. - [Transformation Function Reference](https://docs.solace.com/Micro-Integrations/Managed/mi-ref/transformation-function-ref.md): Reference for the functions you can use in transformation expressions to modify header or payload data. ## Self-Managed Micro-Integrations > Micro-Integrations that you deploy and operate yourself in your own environment, with configuration reference for each supported external system. #### Understand Self-Managed Micro-Integrations > What a self-managed Micro-Integration is, how it is structured, what resources it needs, and how to try one end to end. - [Self-Managed Micro-Integrations](https://docs.solace.com/Micro-Integrations/Self-Managed/self-managed-micro-integrations.md): Introduces self-managed Micro-Integrations, how to run and manage them, where to download them, and license and support information. - [Self-Managed Micro-Integration Architecture](https://docs.solace.com/Micro-Integrations/Self-Managed/MI-Architecture-and-Capabilities.md): Explains how a self-managed Micro-Integration is structured, including workflows, binders, and bindings. - [Resource Requirements for Self-Managed Micro-Integrations](https://docs.solace.com/Micro-Integrations/Self-Managed/Connectors-Resource-Requirements.md): Lists the hosting resources a self-managed Micro-Integration needs to reach the performance and throughput you want. - [Try a Micro-Integration](https://docs.solace.com/Micro-Integrations/Self-Managed/Getting-Started-Message-Transform.md): Tutorial that deploys a Transform Processor end to end: prerequisites, application.yml configuration, deployment, and verification. #### Configure Your Self-Managed Micro-Integration > Set up the event broker connection and Spring settings that every self-managed Micro-Integration needs before you add vendor details. - [Configure Your Self-Managed Micro-Integration](https://docs.solace.com/Micro-Integrations/Self-Managed/Configure-Datapath.md): Starting point for configuring a self-managed Micro-Integration, with the ordered configuration steps. - [Event Broker Prerequisites](https://docs.solace.com/Micro-Integrations/Self-Managed/Event-Broker-Prerequisites.md): Lists what must be in place on the event broker before you configure the Micro-Integration's connection to it. - [Understanding the application.yml File](https://docs.solace.com/Micro-Integrations/Self-Managed/application-yml.md): Explains the application.yml file, the single Spring Boot configuration file that controls the event broker connection, the vendor system connection, and other settings. - [Spring Profiles and Property File Locations](https://docs.solace.com/Micro-Integrations/Self-Managed/Connector-Configuration.md): Describes Spring profiles and where the Micro-Integration looks for Spring property files. - [Step 1: Connecting to Your Event Broker](https://docs.solace.com/Micro-Integrations/Self-Managed/Event-Broker-Connection-Details.md): Configures the Micro-Integration's connection to the event broker, including named binders, authentication, TLS, reconnection, and connection validation. - [Step 2: Configuring the Spring Cloud Stream Binder](https://docs.solace.com/Micro-Integrations/Self-Managed/Spring-Configuration.md): Describes the Spring Cloud Stream Binder for Solace options, the Micro-Integration defaults that override binder defaults, and other Spring Boot libraries you can use. #### Vendor-Specific Configuration > Find the Micro-Integration for a specific external system. Each Overview page links to that system's connection details, message headers, and related pages. - [Step 3: Vendor-Specific Configuration for Self-Managed Micro-Integrations](https://docs.solace.com/Micro-Integrations/Self-Managed/Vendor-Specific-Connector-Config.md): Index of the external systems that have a Micro-Integration, each linking to its Overview page. - [Connector for Apache Spark](https://docs.solace.com/Micro-Integrations/Self-Managed/Spark/Spark-Overview.md): Overview of the Connector for Apache Spark, including supported Apache Spark releases and prerequisites, with links to its connection details, migration guide, and troubleshooting pages. - [Micro-Integration for Amazon S3](https://docs.solace.com/Micro-Integrations/Self-Managed/AWS-S3/AWS-S3-Overview.md): Overview of the Amazon S3 Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Amazon SNS](https://docs.solace.com/Micro-Integrations/Self-Managed/AWS-SNS/AWSSNS-Overview.md): Overview of the Amazon SNS Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message headers, and health pages. - [Micro-Integration for Amazon SQS](https://docs.solace.com/Micro-Integrations/Self-Managed/AWS-SQS/AWSSQS-Overview.md): Overview of the Amazon SQS Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message headers, and health pages. - [Micro-Integration for Azure Blob Storage](https://docs.solace.com/Micro-Integrations/Self-Managed/Azure-Blob/Azure-Blob-Overview.md): Overview of the Azure Blob Storage Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Azure Service Bus](https://docs.solace.com/Micro-Integrations/Self-Managed/Azure-Service-Bus/AzureServiceBus-Overview.md): Overview of the Azure Service Bus Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Azure Cosmos DB](https://docs.solace.com/Micro-Integrations/Self-Managed/CosmosDB/CosmosDB-Overview.md): Overview of the Azure Cosmos DB Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Databricks Zerobus](https://docs.solace.com/Micro-Integrations/Self-Managed/Databricks-Zerobus/Databricks-Zerobus-Overview.md): Overview of the Databricks Zerobus Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, troubleshooting, and message headers pages. - [Micro-Integration for Google Cloud Pub/Sub](https://docs.solace.com/Micro-Integrations/Self-Managed/GooglePubSub/GCP-PubSub-Overview.md): Overview of the Google Cloud Pub/Sub Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message headers, and health pages. - [Micro-Integration for Google Cloud Storage](https://docs.solace.com/Micro-Integrations/Self-Managed/Google-Cloud/Google-Cloud-Overview.md): Overview of the Google Cloud Storage Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for IBM Db2 Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkDb2CDC/BulkDb2CDC-Overview.md): Overview of the IBM Db2 Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for IBM Db2 CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/Db2CDC/Db2CDC-Overview.md): Overview of the IBM Db2 CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for IBM MQ](https://docs.solace.com/Micro-Integrations/Self-Managed/IBM-MQ/IBMMQ-Overview.md): Overview of the IBM MQ Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, message headers, and health pages. - [Micro-Integration for JMS](https://docs.solace.com/Micro-Integrations/Self-Managed/JMS/JMS-Overview.md): Overview of the JMS Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, message headers, and health pages. - [Micro-Integration for Microsoft SQL Server Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkSQLServerCDC/BulkSQLServerCDC-Overview.md): Overview of the Microsoft SQL Server Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Microsoft SQL Server CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/SQLServerCDC/SQLServerCDC-Overview.md): Overview of the Microsoft SQL Server CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for MongoDB Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkMongoDBCDC/BulkMongoDBCDC-Overview.md): Overview of the MongoDB Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for MongoDB CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/MongoDBCDC/MongoDBCDC-Overview.md): Overview of the MongoDB CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for MongoDB](https://docs.solace.com/Micro-Integrations/Self-Managed/MongoDB/MongoDB-Overview.md): Overview of the MongoDB Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, troubleshooting, and message headers pages. - [Micro-Integration for MQTT](https://docs.solace.com/Micro-Integrations/Self-Managed/MQTT/MQTT-Overview.md): Overview of the MQTT Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for MySQL Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkMySQLCDC/BulkMySQLCDC-Overview.md): Overview of the MySQL Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for MySQL CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/MySQLCDC/MySQLCDC-Overview.md): Overview of the MySQL CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. - [Micro-Integration for Oracle AQ](https://docs.solace.com/Micro-Integrations/Self-Managed/Oracle-AQ/OracleAQ-Overview.md): Overview of the Oracle AQ Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, message headers, and health pages. - [Micro-Integration for Oracle Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkOracleCDC/BulkOracleCDC-Overview.md): Overview of the Oracle Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, troubleshooting, and message headers pages. - [Micro-Integration for Oracle CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/OracleCDC/OracleCDC-Overview.md): Overview of the Oracle CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, troubleshooting, and message headers pages. - [Micro-Integration for PostgreSQL](https://docs.solace.com/Micro-Integrations/Self-Managed/PostgreSQL/PostgreSQL-Overview.md): Overview of the PostgreSQL Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, troubleshooting, and message headers pages. - [Micro-Integration for PostgreSQL Bulk CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/BulkPostgresCDC/BulkPostgresCDC-Overview.md): Overview of the PostgreSQL Bulk CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for PostgreSQL CDC](https://docs.solace.com/Micro-Integrations/Self-Managed/PostgresCDC/PostgresCDC-Overview.md): Overview of the PostgreSQL CDC Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Salesforce](https://docs.solace.com/Micro-Integrations/Self-Managed/Salesforce/Salesforce-Overview.md): Overview of the Salesforce Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, troubleshooting, and message headers pages. - [Micro-Integration for SFTP](https://docs.solace.com/Micro-Integrations/Self-Managed/SFTP/SFTP-Overview.md): Overview of the SFTP Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, and message headers pages. - [Micro-Integration for Microsoft SQL Server](https://docs.solace.com/Micro-Integrations/Self-Managed/SQL-Server/SQL-Server-Overview.md): Overview of the Microsoft SQL Server Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, troubleshooting, and message headers pages. - [Micro-Integration for Snowflake](https://docs.solace.com/Micro-Integrations/Self-Managed/Snowflake/Snowflake-Overview.md): Overview of the Snowflake Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, binding configuration, prerequisites, troubleshooting, and message headers pages. - [Micro-Integration for TIBCO EMS](https://docs.solace.com/Micro-Integrations/Self-Managed/TibcoEMS/TibcoEMS-Overview.md): Overview of the TIBCO EMS Micro-Integration, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, message headers, and health pages. - [Transform Processor](https://docs.solace.com/Micro-Integrations/Self-Managed/Message-Processor/Message-Processor-Overview.md): Overview of the Transform Processor, with links to its connection details, dynamic producer destinations, asynchronous publishing, message batching, and message headers pages. #### Workflows, Error Handling, and Security > Define workflows and message mappings, handle failed messages, secure the management endpoints, and check health. - [Step 4: Enabling Workflows](https://docs.solace.com/Micro-Integrations/Self-Managed/Enabling-Workflows.md): Explains workflows, the configuration that defines how data flows between a source and a target, and the workflow configuration options. - [Mapping Message Headers and Payloads](https://docs.solace.com/Micro-Integrations/Self-Managed/Message-transforms.md): Explains how to map header and payload values between source and target systems, including payload content types, transformation expressions, and examples. - [Transformation Function Reference](https://docs.solace.com/Micro-Integrations/Self-Managed/Transformation-functions.md): Reference for the functions you can use in transformation expressions to modify header or payload data. - [Step 5: Error Handling](https://docs.solace.com/Micro-Integrations/Self-Managed/Error-Handling.md): Explains how failed messages are resolved and how to configure error handling to protect against data loss. - [Step 6: Securing Management Web Endpoints](https://docs.solace.com/Micro-Integrations/Self-Managed/Security.md): Explains how to configure authentication, authorization, and TLS for the management web endpoints the Micro-Integration exposes. - [Step 7: Configuring and Using the Health Endpoint](https://docs.solace.com/Micro-Integrations/Self-Managed/Connector-Health.md): Describes the Spring Boot Actuator health endpoint and the workflow, Solace binder, and third-party binder health it reports. #### Operate Your Self-Managed Micro-Integration > Deploy and run a Micro-Integration as a container or JAR, manage workflows, set up redundancy, and use Micro-Integration Manager. - [Operate Your Self-Managed Micro-Integration](https://docs.solace.com/Micro-Integrations/Self-Managed/Manage-Deploy.md): Starting point for deploying and running a Micro-Integration as a container or JAR, or with Micro-Integration Manager. - [Micro-Integration Manager](https://docs.solace.com/Micro-Integrations/Self-Managed/Connector-Manager/connector-manager.md): Describes Micro-Integration Manager, which manages and monitors Micro-Integrations, including how to install and configure it. - [Solace Micro-Integration Manager Example](https://docs.solace.com/Micro-Integrations/Self-Managed/Connector-Manager/connector-manager-example.md): Walks through the example configurations and shell scripts distributed with Micro-Integration Manager. - [Deploying Your Self-Managed Micro-Integration](https://docs.solace.com/Micro-Integrations/Self-Managed/connectors-get-started.md): Quick-start guide for running a self-managed Micro-Integration as a container, from the command line, or with the start.sh script. - [Modifying the Container Configuration](https://docs.solace.com/Micro-Integrations/Self-Managed/Container-Config.md): Describes the container settings you can change, including access to services on the host, health checks, JVM options, and volumes. - [Managing Workflows](https://docs.solace.com/Micro-Integrations/Self-Managed/Workflow-Management.md): Describes the workflow management endpoint and workflow states, which you use to manage workflows. - [Redundancy Configuration](https://docs.solace.com/Micro-Integrations/Self-Managed/Leader-Election.md): Explains the redundancy modes (standalone, active-active, and active-standby), the leader election management endpoint, and its configuration properties. - [Adding External Libraries](https://docs.solace.com/Micro-Integrations/Self-Managed/Add-External-Libraries.md): Explains how to add external libraries, such as payload classes for object messages, to the Micro-Integration's classpath. #### Monitor Your Self-Managed Micro-Integration > Monitor the health, state, and performance of a running Micro-Integration. - [Monitor Your Self-Managed Micro-Integration](https://docs.solace.com/Micro-Integrations/Self-Managed/Monitoring.md): Starting point for monitoring the health and performance of a running Micro-Integration with Spring Boot features. - [Monitoring the Self-Managed Micro-Integration's State](https://docs.solace.com/Micro-Integrations/Self-Managed/Connector-States.md): Explains how to monitor the Micro-Integration's internal state and get build information through Spring Boot Actuator endpoints. ## Sending and Receiving Messages > Core messaging concepts that apply across all APIs and protocols. Covers how messages flow through event brokers, topic support and syntax, Direct versus Guaranteed messaging, substitution expressions, and connection compression. #### Messaging Overview > How event messages move through event brokers, how persistent and non-persistent event streams differ, and how delivery resources are managed. - [Sending and Receiving Messages](https://docs.solace.com/Messaging/messaging-lp.md): Landing page for in-depth information on topics and messaging in Solace, which provides high-performance event message routing for event-driven architectures. - [Event Messaging Overview](https://docs.solace.com/Messaging/messaging-overview.md): Explains how event messages move through Solace event brokers, including topics, Direct and Guaranteed messaging, persistence and durability, and messaging patterns. - [Event Streaming Flows](https://docs.solace.com/Messaging/Event-Stream-Maps.md): Explains how an event broker separates events into non-persistent and persistent streams based on the Quality of Service the producer requires, and how messages are replayed. #### Topics and Subscriptions > Topic syntax, wildcards, and design guidance, and how reserved topics, delivery modes, and subscription capacity work. - [Topic Support & Syntax](https://docs.solace.com/Messaging/Topic-Support-and-Syntax.md): Describes the topic syntax Solace supports and gives examples of valid topics for publishing and subscribing to events. - [Topic Architecture Best Practices](https://docs.solace.com/Messaging/Topic-Architecture-Best-Practices.md): Covers topic architecture definitions, a topic taxonomy example, the benefits of a rich topic architecture, best practices for designing a topic hierarchy, and anti-patterns. - [Topic Architecture Case Studies](https://docs.solace.com/Messaging/topic-use-cases.md): Presents case studies that apply topic architecture best practices, including event-driven microservices, integration, IoT devices, and data ingestion and distribution. - [Solace Message Format Topics](https://docs.solace.com/Messaging/SMF-Topics.md): Describes topics in Solace Message Format (SMF), the underlying messaging protocol for Solace. - [Wildcard Characters in Topic Subscriptions](https://docs.solace.com/Messaging/Wildcard-Charaters-Topic-Subs.md): Explains the * and > wildcards in SMF topic subscriptions, their restrictions, and examples of the matches they produce. - [Reserved Topics](https://docs.solace.com/Messaging/Reserved-Topics.md): Describes the reserved topics, each beginning with the # character, that Solace uses to implement specific messaging features. - [Topic Matching and Message Delivery Modes](https://docs.solace.com/Messaging/Guaranteed-Msg/Topic-Matching-and-Delivery-Modes.md): Explains how an event broker using Guaranteed messaging can change the delivery mode of messages published to a topic to meet the persistence requirements of an endpoint or Direct client, with examples. - [Subscription Capacity](https://docs.solace.com/Messaging/subscription-capacity.md): Describes the three subscription capacity levels (50k, 500k, and 5M), how to monitor usage, how to assign limits to Message VPNs or clients, and event mesh considerations. #### Direct Messaging > How Direct messaging works and how to send a message to a single client. - [Direct Messages](https://docs.solace.com/Messaging/Direct-Msg/Direct-Messages.md): Explains Direct messaging, the default delivery system, which provides reliable but not guaranteed delivery with no spooling or acknowledgment. Covers when to use it (very high message rates, low latency, tolerance for message loss), shared subscriptions for load balancing, message eliding, and client subscription management. - [Deliver-To-One](https://docs.solace.com/Messaging/Direct-Msg/DTO.md): Explains Deliver-To-One (DTO), which lets a client send a Direct message to a single client even when several clients have matching subscriptions, including how to control DTO message reception. #### Guaranteed Messaging Concepts > How Guaranteed messaging works, including endpoints, queues, spooling, acknowledgments, transactions, and outage protection. - [Guaranteed Messages](https://docs.solace.com/Messaging/Guaranteed-Msg/Guaranteed-Messages.md): Explains Guaranteed messaging, which spools messages to persistent storage so delivery succeeds even when a receiver is offline or network equipment fails, and covers the persistent and non-persistent delivery modes. Includes use cases: message request queues, buffering for slow consumers, and request/reply with temporary queues. - [Guaranteed Messaging Operation](https://docs.solace.com/Messaging/Guaranteed-Msg/Basic-Guaranteed-Messsaging-Operation.md): Explains how Guaranteed messages move from a publisher through the event broker to a consumer, including sessions and consumer flows, publishing, receiving, and queuing limits. - [Queues and Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Endpoints.md): Describes queues and topic endpoints, the endpoint types that receive, store, and deliver Guaranteed messages, and recommends queues for most applications and topic endpoints only for JMS applications. Covers durable and temporary endpoints, topic subscriptions and subscription exceptions, endpoint permissions and access control, and selectors. - [Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Queues.md): Describes queues, the recommended endpoint for most applications, and their access types: exclusive queues deliver messages in order to a single active consumer, while non-exclusive queues share messages among multiple consumers, with round-robin delivery and possible out-of-order redelivery. Also covers well-known and anonymous queues, dead message queues, last value queues, queue browsing, and partitioned queues. - [Message Distribution with Partitioned Queues](https://docs.solace.com/Messaging/Guaranteed-Msg/Partitioned-Queue-Messaging.md): Explains how event brokers distribute messages to partitioned queues using a partition key, and how to publish to and consume from them. - [Topic Endpoints](https://docs.solace.com/Messaging/Guaranteed-Msg/Topic-Endpoints.md): Describes topic endpoints, which attract messages published to a topic that matches the endpoint's subscription. - [Endpoint Templates](https://docs.solace.com/Messaging/Guaranteed-Msg/Endpoint-Templates.md): Describes endpoint templates, configurable objects that apply custom attributes to new client-created endpoints, and which endpoints use them. - [Message Spooling](https://docs.solace.com/Messaging/Guaranteed-Msg/Message-Spooling.md): Explains how an event broker spools, delivers, and acknowledges Guaranteed messages, including the checks that cause a message to be rejected and how the publisher is notified. Covers spool files, windowed acknowledgment, delivered-but-unacknowledged message limits, message expiry (TTL), and default maximum spool usage values. - [Guaranteed Messaging Acknowledgments](https://docs.solace.com/Messaging/Guaranteed-Msg/guaranteed-messaging-acknowledgments.md): Explains how Guaranteed messaging uses ACKs and NACKs between producers, consumers, and the event broker. - [Message Priority](https://docs.solace.com/Messaging/Guaranteed-Msg/Message-Priority.md): Explains how queues and topic endpoints can respect message priority, the priority levels, and considerations when you enable it. - [Delayed Delivery](https://docs.solace.com/Messaging/Guaranteed-Msg/Delayed-Delivery.md): Explains how to add a configurable time delay between publishing a message and delivering it to a consumer. - [Head-of-Line Blocking](https://docs.solace.com/Messaging/Guaranteed-Msg/HOL-blocking.md): Explains head-of-line blocking and how to prevent it. - [Transactions](https://docs.solace.com/Messaging/Guaranteed-Msg/Transactions.md): Explains how transactions group Guaranteed messages so they are published, consumed, or both as one atomic unit of work. - [Service Outage Protection](https://docs.solace.com/Messaging/Guaranteed-Msg/Service-Outage-Protection.md): Describes the features that protect Guaranteed messaging when an event broker or an entire data center goes out of service: redundancy, replication, and Config-Sync. #### Configuring Guaranteed Messaging > Configure and view Guaranteed messaging on an event broker, including queues, topic endpoints, dead message queues, endpoint templates, and appliance external disk arrays. - [Guaranteed Messaging Configuration](https://docs.solace.com/Messaging/Guaranteed-Msg/Managing-Guaranteed-Messaging.md): Introduces configuring and managing Guaranteed messaging, including feature interoperability limitations and parameters to consider when provisioning endpoints. - [Configuring Guaranteed Messaging](https://docs.solace.com/Messaging/Guaranteed-Msg/Configuring-Guaranteed-Msging.md): Lists the event broker configuration steps that let clients publish and receive Guaranteed messages, including transaction configuration and a CLI command example. - [System-Level Message Spool Configuration](https://docs.solace.com/Messaging/Guaranteed-Msg/System-Level-Msg-Spool-Config.md): Describes the system-level message spool parameters you can configure, including external disk arrays, event thresholds, maximum spool and cache usage, the active/active HA role, and the internal disk. - [System-Level Subscription Exception Configuration](https://docs.solace.com/Messaging/Guaranteed-Msg/System-Level-Subscription-Exception-Config.md): Explains how to enable or disable subscription exceptions for an event broker. - [Message VPN-Level Guaranteed Messaging Configuration](https://docs.solace.com/Messaging/Guaranteed-Msg/VPN-Level-Msg-Spool-Config.md): Describes the Guaranteed messaging parameters you configure for a Message VPN, including event thresholds and the maximum numbers of flows, endpoints, transactions, and transacted sessions. - [Configuring Queues Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-queues-broker-manager.md): Explains how to create a queue, add subscriptions to it, and configure advanced queue options in Broker Manager. - [Configuring Partitioned Queues Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-partitioned-queues.md): Explains how to create a partitioned queue and add or remove partitions in Broker Manager. - [Configuring Dead Message Queues Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-dmqs-broker-manager.md): Explains considerations for dead message queues and how to configure one in Broker Manager. - [Configuring Topic Endpoints Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-topic-endpoints.md): Explains how to configure a topic endpoint, which attracts Guaranteed messages for a single topic, in Broker Manager. - [Configuring Endpoint Templates Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-endpoint-templates-broker-manager.md): Explains how to create an endpoint template in Broker Manager. - [Viewing Guaranteed Messaging Data Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/viewing-endpoint-data.md): Explains how to view endpoint data, information about queued messages, and endpoint statistics in Broker Manager. #### Maintaining Guaranteed Messaging > Perform message spool administration, defragmentation, and disk migration tasks. - [Maintaining Guaranteed Messaging](https://docs.solace.com/Messaging/Guaranteed-Msg/Maintaining-Guaranteed-Messaging.md): Introduces message spool administration tasks at the system and Message VPN levels. - [System-level Message Spool Administration](https://docs.solace.com/Messaging/Guaranteed-Msg/Sys-Level-Msg-Spool-Admin-Tasks.md): Describes system-level message spool administration tasks, including asserting disk ownership, backing up the ADB to disk, troubleshooting flash card failures, resetting the spool, and specifying next message IDs. - [Message VPN-Level Message Spool Administration](https://docs.solace.com/Messaging/Guaranteed-Msg/VPN-Level-Msg-Spool-Admin-Tasks.md): Describes Message VPN-level message spool tasks, including deleting messages, copying a message between endpoints, and changing the starting numbers for sequenced topics. - [Defragmenting the Guaranteed Messaging Spool](https://docs.solace.com/Messaging/Guaranteed-Msg/Defragmenting-Guaranteed-Messaging.md): Explains how to defragment the Guaranteed messaging spool files, manually or automatically, when consumers that went offline leave the files fragmented. #### Substitution Expressions and Compressed Connections > How substitution expressions work and how to use streaming compressed connections. - [Substitution Expressions Overview](https://docs.solace.com/Messaging/Substitution-Expressions-Overview.md): Explains substitution expressions, a Solace-specific expression language that replaces text attributes with system-generated output, including functions, processing examples, and the attributes that can contain them. - [Streaming Compressed Connections](https://docs.solace.com/Messaging/Message-Compression.md): Explains streaming compressed connections, which reduce the size of message data frames to cut transmission time over a network link. - [Using Streaming Compressed Connections](https://docs.solace.com/Messaging/Using-Message-Compresssion.md): Explains how to configure and monitor streaming compressed connections for data connections. ## Message VPNs Feature for Event Brokers > Creating, configuring, moving, monitoring, and backing up the Message VPNs that partition an event broker into isolated messaging domains. - [Message VPNs](https://docs.solace.com/Features/VPN/Managing-Message-VPNs.md): How Message VPNs virtualize an event broker into isolated messaging domains, and their default configuration and behavior. - [Managing Message VPNs Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/message-vpn-settings-broker-manager.md): How to view Message VPN details and configure VPN settings, protocol services, and a forward proxy through the Broker Manager UI. - [Configuring Message VPNs Using the CLI](https://docs.solace.com/Features/VPN/Configuring-VPNs.md): CLI reference for creating and configuring Message VPNs, including authentication, services, and replication. - [Moving Message VPN Configurations Between Event Brokers](https://docs.solace.com/Features/VPN/Moving-VPN-Configs-Between-Routers.md): How to move an individual Message VPN configuration from one event broker to another using show current-config and a source script. - [Monitoring VPN Configurations and Stats](https://docs.solace.com/Features/VPN/Monitoring-VPN-Stats.md): The show message-vpn command and its parameters for viewing VPN configuration, statistics, and replication statistics. - [CLI Steps to Set Up Message VPNs With Client Profiles](https://docs.solace.com/Features/VPN/CLI-Sequence-VPN-to-C-Profiles.md): Worked example designating a management VPN, enabling syslog event publishing, and activating VPNs with client profiles. - [Backing Up and Restoring Message VPNs](https://docs.solace.com/Features/VPN/Backing-Up-and-Restoring-VPNs.md): How to back up and restore individual Message VPN configurations on the same or a different event broker. ## Event Broker Redundancy for High Availability Feature for Event Brokers > Deploying and maintaining HA for fault tolerance: redundant pairs for appliances, redundancy groups for software brokers. - [Event Broker Redundancy for High Availability](https://docs.solace.com/Features/HA-Redundancy/Redundancy-and-Fault-Tolerance-Overview.md): Overview of HA redundancy for appliance and software event brokers, linking the appliance and software HA topics. ### Appliance High Availability Configuring and maintaining active/standby and active/active appliance HA pairs. - [High Availability for Appliance Event Brokers](https://docs.solace.com/Features/HA-Redundancy/Appliance-Redundancy-and-Fault-Tolerance.md): Appliance HA concepts such as active/standby and active/active models, VRRP, and failover. - [HA Configuration for Appliance Event Brokers](https://docs.solace.com/Features/HA-Redundancy/Managing-Appliance-Redundancy.md): Prerequisites and requirements for configuring two appliance event brokers as an HA redundant pair. - [Configuring Redundancy Parameters](https://docs.solace.com/Features/HA-Redundancy/Configuring-Appliance-Redundancy-Parameters.md): How to configure appliance redundancy parameters such as auto-revert, failover criteria, and VRRP VRIDs. - [Active/Standby Pairs](https://docs.solace.com/Features/HA-Redundancy/Active-Standby-HA-Appliances.md): How to configure primary and backup appliances for active/standby HA, with a parameter-match table. - [Active/Active Pairs](https://docs.solace.com/Features/HA-Redundancy/Active-Active-HA-Appliances.md): How to configure two appliances as an active/active HA pair, with a parameter-match table. - [Enabling Guaranteed Messaging for HA Appliance Event Brokers](https://docs.solace.com/Features/HA-Redundancy/Enable-G-Msg-HA-Appliance.md): How to enable Guaranteed Messaging and Config-Sync on an active/standby HA appliance pair, including WWN and pre-shared keys. - [Changing the VRID for Active/Standby Appliance Event Broker HA Pairs](https://docs.solace.com/Features/HA-Redundancy/Changing-VRID-for-HA-Appliances.md): How to change the VRID of an active/standby HA appliance pair, including redundancy and message-spool shutdown steps. - [Changing MSG-Backbone IP VRFs for HA Appliance Event Brokers](https://docs.solace.com/Features/HA-Redundancy/Changing-IP-VRF-MSG-Backbone-HA.md): How to migrate the message-backbone IP address/subnet of an HA appliance pair, with interface reconfiguration and verification. - [Adding Redundancy Interfaces to an HA Pair](https://docs.solace.com/Features/HA-Redundancy/Add-Redundancy-Interface-HA-Pair.md): How to add a second redundancy interface to each appliance in an existing HA pair without losing client service. - [Removing Backup Appliance Event Broker from HA Pair](https://docs.solace.com/Features/HA-Redundancy/Removing-One-Appliance-from-an-HA-Pair.md): How to remove the backup appliance from an HA pair, including message-spool shutdown and redundancy configuration removal. ### Software Event Broker High Availability Configuring and maintaining software event broker HA redundancy groups. - [High Availability for Software Event Brokers](https://docs.solace.com/Features/HA-Redundancy/SW-Broker-Redundancy-and-Fault-Tolerance.md): Software event broker HA redundancy groups with active/standby messaging nodes and a monitoring node, plus failover. - [HA Group Configuration](https://docs.solace.com/Features/HA-Redundancy/Configuring-HA-Groups.md): How to set up a software event broker HA redundancy group, including Guaranteed Messaging and Config-Sync. - [Pre-Shared Authentication Keys for Software Event Brokers](https://docs.solace.com/Features/HA-Redundancy/Pre-Shared-Keys-SMB.md): How to generate, configure, and change the pre-shared keys that authenticate connections between HA group members. - [Replacing Nodes in Software Event Broker HA Redundancy Groups](https://docs.solace.com/Features/HA-Redundancy/Replacing-SW-EventBroker-Nodes.md): How to replace primary, backup, and monitoring nodes in a software event broker HA redundancy group via the CLI. ### Monitoring and Maintaining Redundancy Checking redundancy state and performing common HA maintenance across broker types. - [Monitoring Redundancy](https://docs.solace.com/Features/HA-Redundancy/Monitoring-SW-Broker-Redundancy.md): The show redundancy CLI commands for viewing the configuration and state of event brokers in HA deployments. - [Maintaining Event Broker Redundancy](https://docs.solace.com/Features/HA-Redundancy/Maintaining-Event-Broker-Redundancy-All-Broker.md): Common HA maintenance such as starting/stopping redundancy, reverting activity, and auto-revert. ## Synchronizing High Availability Deployments Feature for Event Brokers > Using Config-Sync to automatically propagate configuration between HA pairs and replication mates. - [Config-Sync](https://docs.solace.com/Features/Config-Sync/Config-Sync-Overview.md): How Config-Sync automatically propagates system-level and Message VPN configuration between HA pairs and replication mates. - [Config-Sync Configuration](https://docs.solace.com/Features/Config-Sync/Configuring-Config-Sync.md): How to enable Config-Sync, assert leader configurations, synchronize client certificates, and troubleshoot out-of-sync brokers. ## Data Center Replication for Disaster Recovery Feature for Event Brokers > Replicating guaranteed messages between sites for disaster recovery, and switching service between them. ### Understanding Replication Concepts, message flow, and planning before configuring cross-site replication. - [Data Center Replication for Disaster Recovery](https://docs.solace.com/Features/DR-Replication/Data-Center-Replication-Overview.md): How data center replication provides disaster recovery by propagating guaranteed messages between active and standby sites. - [How Replication Works](https://docs.solace.com/Features/DR-Replication/How-Replication-Works.md): The replication process for non-transacted, local, and XA transaction messages, including replication bridges and ACK propagation. - [Replication Best Practices](https://docs.solace.com/Features/DR-Replication/Replication-Best-Practices.md): Recommended practices for replication, such as topic hierarchies, network bandwidth, and site resourcing. - [Selecting Which Messages to Replicate](https://docs.solace.com/Features/DR-Replication/Select-Replication-Messages.md): How to configure replicated topic subscriptions and exceptions to determine which messages replicate between sites. - [Synchronous and Asynchronous Message Replication](https://docs.solace.com/Features/DR-Replication/Sync-Asynch-Replication.md): Comparing synchronous and asynchronous replication modes, performance trade-offs, and preventing sync downgrade. - [Replication Queue Full](https://docs.solace.com/Features/DR-Replication/Replication-Queue-Full.md): Broker behavior when the replication queue fills during standby outages, including reject-on-discard and queue pruning. - [Deployment Options for Replication](https://docs.solace.com/Features/DR-Replication/Replication-Deployment-Options.md): Advanced replication deployments, including connecting clients to standby sites and active messaging at both sites. - [Using Replication With DMR](https://docs.solace.com/Features/DR-Replication/Replication-DMR-Overview.md): Combining replication and Config-Sync with Dynamic Message Routing, including internal/external links and shared data channels. ### Configuring Replication How to set up replication between two sites, at system and Message VPN level. - [Steps for Configuring Replication](https://docs.solace.com/Features/DR-Replication/Steps-for-Replication-Configuration.md): How to configure replication between two sites end-to-end, covering Config-Sync, mates, and VPNs. - [Configuring System-Level Replication Settings](https://docs.solace.com/Features/DR-Replication/Replication-Sys-Level-Settings.md): How to configure system-level replication settings such as mates, Config-Sync bridges, and TLS/SSL. - [Configuring VPN-Level Replication Settings](https://docs.solace.com/Features/DR-Replication/Replication-VPN-Level-Settings.md): How to configure Message VPN replication settings such as ACK propagation, bridges, and replicated topic subscriptions. - [Reconfiguring Hostname / Routername for Appliance Event Brokers](https://docs.solace.com/Features/DR-Replication/Configure-Replication-Hostname.md): How to change the hostname and virtual router name on appliances in a replication pair while managing VPN replication and Config-Sync. - [Configuring Replication with a DMR Network](https://docs.solace.com/Features/DR-Replication/Replication-with-DMR.md): How to integrate replication with a DMR network, including adding mates and replication groups to a cluster. - [Monitoring Replication](https://docs.solace.com/Features/DR-Replication/Monitoring-Replication.md): CLI commands for viewing system- and VPN-level replication statistics and detecting degraded replication service. ### Switching Service Between Sites Failover and failback procedures for moving active service between replication sites. - [Switching Service Between Sites](https://docs.solace.com/Features/DR-Replication/Switching-Service-Overview.md): Replication failover types (controlled and uncontrolled), changing replication state, client reconnection, and failback risks. - [Performing a Controlled Failover](https://docs.solace.com/Features/DR-Replication/Perf-Con-Fail-Over.md): How to gracefully switch replication activity between sites (controlled failover), including queue draining and cleanup. - [Performing an Uncontrolled Failover](https://docs.solace.com/Features/DR-Replication/Recov-Uncon-Fail-Over.md): How to recover from an unplanned active-site failure by activating standby VPNs and suspending replication. - [Failing Back to a Restored Site After an Uncontrolled Failover](https://docs.solace.com/Features/DR-Replication/Failing-Back.md): How to fail activity back to a restored site, including deduplication steps to prevent message loss or duplication. ### Handling Replication in the Messaging APIs How client applications work with replicated event brokers: per-API best practices for host lists, reconnecting to the standby site after a failover, and detecting duplicate messages using the replication group message ID. - [Replication Best Practices (C API)](https://docs.solace.com/API/API-Developer-Guide/Replication-BP.md): Considerations for C applications used with replicated event brokers — minimum API version for automatic failover handling, host lists with one address per site, reconnection/retry to the standby, and handling of in-progress messages and transactions. - [Detecting Duplicate Messages (C API)](https://docs.solace.com/API/API-Developer-Guide/Detecting-Duplicate-Mess.md): Using the replication group message ID to detect and avoid reprocessing duplicate messages after a replication failover or redelivery. - [Replication Best Practices (.NET API)](https://docs.solace.com/API/API-Developer-Guide-Net/NET-API-Replication-BP.md): .NET guidance for replication-aware applications — API version, host lists, reconnection to the standby site, and handling in-progress messages during failover. - [Detecting Duplicate Messages (.NET API)](https://docs.solace.com/API/API-Developer-Guide-Net/NET-API-Detecting-Duplicate-Mess.md): .NET techniques for detecting duplicate messages via the replication group message ID after a replication failover. - [Replication Best Practices (Java RTO API)](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Replication-BP.md): Java RTO guidance for replication-aware applications — API version, host lists, reconnection, and failover handling. - [Detecting Duplicate Messages (Java RTO API)](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Detecting-Duplicate-Mess.md): Java RTO techniques for detecting duplicate messages via the replication group message ID after a replication failover. - [Replication Best Practices (JavaScript API)](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Replication-BP.md): JavaScript guidance for replication-aware applications — API version, host lists, reconnection, and failover handling. - [Detecting Duplicate Messages (JavaScript API)](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Detecting-Duplicate-Mess.md): JavaScript techniques for detecting duplicate messages via the replication group message ID after a replication failover. - [Replication Best Practices (JCSMP API)](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Replication-BP.md): JCSMP guidance for replication-aware applications — API version, host lists, reconnection, and failover handling. - [Detecting Duplicate Messages (JCSMP API)](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Detecting-Duplicate-Mess.md): JCSMP techniques for detecting duplicate messages via the replication group message ID after a replication failover. - [Considerations for Replicated Event Broker Deployments (Jakarta API)](https://docs.solace.com/API/Solace-Jakarta-API/Considerations-for-Repli.md): Jakarta Messaging considerations when running against replicated event brokers, including failover handling and host lists. ## Dynamic Message Routing Feature for Event Brokers > Building and operating an event mesh with DMR, the routing technology that connects brokers into clusters and meshes. ### Understanding DMR DMR concepts, terminology, and event-mesh design. - [Dynamic Message Routing](https://docs.solace.com/Features/DMR/DMR-Overview.md): DMR as the technology behind an event mesh, covering horizontal and multi-site scaling and message flow. - [DMR Terminology](https://docs.solace.com/Features/DMR/DMR-Terminology.md): Core DMR concepts such as node, gateway node, link, channel, cluster, and event mesh. - [DMR Subscription Propagation and Data Forwarding](https://docs.solace.com/Features/DMR/DMR-Subscription-Mgmt.md): How DMR propagates subscriptions within and between clusters, subscription limits, and data forwarding. - [Best Practices for Designing an Event Mesh with DMR](https://docs.solace.com/Features/DMR/DMR-Best-Practices.md): Event mesh design, covering topic hierarchy, connecting clusters, and securing links with TLS. ### DMR Examples Illustrative horizontal-scaling and multi-site DMR scenarios. - [Horizontal Scaling](https://docs.solace.com/Features/DMR/DMR-Examples-Scaling.md): Scenario using three software event brokers in a DMR network to scale beyond single-broker MQTT client capacity. - [Multi-Site Connectivity](https://docs.solace.com/Features/DMR/DMR-Examples-Multi-Site.md): Scenario migrating on-premises applications to cloud providers using DMR control links across sites. ### Configuring DMR How to set up DMR clusters, links, and event meshes via Broker Manager or the CLI. - [Setting Up an Event Mesh Using DMR](https://docs.solace.com/Features/DMR/DMR-Setup-Overview.md): Overview of configuring DMR mode, clusters, links, and monitoring, via Broker Manager or the CLI. - [Prerequisites](https://docs.solace.com/Features/DMR/DMR-Mgmt-Prerequisites.md): Prerequisites and network rules for configuring DMR, such as HA, router names, and cluster linking. - [Creating an Event Mesh using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/DMR-broker-manager-event-mesh.md): How to create a DMR cluster and configure internal and external links between nodes using Broker Manager. - [Configuring DMR External Links](https://docs.solace.com/Admin/Broker-Manager/DMR-external-links.md): How to create DMR external links and bridges between gateway nodes in different clusters using Broker Manager. - [Configuring DMR Internal Links](https://docs.solace.com/Admin/Broker-Manager/DMR-internal-links.md): How to add a node and create internal links between nodes in the same cluster using Broker Manager. - [Enabling and Disabling DMR Mode](https://docs.solace.com/Features/DMR/DMR-Mgmt-Mode-Config.md): How to switch broker routing between DMR and Multi-Node Routing (MNR), including the defer keyword. - [Configuring a DMR Cluster](https://docs.solace.com/Features/DMR/DMR-Mgmt-Cluster-Config.md): CLI reference for creating a DMR cluster and setting basic, client-certificate, and TLS/SSL authentication. - [Configuring Cluster Links](https://docs.solace.com/Features/DMR/DMR-Mgmt-Cluster-Link-Config.md): CLI guide for cluster links, covering span, initiator, transport, and authentication. - [Configuring Cluster Links with Replication](https://docs.solace.com/Features/DMR/DMR-with-DR-Cluster-Link-Config.md): Shared data channels when cluster links connect replication-group members, and settings that must match. - [Configuring DMR on a Message VPN](https://docs.solace.com/Features/DMR/DMR-Mgmt-Msg-Vpn.md): How to enable or disable DMR per Message VPN and create DMR bridges over external cluster links. - [Horizontal Scaling Configuration](https://docs.solace.com/Features/DMR/DMR-Examples-Scaling-Config.md): Worked example creating a three-node DMR cluster with internal links to scale broker limits horizontally. - [Multi-Site Connectivity Configuration](https://docs.solace.com/Features/DMR/DMR-Examples-Multi-Site-Config.md): Worked example connecting three sites with external DMR links, clusters, and DMR bridges. ### Monitoring DMR Diagnosing DMR topology and cluster synchronization. - [Monitoring Your DMR Cluster](https://docs.solace.com/Features/DMR/DMR-Mgmt-Monitor.md): Diagnosing DMR topology errors and cluster sync states with show cluster, link, channel, and Message VPN commands. ## Message VPN Bridges Feature for Event Brokers > Linking two Message VPNs to pass Direct and Guaranteed messages between them. - [Message VPN Bridges](https://docs.solace.com/Features/VPN/Message-VPN-Bridges-Overview.md): How Message VPN bridges link two Message VPNs to deliver Direct and Guaranteed messages, with access control and directionality. - [Configuring Message VPN Bridges](https://docs.solace.com/Features/VPN/Managing-Message-VPN-Bridges.md): How to create unidirectional and bidirectional Message VPN bridges. - [Creating a Message VPN Bridge Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/VPN-Bridge-Click-to-Connect.md): How to create a Message VPN bridge using the Broker Manager Click-to-Connect wizard. - [Configuring VPN Bridges Using the Solace Event Broker CLI](https://docs.solace.com/Features/VPN/Configuring-VPN-Bridges.md): CLI reference for Message VPN bridge properties such as remote VPNs, authentication, and TLS/SSL. - [VPN Bridge Setup Examples](https://docs.solace.com/Features/VPN/Message-VPN-Bridge-Setup-Examples.md): Sample CLI sequences for unidirectional, bidirectional, loopback, and Guaranteed-messaging bridges. - [Monitoring VPN Bridges](https://docs.solace.com/Features/VPN/Monitoring-Message-VPN-Bridges.md): CLI show/clear commands for bridge status, statistics, and subscriptions, with operational-state reference tables. - [Bridging to Remote Event Brokers That Use Redundancy](https://docs.solace.com/Features/VPN/VPN-Bridging-to-Remote-Event-Brokers.md): How to bridge to redundant software and appliance brokers using active/standby, N+1 alternate connections, and DNS redirection. ## Kafka Bridging Feature for Event Brokers > Bridging between an Apache Kafka cluster and the event broker using Kafka receivers and senders. - [Kafka Bridging](https://docs.solace.com/Features/Kafka-Bridging/Kafka-Bridging-Overview.md): How Kafka bridging connects a Kafka cluster and event broker via receivers and senders, with message conversion mapping. - [Configuring Kafka Bridging in Broker Manager](https://docs.solace.com/Admin/Broker-Manager/config-kafka-bridge.md): How to create Kafka receivers and senders and configure their bindings using Broker Manager. - [Connecting to Apache Kafka Using the Connector Wizard](https://docs.solace.com/Features/Kafka-Bridging/Apache-Kafka-Connector.md): How to configure an event broker to receive from and send to Apache Kafka using the Broker Manager connector wizard, with various authentication schemes. - [Configuring Kafka Bridging Using the Solace Event Broker CLI](https://docs.solace.com/Features/Kafka-Bridging/Kafka-Bridging-Setup-Overview.md): CLI reference for Kafka receivers and senders, covering authentication, bindings, and TLS/SSL. - [Monitoring Kafka Bridges](https://docs.solace.com/Features/Kafka-Bridging/Kafka-Bridging-Monitor.md): CLI show and clear commands for Kafka bridge system, Message VPN, receiver, and sender status and statistics. - [Kafka Bridging Example](https://docs.solace.com/Features/Kafka-Bridging/Kafka-Bridging-Example.md): Worked CLI example configuring a Kafka receiver and sender to exchange messages between a broker and Kafka. ## Distributed Tracing Feature for Event Brokers > Tracing an event's lifecycle across the mesh using OpenTelemetry, covering concepts, configuration, the receiver, and best practices. - [Distributed Tracing Overview](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Overview.md): How distributed tracing traces an event's lifecycle across the mesh, using broker spans and OpenTelemetry backends. - [Distributed Tracing Terminology](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Terminology.md): Core terms such as trace, span, SpanContext, telemetry queue, and receiver. - [Context Propagation for Distributed Tracing](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Context-Propagation.md): How trace context and baggage propagate through messages across brokers and APIs, and how backends assemble traces. - [Configuring Distributed Tracing](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Setup-Overview.md): How to configure distributed tracing, including telemetry profiles, trace filters, and enabling tracing on a Message VPN. - [Solace OpenTelemetry Receiver](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Receiver.md): The OpenTelemetry Collector plugin that consumes trace messages, covering configuration, HA/DR, and security. - [Distributed Tracing OpenTelemetry Span Fields](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-OTEL-Span-Fields.md): Reference tables of OpenTelemetry and Solace span attributes for send, receive, move, and delete spans. - [Distributed Tracing OpenTelemetry Auto-Instrumentation Span Fields](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Auto-Intrumentation-Span-Fields.md): Reference tables of auto-instrumentation publish and consume span attributes captured by the messaging APIs. - [Distributed Tracing Version Compatibility](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Receiver-Versions.md): Compatibility tables mapping event broker releases to OpenTelemetry Collector, messaging API, and integration library versions. - [Distributed Tracing Example](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Example.md): Worked CLI example configuring telemetry and trace filters for an order-management system, then enabling and disabling tracing. - [Distributed Tracing Best Practices](https://docs.solace.com/Features/Distributed-Tracing/Distributed-Tracing-Best-Practices.md): Recommendations for traceability, performance with receive/send spans, data-path management, and operational maintenance. ### Using Distributed Tracing for the Solace Message APIs Manual instrumentation and OpenTelemetry trace-context propagation (injecting and extracting trace context and baggage into and out of messages) for distributed tracing across the Solace messaging APIs. - [Context Propagation for Distributed Tracing (.NET API)](https://docs.solace.com/API/API-Developer-Guide-Net/NET-API-Context-Propagation-Distributed-Tracing.md): Instrumenting .NET applications for distributed tracing and manually propagating OpenTelemetry trace context and baggage into and out of messages. - [Context Propagation for Distributed Tracing (Go API)](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Distributed-Tracing.md): Manual instrumentation for the Go API — injecting and extracting OpenTelemetry trace context and baggage into messages to debug and optimize distributed systems. - [Context Propagation for Distributed Tracing (Java API)](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Distributed-Tracing.md): The two ways to integrate distributed tracing with the Java API — OpenTelemetry auto-instrumentation and manual context propagation of trace context and baggage. - [Context Propagation for Distributed Tracing (JavaScript API)](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Context-Propagation-Distributed-Tracing.md): Node.js only — manual OpenTelemetry trace-context propagation is available in the Solace Node.js API, not the browser-based JavaScript API. - [Context Propagation for Distributed Tracing (JCSMP API)](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Context-Propagation-Distributed-Tracing.md): Instrumenting JCSMP applications for distributed tracing and manually propagating OpenTelemetry trace context and baggage into and out of messages. - [Context Propagation for Distributed Tracing (Jakarta API)](https://docs.solace.com/API/Solace-Jakarta-API/Context-Propagation-Distributed-Tracing.md): The two ways to integrate distributed tracing with the Jakarta Messaging API — OpenTelemetry auto-instrumentation and manual context propagation. - [Context Propagation for Distributed Tracing (Python API)](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Distributed-Tracing.md): Manual instrumentation for the Python API — injecting and extracting OpenTelemetry trace context and baggage into and from messages. ## Message Replay Feature for Event Brokers > Storing messages in a replay log and playing them back for recovery, late-join, and reprocessing. - [Message Replay](https://docs.solace.com/Features/Replay/Message-Replay-Overview.md): Storing messages in a replay log, replay initiation and playback types, considerations, and use cases like recovery and late-join. - [Message Replay / Solace Cache Comparison](https://docs.solace.com/Features/Replay/Replay-Cache-Compare.md): Comparison of Message Replay and Solace Cache across use case, QoS, delivery order, storage, redundancy, and licensing. - [Configuring Message Replay Using Broker Manager](https://docs.solace.com/Admin/Broker-Manager/configuring-message-replay.md): How to configure the replay log, topic filters, initiate replay, and trim using Broker Manager. - [Configuring and Using Message Replay Using the Solace Event Broker CLI](https://docs.solace.com/Features/Replay/Msg-Replay-Config.md): CLI reference for creating replay logs, sizing max-spool-usage, topic filters, and enabling or disabling the log. - [Trimming Message Replay Logs](https://docs.solace.com/Features/Replay/Msg-Replay-Trimming.md): Automatic and manual replay-log trimming at 90% spool quota and choosing a trimming strategy. - [Monitoring Message Replay](https://docs.solace.com/Features/Replay/Msg-Replay-Monitoring.md): How to monitor replay-log usage against quota, with remediation actions and CLI show commands. - [Playing Back a Replay Log](https://docs.solace.com/Features/Replay/Msg-Replay-Playback.md): The start-replay, cancel-replay, and trim-logged-messages commands, replay states, selectors, and behavior with live messages. - [Message Replay Examples](https://docs.solace.com/Features/Replay/Msg-Replay-Examples.md): CLI examples for creating a replay log and starting, canceling, and trimming replay on queues and topic endpoints. ## Using Message Replay with the Solace Messaging APIs > How to use the Solace Message APIs with Message Replay. - [Replaying from the Replay Log (C API)](https://docs.solace.com/API/API-Developer-Guide/Replay-from-Replay-Log.md): How to handle event broker-initiated message replay and initiate replay from a client application using the C API. - [Replaying from the Replay Log (.NET API)](https://docs.solace.com/API/API-Developer-Guide-Net/NET-API-Replay-from-Replay-Log.md): How to handle event broker-initiated message replay and initiate replay from a client application using the .NET API. - [Replaying from the Replay Log (Java RTO API)](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Replay-from-Replay-Log.md): How to handle event broker-initiated message replay and initiate replay from a client application using the Java RTO API. - [Replaying from the Replay Log (JavaScript API)](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Replay-from-Replay-Log.md): How to handle event broker-initiated message replay and initiate replay from a client application using the JavaScript API. - [Replaying from the Replay Log (JCSMP API)](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Replay-from-Replay-Log.md): How to handle event broker-initiated message replay and initiate replay from a client application using the JCSMP API. - [Message Delivery Properties — Replay Events (Jakarta API)](https://docs.solace.com/API/Solace-Jakarta-API/Message-Delivery-Propert.md): Jakarta Messaging delivery properties, including the Replay Started event an application receives when the event broker initiates message replay. - [Message Replay for Persistent Receivers (Python API)](https://docs.solace.com/API/API-Developer-Guide-Python/Python-PM-Receive.md): Consuming persistent messages with the Python API, including adding a message replay strategy (with_message_replay / ReplayStrategy) to a persistent receiver. ## General Solace Messaging API Information > The general concepts for understanding the shared concepts, features, and best practices applicable to all Solace messaging APIs for building applications that publish and subscribe to messages from a Solace event broker. - [Solace Messaging APIs](https://docs.solace.com/API/Messaging-APIs/Solace-APIs-Overview.md): An overview of the Solace enterprise messaging APIs available for building applications that communicate over the Solace message bus. Covers the available languages including C, C#/.NET, Go, Java, JavaScript, Node.js, Python, and iOS. - [Feature Support in Solace Messaging APIs](https://docs.solace.com/API/API-Developer-Guide/Feature-Support-Messaging-APIs.md): All of the Solace Messaging APIs support common functionality that is essential for messaging. - [Supported Environments for Solace Messaging APIs](https://docs.solace.com/API/API-Developer-Guide/Supported-Environments.md): The Solace Messaging APIs are compatible with many different operating systems and platforms. - [Understanding Solace Messaging API Concepts](https://docs.solace.com/API/Core-Concepts-Solace-API-Concepts.md): Explains the fundamental building blocks of the Solace Messaging APIs — contexts, sessions, and flows — and how they organize communication between applications and an event broker. ## C API > The Solace Messaging API for C developer guide for understanding how to build messaging applications using C to publish and subscribe to messages from a Solace event broker. ### Solace Messaging API for C Concepts The fundamental architecture of the Solace C API — core objects (contexts, sessions, flows), messaging domains (Direct and Guaranteed), delivery modes, and how destinations, subscriptions, and endpoints relate to each other. - [Messaging API Concepts](https://docs.solace.com/API/API-Developer-Guide/Core-Messaging-API-Concepts.md): Introduces the core concepts and components of the Solace C API, including PTP and Pub/Sub messaging domains and key features. - [Message Delivery Modes](https://docs.solace.com/API/API-Developer-Guide/Message-Delivery-Modes.md): Describes the at-most-once (Direct and Non-Persistent), at-least-once (Persistent/Guaranteed), and transacted message delivery modes supported by Solace event brokers. - [Messages](https://docs.solace.com/API/API-Developer-Guide/Messages.md): A message is a packet of information sent from producers to consumers. - [Factories](https://docs.solace.com/API/API-Developer-Guide/Factories.md): The Solace Messaging API for C does not use a factory pattern. - [Contexts](https://docs.solace.com/API/API-Developer-Guide/Contexts.md): The messaging APIs use processing contexts for organizing communication between an application and a Solace event - [Sessions](https://docs.solace.com/API/API-Developer-Guide/Sessions.md): When a context is established, one or more sessions can be created within that context. - [Guaranteed Message Flows](https://docs.solace.com/API/API-Developer-Guide/Guaranteed-Message-Flows.md): Explains how client applications use flows to publish or consume Guaranteed messages, including producer flows and browser flows for viewing queued messages. - [Destinations, Subscriptions, and Endpoints](https://docs.solace.com/API/API-Developer-Guide/Destinations-Subscripti.md): The following figure shows the basic relationship between destinations, subscriptions, and endpoints. - [Supported Environments](https://docs.solace.com/API/API-Developer-Guide/C-API-Supported-Environments.md): The Solace Messaging API for C, 10.0.0, is compatible with a list of different operating systems and platforms. #### Understanding Structured Data Types > Solace Structured Data Types (SDTs), which are used to add typed, language-independent payloads to messages. - [Using Structured Data](https://docs.solace.com/API/API-Developer-Guide/Using-Structured-Data.md): SDTs are structured, language-independent, and architecture-independent data types. - [Creating Structure Data Maps and Streams](https://docs.solace.com/API/API-Developer-Guide/Creating-SD-Maps-Streams.md): Explains how to create message-independent and message-dependent structured data maps and streams for use as message payloads. ### Creating Client Sessions How to bootstrap a client to connect a Solace event broker — covering session creation, required connection properties, authentication schemes, retry behavior, and message property management. - [Creating Client Sessions](https://docs.solace.com/API/API-Developer-Guide/Creating-Client-Sessions.md): Explains how to create a client session that establishes a single TCP connection to a Solace event broker using SMF, including required session properties and callbacks. - [Session Properties Required to Establish a Connection](https://docs.solace.com/API/API-Developer-Guide/Session-Props-Required.md): Covers the session properties—such as authentication scheme, client name, and host—that must be configured to connect a client to an event broker. - [Configuring Connection Time-Outs and Retries](https://docs.solace.com/API/API-Developer-Guide/Configuring-Connection-T.md): Explains how to configure connection time-out and retry settings using C API session properties to control how clients connect to event brokers. - [Defining Client Authentication Info](https://docs.solace.com/API/API-Developer-Guide/Defining-Client-Authentication.md): Explains the authentication schemes available for client connections—basic, client certificate, Kerberos, and OAuth 2.0—and their configuration requirements. - [Managing Message Properties in the Solace Messaging APIs](https://docs.solace.com/API/API-Developer-Guide/Manage-Message-Properties.md): The following sections discuss how you can manage messages when you use the Solace C API. ### Publishing Direct Messages How to publish Direct (at-most-once delivery) messages — creating topics, building messages, setting routing properties, attaching data payloads, and sending. - [Publishing Direct Messages](https://docs.solace.com/API/API-Developer-Guide/Publishing-Direct-Messages.md): This section describes how to publish Direct messages using the Solace C API. - [Creating Topics](https://docs.solace.com/API/API-Developer-Guide/Creating-Topics-1.md): In the Solace C API (not object-oriented), a topic is simply a string ( char*). - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide/Creating-Messages.md): Explains how messages are created for Direct publishing, covering message ownership, message types, and resetting options. - [Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide/Setting-Message-Properti.md): Describes important message properties that affect routing, including delivery mode, destination, deliver-to-one subscriber flag, and class of service. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide/Adding-Data-Payloads-1.md): Explains the types of data payloads you can add to a Direct message, including XML content, binary attachments, user property maps, and user data. - [Sending Direct Messages](https://docs.solace.com/API/API-Developer-Guide/Sending-Messages.md): Covers how to send Direct messages using blocking or non-blocking I/O modes, one at a time or in batches. #### Receiving Direct Messages > How to receive Direct messages by managing topic subscriptions and processing messages through a session-level receive callback. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide/Receiving-Direct-Messages.md): This section describes how to receive and manage Direct messages using the Solace C API. - [Managing Subscriptions](https://docs.solace.com/API/API-Developer-Guide/Managing-Subscriptions.md): Describes how to use topic subscriptions to receive Direct messages from a message VPN, including topic hierarchies and wildcard matching. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide/Receiving-Direct-Message.md): Explains how Direct messages are delivered to a client via a message receive callback set at session creation, with notes on handling message discard indications. #### Publishing Guaranteed Messages > How to publish Guaranteed (at-least-once, persistent) messages to queues or topic endpoints and handle broker acknowledgments for published messages. - [Publishing Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide/Publishing-Guaranteed-Messages.md): Describes how to publish Guaranteed messages with persistent or non-persistent delivery mode to queue or topic destinations, using a producer flow established automatically in the session. - [Acknowledging Published Messages](https://docs.solace.com/API/API-Developer-Guide/Acknowledging-Published-.md): Published Guaranteed messages are acknowledged when they are received by the Solace event broker. - [Sending Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide/Sending-Guaranteed-Messages.md): Describes how to send Guaranteed messages using blocking or non-blocking I/O modes, with options to tune the publish window size and acknowledgment timer. - [Request Reply Messaging](https://docs.solace.com/API/API-Developer-Guide/Request-Reply-Messaging.md): Describes how to implement request-reply messaging with Guaranteed messages, covering publishing requests, sending replies, and correlating responses. #### Receiving Guaranteed Messages > How to consume Guaranteed messages by creating consumer flows bound to queues or topic endpoints, adding topic subscriptions to queues, and acknowledging received messages. - [Receiving Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide/Receiving-Guaranteed-Messages.md): Explains how client applications consume Guaranteed messages from queues and topic endpoints by creating consumer flows bound to those endpoints. - [Adding Subscriptions to Endpoints](https://docs.solace.com/API/API-Developer-Guide/Adding-Topic-Subscriptio.md): Explains how to add topic subscriptions to queues so messages published to matching topics are routed to and spooled on the queue. - [Creating Flows](https://docs.solace.com/API/API-Developer-Guide/Creating-Flows.md): Describes how to create consumer flows within a session to receive Guaranteed messages from a bound endpoint on the event broker. - [Acknowledging Messages Received by Clients](https://docs.solace.com/API/API-Developer-Guide/Acknowledging-Messages.md): Covers the acknowledgment process for Guaranteed messages received over flows, including windowed API acknowledgments and auto or client-controlled acknowledgment modes. #### Thread Safety > Which C API elements are thread-safe and how the API uses threads internally. This is essential knowledge for multi-threaded applications to avoid race conditions and crashes. - [Thread Safety](https://docs.solace.com/API/API-Developer-Guide/Thread-Safety.md): Lists which C API elements are thread-safe by design and which require application developers to manage thread safety themselves. - [API Threading](https://docs.solace.com/API/API-Developer-Guide/API-Threading.md): Explains the threading model used by the C API context for handling message publishing, reception, and acknowledgment processing. #### API Best Practices > The recommended practices when developing production applications with the Solace C API, including performance tuning and common pitfalls to avoid. - [C API Best Practices](https://docs.solace.com/API/API-Developer-Guide/C-API-Best-Practices.md): Describes the best practices specific for the Solace Messaging API for C. - [Run Guidelines](https://docs.solace.com/API/API-Developer-Guide/Run-Guidelines.md): Pre-run environment setup guidelines for compiled C API applications, including library path configuration for UNIX/Linux, Windows DLL placement, and iOS static linking. ### Messaging API for C References Online C API reference listing functions, structures, and constants, plus the C API release notes of changes and fixes by version. - [C API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/c/index.html): Online API reference documentation for the Solace C API, listing functions, structures, and constants. - [C API Release Notes](https://products.solace.com/download/C_API_RN): Release notes for the Solace C API, listing changes and fixes by version. ## .NET/C# API > The .NET/C# messaging API developer guide — core concepts, connecting and authenticating, publishing and receiving Direct and Guaranteed messages, and best practices for building production apps with the Solace.NET API. - [.NET/C# API](https://docs.solace.com/API/Messaging-APIs/dotNet-API/net-api-home.md): Solace C# API, Solace.NET API, CSCSMP — release notes, developer guide, and API reference. - [.NET API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Developer-Guide-Home.md): Guide home page and entry point into the sections below. #### Getting Started > Install the API and get a sample publisher/subscriber running before diving into concepts. - [Quick Start](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Quick-Start.md): Fastest path to a running app — build and run the included samples to validate your install. - [Installation](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Installation.md): Unzip the .NET/C# API archive and locate the assemblies, samples, and docs for your platform. - [Building .NET Projects with NuGet](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Building-Projects-With-NuGet.md): Add the Solace.NET API to a project via the NuGet package instead of manual assembly references. #### Core Messaging Concepts > The vocabulary and mental model used throughout the rest of this guide: contexts, sessions, messages, flows, delivery modes, and how topics, queues, and endpoints relate. - [Messaging API Concepts](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Core-Messaging-API-Concepts.md): Core objects and terminology — messaging domains, messages, factories, contexts, sessions, and cache sessions. - [Message Delivery Modes](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Message-Delivery-Modes.md): Direct vs. Guaranteed (persistent/non-persistent) delivery modes and when to use each. - [Guaranteed Message Flows](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Guaranteed-Message-Flows.md): What a "flow" is, the difference between producer and consumer flows, and using Browsers to peek at or remove spooled queue messages. - [Destinations, Subscriptions, and Endpoints](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Destinations-Subscripti.md): How topics, queues, subscriptions, and endpoints relate to each other and to a session. #### Initializing, Connecting, and Monitoring > Bootstrap an application: initialize the API, create a context and session, authenticate, and diagnose a connection once it's running. - [Creating Contexts](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Contexts.md): The container that owns I/O threads and organizes one or more sessions — every app needs at least one. - [Creating Client Sessions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Client-Sessions.md): Open the client connection (SMF over TCP) to an event broker; sessions are unsecured by default. - [Session Properties Required to Establish a Connection](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Session-Props-Required.md): Which session properties must be set explicitly vs. which have usable defaults. - [Defining Client Authentication Info](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Defining-Client-Authentication.md): Configure basic, client-certificate, Kerberos, or OAuth authentication for a session. - [Creating Secure Sessions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Secure-Sessions.md): Connect over TLS/SSL and the session properties required to enable it. - [Configuring Connection Time-Outs and Retries](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Configuring-Connection-T.md): Tune connection and reconnection timeout and retry behavior. - [Configuring Logging](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Configuring-Logging.md): Enable and filter dependency-free diagnostic logging, including syslog-style severity levels and a custom log delegate. - [Working with Session Statistics](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Working-with-Session-Sta.md): Per-session counters useful for debugging message flow and throughput problems. #### Working with Messages, Topics, and Payloads > Shared building blocks used by both Direct and Guaranteed messaging: creating topics, constructing messages, and attaching payloads. - [Creating Topics](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Topics-1.md): Create a Topic instance to use as a publish destination or subscription. - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Messages.md): The session-independent message ownership model, and creating and resetting an IMessage. - [Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Setting-Message-Properti.md): Key message properties that affect routing when publishing. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Adding-Data-Payloads-1.md): Payload types you can attach to a message, including binary attachments. - [Using Structured Data](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Using-Structured-Data.md): SDTs — structured, language- and architecture-independent data types, including Map and Stream containers, for payloads and header fields. - [Serializing and Deserializing Messages with the Solace .NET API](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Serdes.md): Use the SERDES Collection to handle structured payloads efficiently, including with schema registries. #### Direct Messaging (Publish/Subscribe) > Use Direct messaging for maximum throughput and lowest latency, where occasional message loss is acceptable. - [Publishing Direct Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Sending-Messages.md): Send a Direct message, and the factors to consider when publishing. - [Managing Subscriptions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Managing-Subscriptions.md): Subscribe to topics to receive matching Direct messages, including reconnect-durable subscriptions and managing subscriptions on behalf of other clients. - [Receiving Direct Messages: Overview and ACLs](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Receiving-Direct-Messages.md): ACL profile requirements for a client to subscribe to topics and receive Direct messages. - [Receiving Direct Messages: the Receive Delegate](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Receiving-Direct-Message.md): The message-receive delegate set at session creation, topic-specific dispatch with custom callbacks, and detecting broker-side message loss via discard indications. #### Guaranteed Messaging (Queues and Persistence) > Use Guaranteed messaging when messages must survive broker restarts and be acknowledged. Requires Guaranteed messaging (spooling) enabled on the broker, and the appropriate ACL profile. - [Publishing Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Publishing-Guaranteed-Messages.md): Publish persistent or non-persistent messages; a producer flow is established automatically. - [Creating Guaranteed Messages and Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Messages-1.md): Guaranteed-specific message properties — ACK Immediately, Class-of-Service, Correlation ID, DMQ eligibility, Delivery Mode, Message Priority, Partition Key, ReplyTo, and Time-to-Live. - [Acknowledging Published Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Acknowledging-Published-.md): How the broker acknowledges receipt of a published Guaranteed message. - [Sending Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Sending-Guaranteed-Messages.md): Tuning publish window size and ack timers, especially over high-latency networks. - [Request Reply Messaging](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Request-Reply-Messaging.md): Implementing request-reply using Guaranteed messages. - [Provisioning and Deprovisioning Durable Endpoints](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Provisioning-Durable-End.md): Create durable queues or topic endpoints on the broker, with or without an active consuming flow. - [Creating Flows](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Flows.md): Bind a consumer flow to an endpoint to receive Guaranteed messages (maximum 1,000 flows per session). - [Acknowledging Messages Received by Clients](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Acknowledging-Messages.md): Client-side ack/NACK handling, including malformed messages. - [Detecting Duplicate Messages](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Detecting-Duplicate-Mess.md): Use the Replication Group Message ID (RGMID) to detect and avoid processing duplicate deliveries. - [Replaying from the Replay Log](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Replay-from-Replay-Log.md): Recover missed messages via broker-initiated or client-initiated message replay. #### Using Local Transactions > Group multiple Guaranteed sends and receives into one atomic unit. - [Creating Transacted Sessions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Creating-Transacted-Sess.md): A transacted session supports at most one producer flow and up to 256 consumer flows. - [Publishing Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Publishing-Messages-inT.md): Publish Guaranteed messages within a transaction. - [Consuming Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Consuming-Msgs-in-Transactions.md): Consume Guaranteed messages within a transaction. - [Completing Transactions](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Completing-Transactions.md): Commit or roll back messages staged on the event broker. #### Threading > How the Context organizes I/O threads, when your application must provide its own, and which API elements are thread-safe versus your responsibility. - [API Threading](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Threading.md): How the Context organizes I/O threads, when your application needs to provide its own, and the distinct threading paths for publishing acknowledgments and receiving messages. - [Thread Safety](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Thread-Safety.md): Which API elements are thread-safe by design vs. the application's responsibility. #### Performance and Advanced Configuration > Tuning knobs and less-common configuration for production deployments. - [Enabling Channel Compression for a Session](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Enabling-Channel-Compres.md): Trade CPU for bandwidth with a configurable compression level (0-9). - [End-to-End Payload Compression](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Message-Payload-Compression.md): Compress message payloads — but don't rely on compression to keep an oversized payload under the broker's maximum message size. - [Setting Client Keepalives](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Setting-Client-Keepalive.md): Configure the keepalive interval and behavior when keepalives fail. - [Context Propagation for Distributed Tracing](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Context-Propagation-Distributed-Tracing.md): Manually inject or extract OpenTelemetry trace context into messages. #### Best Practices and High Availability > General Solace.NET development best practices, including data-center replication/DR and HA-redundant broker failover considerations. - [.NET API Best Practices](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Best-Practices.md): General best practices for developing with the Solace.NET API, including data-center replication/DR and HA-redundant broker failover considerations. #### Using the Solace .NET API with Solace Cache > Issue cache requests for a topic against a Distributed Cache, Cache Cluster, or Cache Instance to retrieve the last cached messages. - [Using the Solace .NET API with Solace Cache](https://docs.solace.com/API/API-Developer-Guide-NET/cache/using-pubsub-cache.md): Issue cache requests for a topic against a Distributed Cache, Cache Cluster, or Cache Instance. #### Reference > Supported .NET Core and .NET Framework versions and platforms for the Solace.NET API. - [Supported Environments](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Supported-Environments.md): Supported .NET Core and .NET Framework versions and platforms. ## Go API > The Solace Messaging API for Go developer guide for understanding how to build messaging applications using Go to publish and subscribe to messages from a Solace event broker. - [Solace Go API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Dev-Guide.md): Overview of the Solace Go API structure and how to use it to connect to a Solace event broker and publish or consume messages. - [Builder Pattern Usage in the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Builder-Pattern.md): Explains the builder design pattern used throughout the Go API to create instances of messages, publishers, and receivers. - [Messaging Service](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Messaging-Service.md): Describes the MessagingService interface, which is the entry point for configuring and establishing a connection to a Solace event broker. ### Publishing Messages How to publish messages from a Go application using the Go API covering both direct and persistent delivery, back pressure handling, and acknowledgment. - [Publishing Messages](https://docs.solace.com/API/API-Developer-Guide-Go/Publishing-Messages.md): Overview of message publishing in the Go API, introducing both direct and persistent delivery modes. - [Publishing Direct Messages Using the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-DM-Publish.md): Direct messages are useful when high-throughput and low-latency is required. - [Publishing Persistent Messages Using the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-PM-Publish.md): How to publish persistent (guaranteed) messages using the PersistentMessagePublisher, including back pressure handling and acknowledgment receipt. ### Receiving Messages How to consume messages in a Go application — covering direct and persistent delivery, synchronous and asynchronous receive patterns, and message acknowledgment. - [Receiving Messages](https://docs.solace.com/API/API-Developer-Guide-Go/Receiving-Messages.md): Overview of message consumption in the Go API, introducing both direct and persistent delivery modes. - [Consuming Direct Messages Using the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-DM-Subscribe.md): Direct messaging is useful in scenarios where high-throughput and low-latency is required. Shows how to use the API to consume messages from an event broker. - [Consuming Persistent Messages Using the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-PM-Subscribe.md): How to consume persistent (guaranteed) messages from a queue using PersistentMessageReceiver, including synchronous and asynchronous receive patterns and acknowledgment. - [Context Propagation for Distributed Tracing in the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Distributed-Tracing.md): How to enable OpenTelemetry-based distributed tracing in Go applications by injecting and extracting trace context into and from Solace messages. - [Request-Reply Messaging in the Solace Go API](https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Request-Reply.md): How to implement the request-reply messaging pattern using RequestReplyMessagePublisher and RequestReplyMessageReceiver for point-to-point communication. ### Reference for the Solace Messaging API for Go Online Go API reference (packages, types, and functions), plus release notes of changes and fixes by version. - [Go API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/go/index.html): Online API reference documentation for the Solace Go API, listing packages, types, and functions. - [Go API Release Notes](https://products.solace.com/download/GO_API_RN): Release notes for the Solace Go API, listing changes and fixes by version. ## Java API > The Solace Java (next-generation) messaging API developer guide — the builder-pattern MessagingService object, publishing and receiving Direct and Persistent (Guaranteed) messages, and request-reply and tracing patterns. - [Java API](https://docs.solace.com/API/Messaging-APIs/Java-API/java-api-home.md): Solace Java API — release notes, developer guide, and API reference. - [Solace Java API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Dev-Guide.md): Guide home page — overview of the MessagingService object, back pressure, and the four core pub/sub objects (DirectMessagePublisher, PersistentMessagePublisher, DirectMessageReceiver, PersistentMessageReceiver). #### Getting Started > Set up your build and get the official code samples running before diving into the API. - [Building Java Projects with Maven](https://docs.solace.com/API/API-Developer-Guide-Java/Java-build-projects.md): Obtain the solace-messaging-client (and JCSMP) artifacts from Maven Central, or install/deploy .jar and .pom files to a local or remote Maven repository. - [Using the Solace Java API Examples](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-samples.md): Clone the Solace Developer Hub's Java samples repo and build/run them with Gradle (gradlew clean assemble, gradlew eclipse), including the HelloWorld sample. #### Core Concepts and API Design > Everything in this API is constructed through these two concepts — understand them before the task-specific pages below. - [Builder Pattern Usage in the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Builder-Pattern.md): The builder design pattern underlying the API — OutboundMessageBuilder, MessagingService, publishers, and receivers are all constructed this way. - [Messaging Service](https://docs.solace.com/API/API-Developer-Guide-Java/Java-Messaging-Service.md#Messaging-Service): Configure and build a MessagingService via Properties (Service, TransportLayer, Authentication, Client, TransportLayerSecurity), Configuration Profiles, TLS/WebSocket options, end-to-end payload compression, and authentication (Basic, Kerberos, Client Certificate, OAuth 2.0/OIDC). #### Connecting and Monitoring > Connect through an HTTP or SOCKS5 proxy via JVM system properties, and configure log4j2 or java.util.logging with service-interruption and reconnection listeners. - [Using Proxy Connections in the Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Proxy-Connection.md): Connect through an HTTP or SOCKS5 proxy using JVM system properties (solace.proxy.host, .type, .port, .username, .password). - [Configuring Logging in the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Logging.md#Java-API-Logging): Configure log4j2 or java.util.logging through the Jakarta/Apache Commons Logging abstraction, including supported log levels and service-interruption/reconnection listeners. #### Publishing Messages > Publish to a topic for delivery to subscribed receivers, choosing Direct (fire-and-forget, not retained) or Persistent (guaranteed, ordered) delivery. - [Publishing Direct Messages Using the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-DM-Publish.md): Publish via DirectMessagePublisher, configure OutboundMessage objects, and handle back pressure with onBackPressureReject(), onBackPressureWait(), or onBackPressureElastic(). - [Publishing Persistent Messages Using the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-PM-Publish.md): Publish via PersistentMessagePublisher, including Partition Key support for Partitioned Queues, blocking vs. non-blocking publish, and ACK/NACK handling via MessagePublishReceiptListener. #### Receiving Messages > Consume messages from topics you've subscribed to. Persistent messages additionally require binding a consumer flow to a durable or non-durable queue on the broker. - [Consuming Direct Messages Using the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-DM-Subscribe.md): Receive via DirectMessageReceiver, synchronously (receiveMessage()) or asynchronously (receiveAsync()), with receiver-side back pressure (onBackPressureDropLatest(), onBackPressureDropOldest(), onBackPressureElastic()). - [Consuming Persistent Messages Using the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-PM-Subscribe.md): Receive via PersistentMessageReceiver, including flow control (pause()/resume()), auto- vs. client-ack modes, and Negative Acknowledgments/settlement outcomes (ACCEPTED/FAILED/REJECTED). - [Creating Queues with the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Create-Queues.md): Create non-durable queues, or auto-provision durable queues via MissingResourcesCreationStrategy (DO_NOT_CREATE or CREATE_ON_START), on a PersistentMessageReceiver. - [Browsing Queues with the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Browse-Queues.md): Non-destructively inspect Guaranteed messages on a queue via a MessageQueueBrowser, including selector-filtered browsing with withMessageSelector(). #### Advanced Messaging Patterns > Request-reply with RequestReplyMessagePublisher and RequestReplyMessageReceiver (synchronous publishAwaitResponse or asynchronous ReplyMessageHandler), and OpenTelemetry context propagation for distributed tracing. - [Request-Reply Messaging in the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Request-Reply.md): Implement request-reply using RequestReplyMessagePublisher/RequestReplyMessageReceiver, with synchronous (publishAwaitResponse()) or asynchronous (publish() with ReplyMessageHandler) requests and replies. - [Context Propagation for Distributed Tracing in the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-Distributed-Tracing.md): OpenTelemetry context propagation via auto-instrumentation (opentelemetry-javaagent) or manual instrumentation (SolacePubSubPlusJavaTextMapSetter/Getter) to inject or extract trace context and baggage. #### Reference > Supported JDKs, OS and platform matrix, Maven/Gradle dependency snippets and TLS versions, and the MAJOR.MINOR.PATCH semantic versioning scheme for releases. - [Supported Environments for the Solace Java API](https://docs.solace.com/API/API-Developer-Guide-Java/Java-API-supported-environments.md): Supported JDKs, OS/platform matrix (Windows, macOS, Linux, Alpine), Maven/Gradle dependency snippets, and supported TLS versions. - [Semantic Versioning](https://docs.solace.com/API/API-Developer-Guide-Java/api-versioning.md): The MAJOR.MINOR.PATCH semantic versioning scheme used for API releases. ## Java RTO API > The Solace Java RTO (real-time optimized) API developer guide for understanding how to build low-latency messaging applications using Java to publish and subscribe to messages from a Solace event broker. ### Messaging API Concepts The core messaging concepts and components of the Java RTO API to know before building applications. - [Java RTO API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Developer-Guide-Home.md): Overview of the Java RTO API's core concepts — contexts, sessions, and message delivery — and how they work together to enable publish-subscribe and point-to-point messaging. - [Messaging API Concepts](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Core-Messaging-API-Concepts.md): Introduction to the core components of the Java RTO API, including messaging domains (point-to-point and pub/sub), contexts, sessions, and flows. - [Message Delivery Modes](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Message-Delivery-Modes.md): Describes the message delivery modes supported by the Java RTO API: Direct (at-most-once), Persistent/Guaranteed (at-least-once), and transacted delivery. - [Guaranteed Message Flows](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Guaranteed-Message-Flows.md): Explains the concept of flows — the API objects required to publish or consume Guaranteed messages within a session. - [Destinations, Subscriptions, and Endpoints](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Destinations-Subscripti.md): The following figure shows the basic relationship between destinations, subscriptions, and endpoints. ### Initializing and Monitoring APIs How to initialize the Java RTO API and access logging and session statistics. - [Initializing and Monitoring APIs](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Initializing-and-Monitoring-APIs.md): How to initialize the Java RTO API by calling Solclient.init() and optionally configure log level and global buffer sizes. - [Creating Contexts](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Contexts.md): Contexts are used for organizing communications between applications and a Solace event broker. ### Creating Client Sessions How to connect a client to a Solace event broker — covering session creation, required properties, authentication, and optional connection settings. - [Creating Client Sessions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Client-Sessions.md): How to create, connect, and close a client session in the Java RTO API, including required properties and message receive callbacks. - [Session Properties Required to Establish a Connection](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Session-Props-Required.md): Lists and explains the session properties — authentication scheme, client name, host, and Message VPN — required to connect to a Solace event broker. - [Configuring Connection Time-Outs and Retries](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Configuring-Connection-T.md): How to configure connection timeout, connect retries, and reconnect retry intervals for resilient event broker connections. - [Defining Client Authentication Info](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Defining-Client-Authentication.md): How to configure the authentication scheme for a Java RTO API session, covering basic, client certificate, Kerberos, and OAuth authentication. - [Detecting Event Broker Capabilities](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Detecting-Msg-Broker-Capabil.md): How to query a connected session for event broker capabilities and feature availability using SessionHandle methods. ### Publishing Direct Messages How to publish Direct messages using the Java RTO API — covering topics, message creation, properties, payloads, and sending. - [Publishing Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Publishing-Direct-Messages.md): This section describes how to publish Direct messages using the Solace Java RTO API. - [Creating Topics](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Topics-1.md): How to create non-temporary and temporary topic instances in the Java RTO API for use as message publish destinations and subscription targets. - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Messages.md): How to create messages for publishing in the Java RTO API, including message ownership models, message types, and resetting messages. - [Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Setting-Message-Properti.md): How to set key message properties — delivery mode, destination, class of service, and eliding eligibility — that affect how messages are routed through the event broker. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Adding-Data-Payloads-1.md): How to add XML, binary, user-property map, and user-data payloads to messages in the Java RTO API. - [Sending Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Sending-Messages.md): How to send Direct messages in blocking or non-blocking mode, individually or in batches, using the Java RTO API. - [Publishing Messages that Request Replies](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Publishing-Messages-that.md): How to publish request messages that include a ReplyTo destination, enabling request-reply messaging with Direct messages. #### Receiving Direct Messages > How to consume Direct messages in a Java RTO API session — covering subscriptions, callbacks, and topic dispatch. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Receiving-Direct-Messages.md): This section describes how to receive and manage Direct messages using the Solace Java RTO API. - [Managing Subscriptions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Managing-Subscriptions.md): How to add and remove topic subscriptions for a session to control which Direct messages a client receives. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Receiving-Direct-Message.md): How to receive Direct messages using a session-level message callback, including message discard indications and topic dispatch. ### Publishing Guaranteed Messages How to publish Guaranteed (persistent) messages to queues and topic endpoints using the Java RTO API. - [Publishing Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Publishing-Guaranteed-Messages.md): How to publish Guaranteed messages with a persistent or non-persistent delivery mode to queue or topic destinations using the Java RTO API. - [Acknowledging Published Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Acknowledging-Published-.md): Published Guaranteed messages are acknowledged when they are received by the Solace event broker. - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Messages-1.md): How to create messages for publishing in the Java RTO API, including message ownership models, message types, and resetting messages. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Adding-Data-Payloads.md): How to add XML, binary, user-property map, and user-data payloads to messages in the Java RTO API. - [Sending Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Sending-Guaranteed-Messages.md): How to send Guaranteed messages in blocking or non-blocking mode, with guidance on publish window size and acknowledgment timers. #### Receiving Guaranteed Messages > How to consume Guaranteed messages from queues and topic endpoints using the Java RTO API. - [Receiving Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Receiving-Guaranteed-Messages.md): Overview of how clients consume Guaranteed messages from queues and topic endpoints, covering endpoint durability, access types, and flow creation. - [Adding Subscriptions to Endpoints](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Adding-Topic-Subscriptio.md): How to add topic subscriptions to a queue so it receives messages published to matching topics. - [Creating Flows](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Flows.md): How to create a consumer flow within a session and bind it to an endpoint to receive Guaranteed messages. - [Acknowledging Messages Received by Clients](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Acknowledging-Messages.md): How to acknowledge received Guaranteed messages using auto-acknowledgment or client-acknowledgment modes to signal successful processing. - [Using Selectors](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Using-Selectors.md): How to use SQL92-based selector expressions on flows and browser flows to filter which messages a client receives based on message header fields. ### Using Local Transactions How to group Guaranteed message publish and receive operations into atomic transactions using the Java RTO API. - [Using Local Transactions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Using-Local-Transactions.md): How to use transacted sessions to publish and consume Guaranteed messages in a single atomic transaction, with commit and rollback semantics. - [Creating Transacted Sessions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Creating-Transacted-Sess.md): A client can create one or more transacted sessions within an existing session. - [Publishing Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Publishing-Messages-inT.md): How to establish a producer flow in a transacted session and publish Guaranteed messages that are staged until the transaction is committed. - [Consuming Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Consuming-Msgs-in-Transactions.md): How to consume Guaranteed messages in a transacted session, with acknowledgment deferred until the transaction is committed. - [Completing Transactions](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Completing-Transactions.md): Messages that are published and received on a transaction are staged on the Solace event broker. ### Thread Safety Which Java RTO API elements are thread-safe by default and which require explicit synchronization in application code. - [Thread Safety](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Thread-Safety.md): Lists which Java RTO API elements have built-in thread safety and which require the application developer to manage thread safety. - [API Threading](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Threading.md): Explains the Java RTO API threading model — how contexts use threads for network I/O, message delivery, and acknowledgment dispatch. - [Threading When Publishing Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Threading-When-Publishin.md): When the event broker successfully receives Guaranteed messages, it returns acknowledgments to the API. - [Threading When Receiving Messages](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Threading-When-Receiving.md): Explains how the Java RTO API context thread receives messages asynchronously from the socket and dispatches them to consumer callbacks. #### API Best Practices > Recommendations for building high-performance, reliable Java RTO API applications — covering threading models, memory management, and infrastructure resilience. - [API Best Practices](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/JavaRTO-API-Best-Practices.md): Index of best practice topics for the Java RTO API, covering threading, memory management, and error handling. - [Java RTO API Best Practices](https://docs.solace.com/API/API-Developer-Guide-JavaRTO/Java-RTO-API-Best-Practices.md): Best practices and recommendations for developing high-performance Java RTO API applications, including threading model selection and context thread affinity. ### Reference for the Solace Messaging API for Java RTO Online Java RTO API reference of classes, methods, and interfaces, plus release notes of changes and fixes by version. - [Java RTO API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/jrto/index.html): Online API reference documentation for the Solace Java RTO API, listing classes, methods, and interfaces. - [Java RTO API Release Notes](https://products.solace.com/download/JAVA_RTO_API_RN): Release notes for the Solace Java RTO API, listing changes and fixes by version. ## JavaScript API > The Solace Messaging API for JavaScript API developer guide for understanding how to build messaging applications using JavaScript or Node.js to publish/subscribe messages from a Solace event broker. ### JavaScript and Node.js API Concepts The fundamental architecture of the Message APIs for JavaScript and Node.js APIs — core objects (contexts, sessions, factories), messaging domains (Direct and Guaranteed), delivery modes, and how destinations, subscriptions, and endpoints relate to each other. - [Messaging API Concepts](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Core-Messaging-API-Concepts.md): Introduces the core concepts of the JavaScript API, including messaging domains (point-to-point and publish/subscribe) and key features such as Direct and Guaranteed messaging, subscriptions, and structured data types. - [Message Delivery Modes](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Message-Delivery-Modes.md): Describes the three message delivery modes—Direct (at-most-once), Non-Persistent, and Persistent/Guaranteed (at-least-once)—and how each affects delivery reliability. - [Guaranteed Message Flows](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Guaranteed-Message-Flows.md): Explains flows as API objects for sending and receiving Guaranteed messages; for the JavaScript and Node.js APIs, a producer flow is automatically established when a session starts. - [Destinations, Subscriptions, and Endpoints](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Destinations-Subscripti.md): The following figure shows the basic relationship between destinations, subscriptions, and endpoints. - [Contexts](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Contexts.md): The messaging APIs use processing contexts for organizing communication between an application and a Solace event broker. - [Factories](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Factories.md): The `solace.SolclientFactory` singleton is the primary entry point for creating contexts, sessions, destinations, and endpoint instances. - [Sessions](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Sessions.md): When a context is established, one or more sessions can be created within that context. - [Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Messages.md): A message is a packet of information sent from producers to consumers. ### Creating Client Sessions How to connect a client to a Solace event broker — covering API initialization, session creation, required connection properties, session events, authentication schemes, keepalives, and message property management. - [Initializing and Monitoring APIs](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Initializing-and-Monitoring-APIs.md): Covers how to initialize the JavaScript and Node.js APIs using `SolclientFactory.init()`, including behavior profiles for controlling default property values. - [Creating Client Sessions](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Client-Sessions.md): A session is a single client connection to the event broker for sending and receiving messages; covers creating sessions with `SolclientFactory.createSession()` and setting session properties. - [Handling Session Events](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Handling-Session-Events.md): Session events provide information about connection state changes, including connection establishment, disconnection, and error conditions; applications must register session event listeners for each important event. - [Session Properties Required to Establish a Connection](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Session-Props-Required.md): Lists the session properties that must be configured to connect to the event broker, including authentication scheme, client name, host, and message VPN. - [Configuring Connection Time-Outs and Retries](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Configuring-Connection-T.md): Covers how to set connection time-out, connect retries, reconnect retries, and reconnect retry wait values to control client reconnection behavior. - [Defining Client Authentication Info](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Defining-Client-Authentication.md): Covers how to configure basic, client certificate, and OAuth authentication schemes for client connections to the event broker. - [Detecting Event Broker Capabilities](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Detecting-Msg-Broker-Capabil.md): Explains how to query which event broker features are available to the connected client using `Session.getCapability()` and `Session.isCapable()`. - [Managing Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Manage-Message-Properties.md): Explains how to get and set message properties on created or received messages, and how to display message contents. ### Publishing Direct Messages How to publish Direct (at-most-once delivery) messages — creating topics, building messages, setting routing properties, attaching data payloads, and sending. - [Publishing Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Publishing-Direct-Messages.md): Explains how to publish Direct messages to topic destinations using the publish/subscribe model, and how Direct messages differ from Guaranteed messages in delivery reliability. - [Creating Topics](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Topics-1.md): Covers how to create topic destination instances using `SolclientFactory.createTopicDestination()`, including non-temporary and temporary topics. - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Messages.md): Explains how to create `solace.Message` objects for publishing, covering the session-independent message ownership model, message types, and resetting messages for reuse. - [Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Setting-Message-Properti.md): You can set important message properties for messages to be published. - [Creating Custom Header Fields](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Custom-Header-Fields.md): Explains how to add custom user property fields to message headers using an SDT map passed to `setUserPropertyMap()`. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Adding-Data-Payloads-1.md): Covers how to add XML content, binary attachments, user property maps, and user data to message payloads. #### Receiving Direct Messages > Receive Direct messages by managing topic subscriptions (wildcards and reapply-on-reconnect) and processing them through a session-level message listener, including discard indications and request replies. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Receiving-Direct-Messages.md): This section describes how to receive and manage Direct messages using the Solace Messaging APIs. - [Managing Subscriptions](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Managing-Subscriptions.md): Explains how topic subscriptions work and the session-level controls that affect subscription operations, including wildcard support and reapply-on-reconnect behavior. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Receiving-Direct-Message.md): Covers how to receive Direct messages using session message listeners, handle message discard indications, and reply to request messages. #### Publishing Guaranteed Messages > Publish Guaranteed (at-least-once, persistent) messages to queues or topic endpoints using a producer flow: create messages, add payloads, send with Session.send(), and handle broker acknowledgments, including request-reply. - [Publishing Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Publishing-Guaranteed-Messages.md): Explains how to publish Guaranteed messages to queue or topic destinations using a producer flow, and the event broker configuration required to spool those messages. - [Acknowledging Published Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Acknowledging-Published-.md): Published Guaranteed messages are acknowledged when they are received by the Solace event broker. - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Messages-1.md): Explains how to create messages for Guaranteed publishing using the session-independent message ownership model, covering message types, destinations, and delivery modes. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Adding-Data-Payloads.md): Covers how to add XML content, binary attachments, user property maps, and user data to messages in the context of Guaranteed messaging. - [Sending Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Sending-Guaranteed-Messages.md): Covers how to send Guaranteed messages using `Session.send()`, including adjusting the publish window size and acknowledgment timer for high-latency environments. - [Request Reply Messaging](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Request-Reply-Messaging.md): Provides an overview of implementing request-reply messaging with Guaranteed messages, covering how to publish requests, reply to them, and correlate replies using a correlation ID. #### Receiving Guaranteed Messages > How to consume Guaranteed messages by creating consumer flows bound to queues or topic endpoints, adding topic subscriptions to queues, and acknowledging received messages. - [Receiving Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Receiving-Guaranteed-Messages.md): Explains the endpoint types (queues and topic endpoints) that Guaranteed messages are delivered to, and the event broker configuration required for clients to receive Guaranteed messages. - [Adding Subscriptions to Endpoints](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Adding-Topic-Subscriptio.md): Explains how to add or remove topic subscriptions on a queue so messages published to matching topics are delivered to that queue. - [Creating Flows](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-Flows.md): A flow is the API object for receiving Guaranteed messages from an endpoint; covers how to create flows using `Session.createMessageConsumer()` with flow properties, endpoint binding, and event handlers. - [Acknowledging Messages Received by Clients](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Acknowledging-Messages.md): Covers the two acknowledgment modes (auto and client) for Guaranteed messages received on a flow, and how to configure the acknowledgment timer and window. ### Using Structured Data Types How to use Solace Structured Data Types (SDTs) — typed, language-independent containers — as message payloads in the JavaScript and Node.js APIs. - [Using Structured Data](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Using-Structured-Data.md): SDTs are structured, language-independent, and architecture-independent data types. - [SDT Containers](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-SDT-Containers.md): Describes the two SDT container types—maps (keyed lookups) and streams (sequential access)—and the operations each supports. - [Creating Structured Data Maps and Streams](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Creating-SD-Maps-Streams.md): Explains how to create message-independent SDT maps and streams using `SDTMapContainer` and `SDTStreamContainer`, and how to add them to messages. ### Best Practices for the JavaScript API The single-threaded execution model of the JavaScript and Node.js APIs, how the API handles threading internally for publishing and message delivery, and recommended practices for writing robust production applications. - [Thread Safety](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Thread-Safety.md): Lists which API elements have built-in thread safety and which require the application developer to manage thread safety themselves. - [API Threading](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-API-Threading.md): Explains how the JavaScript and Node.js APIs handle threading for publishing and receiving messages; both APIs are single-threaded including message delivery notifications. ### Reference for the Solace Messaging API for JavaScript Online JavaScript API reference of classes, methods, and properties, plus release notes of changes and fixes by version. - [JavaScript API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/js/index.html): Online API reference documentation for the Solace JavaScript API, listing classes, methods, and properties. - [JavaScript API Release Notes](https://products.solace.com/download/JS_API_RN): Release notes for the Solace JavaScript API, listing changes and fixes by version. ## JCSMP API > The Solace JCSMP (Java) messaging API developer guide — core concepts, connecting and authenticating, publishing and receiving Direct and Guaranteed messages, transactions, and best practices for building production apps with the Solace JCSMP API. - [JCSMP API](https://docs.solace.com/API/Messaging-APIs/JCSMP-API/jcsmp-api-home.md): Solace JCSMP (Java) API — release notes, developer guide, API reference, and the Avro/JSON SERDES API documentation. - [JCSMP API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Developer-Guide-Home.md): Guide home page — introduces Contexts, Sessions, and Flows as the three core processing concepts, with links to the sections below. #### Getting Started > Install the API, set up your build, and get a sample running — optionally with AI-assisted development — before diving into concepts. - [Quick Start](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Quick-Start.md): Fastest path to a running app for experienced developers — build a clean JCSMP project and run the samples against a running event broker. - [Installation](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Installation.md): Unzip the JCSMP archive and locate the docs, lib, license, and samples subdirectories. - [Building Java Projects with Maven](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Building-Projects-With-Maven.md): Obtain sol-jcsmp (and sol-common) artifacts from Maven Central, or install/deploy .jar and .pom files to a local or remote Maven repository; note JCSMP 10.29+ requires Netty 4.2.7+ and is incompatible with Spring Boot 3.x. - [Developing JCSMP Applications Using AI](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Developing-With-AI.md): Use Solace's AI agent plugin (SolaceProducts/agent-plugins) with AI coding assistants like Claude Code to design and implement JCSMP applications following Solace best practices. #### Core Messaging Concepts > The vocabulary and mental model used throughout the rest of this guide. - [Messaging API Concepts](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Core-Messaging-API-Concepts.md): Point-to-Point (Queue-based) vs. Publish/Subscribe (Topic-based) messaging domains, and a feature overview (connection management, Direct/Guaranteed delivery, SDT, Request/Reply, Queue Browser, cache client support). - [Message Delivery Modes](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Message-Delivery-Modes.md): At-most-once (Direct or Non-Persistent), at-least-once (Guaranteed/Persistent), and Transacted delivery modes, message promotion/demotion behavior, and a cross-protocol (JMS/MQTT/AMQP/REST) terminology comparison. - [Contexts](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Contexts.md): com.solacesystems.jcsmp.Context is the container encapsulating the I/O thread and notification thread that drive sessions. - [Sessions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Sessions.md): com.solacesystems.jcsmp.JCSMPSession provides connection, subscription, destination/endpoint creation, Direct publish-receive and Guaranteed publish, request/reply, flow, browser, and cache session services. - [Guaranteed Message Flows](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Guaranteed-Message-Flows.md): A producer flow is automatically established at session start to send Guaranteed messages; create subscriber flows via session.createFlow() to get a FlowReceiver, and Browsers via session.createBrowser() to inspect spooled messages. - [Destinations, Subscriptions, and Endpoints](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Destinations-Subscripti.md): Topics vs. Queues as destinations, wildcard topic subscriptions, and Queues/Topic Endpoints as endpoints. #### Initializing, Connecting, and Monitoring > Bootstrap an application: create a context, enable diagnostics, and monitor a session once it's running. - [Creating Contexts](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Contexts.md): Create contexts via JCSMPFactory.createContext() (auto-started) and destroy via Context.destroy(); callback rules to avoid blocking the context thread. - [Configuring Logging](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Configuring-Logging.md): Apache Commons Logging (log4j or java.util.logging) with supported log levels and the Kerberos debug system property -Dsun.security.krb5.debug=true. - [Working with Session Statistics](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Working-with-Session-Sta.md): Retrieve session statistics via Session.getSessionStats() and StatType constants like CACHED_MSGS_RECVED, TOTAL_MSGS_SENT, and TOTAL_MSGS_RECVED. #### Creating Client Sessions > Connect to an event broker: required properties, authentication, security, timeouts, and session-level event handling. - [Creating Client Sessions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Client-Sessions.md): Create and connect sessions via JCSMPFactory.createSession()/Session.connect(), and get a Direct message consumer via JCSMPSession.getMessageConsumer(). - [Session Properties Required to Establish a Connection](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Session-Props-Required.md): Required connection properties — Authentication Scheme, Client Name, Host (tcp:/tcps:/ws:/wss:, multi-host lists), Local Host, and Message VPN. - [Configuring Connection Time-Outs and Retries](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Configuring-Connection-T.md): Connection Time-Out, Connect/Reconnect Retries, Reconnect Retry Wait, and Connect Retries Per Host channel properties, plus read-timeout considerations for large messages. - [Defining Client Authentication Info](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Defining-Client-Authentication.md): Basic, Client Certificate, Kerberos, and OAuth2/OIDC authentication schemes via JCSMPProperties.AUTHENTICATION_SCHEME_*, including token-refresh guidance. - [Creating Secure Sessions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Secure-Sessions.md): TLS/SSL session properties (SSL_EXCLUDED_PROTOCOLS, SSL_CIPHER_SUITES, SSL_TRUST_STORE, SSL_VALIDATE_CERTIFICATE, etc.) for encrypted connections. #### Working with Messages, Topics, and Payloads > Building blocks used across Direct and Guaranteed messaging — though some message properties (e.g., Class of Service, Deliver-To-One) apply only to Direct messages. - [Creating Topics](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Topics-1.md): Create non-temporary Topics via JCSMPFactory.createTopic() and temporary Topics via JCSMPSession.createTemporaryTopic(). - [Creating Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Messages.md): Session-independent vs. session-dependent (legacy Producer-pool) message ownership models, the JCSMP message class table (BytesXMLMessage, MapMessage, StreamMessage, TextMessage, etc.), and resetting messages via XMLMessage.reset(). - [Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Setting-Message-Properti.md): Delivery Mode, Destination (topic routing), Deliver-To-One (deprecated in favor of shared subscriptions), Class of Service, Message Eliding Eligibility, and Message Priority. - [Adding Data Payloads](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Adding-Data-Payloads-1.md): XML content, binary attachment, User Property Map, and User Data (up to 36 bytes) payloads, and the 64 MiB max Direct message size. - [Managing Message Properties in the Solace JCSMP API](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Manage-Message-Properties.md): Getting (XMLMessage.get*()) and setting (XMLMessage.set*()) message properties, and the XMLMessage.dump() utility for human-readable message inspection. - [Using Structured Data](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Using-Structured-Data.md): SDT overview, the Java-type mapping table (SDTMap, SDTStream, Destination, RawSMFMessage), and the structured-data-type read/write conversion compatibility matrix. - [Serializing and Deserializing Messages with the Solace JCSMP API](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Serdes.md): SERDES integration for Avro/JSON Schema — AvroSerializer/Deserializer, JsonSchemaSerializer/Deserializer, and Solace Topic ID Strategy profiles, with sync/async serialize-publish and consume-deserialize examples. #### Direct Messaging (Publish/Subscribe) > Use Direct messaging for maximum throughput and lowest latency. Clients need the appropriate ACL profile to publish or subscribe to a topic. - [Sending Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Sending-Messages.md): Acquire an XMLMessageProducer via JCSMPSession.getMessageProducer(), then send() a single message or sendMultiple() up to 50 at once. - [Managing Subscriptions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Managing-Subscriptions.md): Subscribe/unsubscribe via JCSMPSession.addSubscription()/removeSubscription(), DTO, reconnect-durable subscriptions (REAPPLY_SUBSCRIPTIONS), and on-behalf-of subscription management. - [Receiving Direct Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Receiving-Direct-Message.md): Acquire an XMLMessageConsumer via getMessageConsumer(), receive synchronously (receive()/receiveNoWait()) or asynchronously, detect discards via getDiscardIndication(), and reply via XMLMessageProducer.sendReply(). #### Guaranteed Messaging (Queues and Persistence) > Use Guaranteed messaging when messages must survive broker restarts and be acknowledged — requires the appropriate client-profile and ACL permissions. - [Publishing Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Publishing-Guaranteed-Messages.md): Guaranteed (Persistent/Non-Persistent) publishing via an XMLMessageProducer producer flow, the 3-minute flow-expiry-on-disconnect behavior, and required client-profile/ACL config (allow-guaranteed-message-send). - [Acknowledging Published Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Acknowledging-Published-.md): Publish Window Size, windowed vs. per-message acks via JCSMPProperties.ACK_EVENT_MODE, and ack/error callbacks via JCSMPStreamingPublishCorrelatingEventHandler.responseReceivedEx()/handleErrorEx(). - [Creating Guaranteed Messages and Setting Message Properties](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Messages-1.md): Guaranteed-specific message properties — Ack Immediately, Class-of-Service, Correlation ID, DMQ Eligibility, Delivery Mode, Message Priority, Partition Key (QUEUE_PARTITION_KEY), and ReplyTo. - [Sending Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Sending-Guaranteed-Messages.md): Streaming vs. non-streaming publish, the 30 MB max message size (MESSAGE_TOO_LARGE), PUB_ACK_WINDOW_SIZE/PUB_ACK_TIME tuning, and correlation keys via setCorrelationKey(). - [Request Reply Messaging](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Request-Reply-Messaging.md): Guaranteed request-reply using ReplyTo/CorrelationID and a bound reply Flow; Multi-Node Routing (MNR) requires the dedicated request/reply methods to avoid race conditions. - [Receiving Guaranteed Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Receiving-Guaranteed-Messages.md): Consumer-flow binding requirements, client-profile/ACL prerequisites, Queues vs. Topic Endpoints behavior (exclusive/non-exclusive, round-robin), and durable vs. temporary endpoint lifecycle. - [Provisioning and Deprovisioning Durable Endpoints](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Provisioning-Durable-End.md): Admin vs. dynamic provisioning of durable queues/topic endpoints via JCSMPFactory.createQueue()/createDurableTopicEndpoint() plus JCSMPSession.provision()/deprovision(). - [Creating Flows](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Flows.md): JCSMPSession.createFlow() returns a FlowReceiver; the full Flow properties table (Ack Mode/Threshold/Timer, Selector, Guaranteed Message Window Size, No Local, Reconnect Retry Count/Interval) and Flow Auto Reconnect behavior. - [Acknowledging Messages Received by Clients](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Acknowledging-Messages.md): Auto-Ack vs. Client-Ack modes, XMLMessage.ackMessage(), and settlement outcomes via addRequiredSettlementOutcomes()/settle() — ACCEPTED (ACK) or FAILED/REJECTED (NACK). - [Replaying from the Replay Log](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Replay-from-Replay-Log.md): Broker-initiated replay — FLOW_RECONNECTING/REPLAY_STARTED when Flow Reconnect is enabled, or a FLOW_DOWN event requiring session reconnect when it isn't — and client-initiated replay via ConsumerFlowProperties.setReplayStartLocation() (beginning, timestamp, or replication-group message ID). - [Detecting Duplicate Messages](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Detecting-Duplicate-Mess.md): Two dedup techniques using XMLMessage.getReplicationGroupMessageId() — looking up IDs in a database, or comparing them via ReplicationGroupMessageId.compare() — including replication-site failover caveats for the comparison approach. #### Using Local Transactions > Group multiple Guaranteed sends and receives into one atomic unit (256 messages per transaction by default). - [Using Local Transactions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Using-Local-Transactions.md): Local transactions — the 256-message default max per transaction, commit/rollback/auto-new-transaction lifecycle, and single-thread requirements for sync and async consumers. - [Creating Transacted Sessions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Creating-Transacted-Sess.md): JCSMPSession.createTransactedSession() supports at most one producer flow and up to 256 consumer flows. - [Publishing Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Publishing-Messages-Transactions.md): Publish via XMLMessageProducer.send() within a transacted session's producer flow; messages stay staged until commit, and endpoint Message Discard Behavior affects commit success. - [Consuming Messages in Transactions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Consuming-Msgs-in-Transactions.md): Consume via TransactedSession.createFlow(); XMLMessage.ackMessage() has no effect in transacted sessions — commit() is what matters. - [Completing Transactions](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Completing-Transactions.md): TransactedSession.commit()/rollback() are blocking calls; a 3-minute auto-rollback window applies if the session/transaction isn't reestablished after a network failure. #### Threading > The JCSMP threading model: Context I/O and dispatch threads, producer and consumer dispatcher-queue sizing, the 5,000-message Direct queue cap, and which objects are thread-safe (Contexts, Sessions, Flows) versus the application's responsibility (Messages, Transacted Sessions). - [Threading in the Solace JCSMP API](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Threading.md): The Context's I/O/dispatch threading model for publishing (ack-reading + notification-dispatch threads, setProducerDispatcherQueueSize()) and receiving (setConsumerDispatcherQueueSize(), the 5,000-message Direct queue cap, and the MESSAGE_CALLBACK_ON_REACTOR low-latency/deadlock trade-off). - [Thread Safety](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Thread-Safety.md): Contexts, Sessions, and Flows are thread-safe by API design; Messages and Transacted Sessions/Flows are the application's responsibility. #### Performance and Advanced Configuration > Tuning knobs and less-common configuration for production deployments. - [Enabling Channel Compression for a Session](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Enabling-Channel-Compres.md): Set the channel compression level (0-9) via JCSMPChannelProperties.setCompressionLevel(); don't combine with payload compression. - [End-to-End Payload Compression](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Message-Payload-Compression.md): JCSMPProperties.PAYLOAD_COMPRESSION_LEVEL (0-9) for end-to-end payload compression, distinct from broker channel compression. - [Setting Client Keepalives](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Setting-Client-Keepalive.md): Configure Keepalive interval/limit via setKeepAliveIntervalInMillis()/setKeepAliveLimit(); disabling keepalives can delay activity switches when active/active redundancy is used. - [Context Propagation for Distributed Tracing](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Context-Propagation-Distributed-Tracing.md): OpenTelemetry context propagation via auto-instrumentation (-javaagent + solace-opentelemetry-jcsmp-integration) or manual instrumentation (SolaceJCSMPTextMapSetter/Getter). #### Best Practices and High Availability > JCSMP production best practices: binary over XML payloads, Pub/Sub over point-to-point, queues over topic endpoints, always closing sessions/producers/consumers, TCP buffer tuning, batch sending, and the Session/Flow event tables. - [JCSMP Best Practices](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Best-Practices.md): Binary over XML payloads, Pub/Sub over P2P, queues over topic endpoints, always closing sessions/producers/consumers, TCP buffer tuning, subscription management nuances, batch sending, and full Session/Flow event tables. #### Using the Solace JCSMP API with Solace Cache > Request cached messages for Distributed Cache, Cache Cluster, or Cache Instance topics, synchronously or asynchronously, with point-to-point response addressing. - [Using the Solace JCSMP API with Solace Cache](https://docs.solace.com/API/API-Developer-Guide-JCSMP/cache/using-pubsub-cache.md): Make cache requests for Distributed Cache/Cache Cluster/Cache Instance topics, synchronously or asynchronously, with P2P response addressing. #### Reference > Supported environments: OS and platforms, JDK/Java versions, Ant/OSGi build support, supported TLS versions, and Netty dependency compatibility. - [Supported Environments](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Supported-Environments.md): Supported OS/platforms, JDK/Java versions, Ant/OSGi build support, supported TLS versions, and Netty dependency compatibility. ## Jakarta Messaging API > The Solace Jakarta Messaging API developer guide. Jakarta Messaging is the Eclipse Foundation's evolution of the Java Message Service (JMS) specification, and this guide consolidates the former separate "Solace JMS API" guide into one Jakarta-focused guide covering both. The legacy Solace JMS API (javax.jms) remains a separately shipped, fully-supported artifact — Jakarta Messaging (jakarta.jms) is recommended for new development; artifact names and broker configuration retain "JMS" naming for backward compatibility. - [Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/jakarta-get-started-open.md): Solace Jakarta Messaging API — the modern Jakarta EE-compatible evolution of JMS, recommended for new development; the legacy Solace JMS API remains separately supported. Release notes, developer guide, and API reference for both. - [Developer Guide for Solace Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-Dev-Guide-Intro.md): Guide home page — architecture overview (event broker network, JNDI administration, CLI/SolAdmin) and core entities (Connection Factories, Topics, Queues). #### Getting Started > Install the API, set up your build, and understand which artifact (Jakarta vs. legacy javax) applies to your application server before diving into concepts. - [Quick Start](https://docs.solace.com/API/Solace-Jakarta-API/Quick-Start.md): Jakarta Messaging 3.1-compatible, provides JMS 1.1 functionality via the jakarta.jms namespace, and is backward-compatible with JMS 1.0.2b; standalone Java applications only. - [Installation](https://docs.solace.com/API/Solace-Jakarta-API/Installation.md): Two distributions — sol-jms-jakarta (jakarta.jms, Java 11+) and sol-jms (javax.jms, Java 8+); directory contents and CLASSPATH setup. - [Supported Environments](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-API-supported-environments.md): Migrating javax.jms.* imports to jakarta.jms.*, Spring 6.0/Spring Boot 3.0 compatibility, and the Jakarta-based vs. legacy javax-based JCA resource adapters by application server. - [Building Jakarta Messaging Projects with Maven](https://docs.solace.com/API/Solace-Jakarta-API/Building-Jakarta-Projects-With-Maven.md): pom.xml dependency snippets for sol-jms-jakarta/sol-jms/resource adapters, local install and remote deploy commands, and a resource-adapter-selection table by application server. - [Code and Compile Guidelines](https://docs.solace.com/API/Solace-Jakarta-API/Code-and-Compile-Guideli.md): The com.solacesystems.jms.* import, TLS/SSL and Kerberos JVM configuration, Jakarta Commons Logging setup, and the supported JMSX properties table (JMSXGroupID, JMSXGroupSeq, JMSXUserID). - [Building Jakarta Messaging Samples](https://docs.solace.com/API/Solace-Jakarta-API/Building-Jakarta-Samples.md): Jakarta Messaging Tutorials site for sample code and build instructions; legacy javax.jms samples are preserved on a separate branch. #### Core Messaging Concepts > The vocabulary and mental model used throughout the rest of this guide. - [Jakarta Messaging Overview](https://docs.solace.com/API/Solace-Jakarta-API/Solace-Jakarta-Overview.md): The API's three components (API, Solace event broker, SolAdmin), and Solace's two JCA Resource Adapter variants — legacy javax.*-based and modern jakarta.*-based. - [Extensions to Standard Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/Extensions-to-Standard-Jakarta.md): Solace-specific SOLACE_JMS_* properties (Authentication Scheme, Compression Level, DMQ Eligible, Deliver-To-One, Dynamic Durables, OAuth2/OIDC tokens) and SolJmsUtility helper methods. - [Messaging Models](https://docs.solace.com/API/Solace-Jakarta-API/Messaging-Models.md): Publish/subscribe (Topics) vs. point-to-point (Queues, max 1,000 consumers per queue), and Exclusive vs. Non-exclusive queue access types. - [Message Transport Modes](https://docs.solace.com/API/Solace-Jakarta-API/Message-Transport-Modes.md): Guaranteed Transport vs. Direct Transport, the Direct Transport Connection Factory property, durable endpoint provisioning, and a message-type/transport-mode support table. - [Message Types](https://docs.solace.com/API/Solace-Jakarta-API/Message-Types.md): Persistent (once-and-only-once, Guaranteed Transport only) vs. Non-Persistent (at-most-once, usable with Guaranteed or Direct Transport) messages. #### Establishing Connections and Managing Sessions > Look up or programmatically create Connection Factories, authenticate, connect, and manage the resulting Session. - [Establishing Connections](https://docs.solace.com/API/Solace-Jakarta-API/Establishing-Connections.md): JNDI-based lookup via SolJNDIInitialContextFactory, and programmatically creating Jakarta Messaging-administered objects (SolJMSUtility, SolConnectionFactory, SolXAConnectionFactory, SolQueue, SolTopic). - [Connection Factories](https://docs.solace.com/API/Solace-Jakarta-API/Connection-Factories.md): SolConnectionFactory/SolXAConnectionFactory objects, property prioritizing/inheritance across Initial Context/System/JNDI sources, authentication schemes (Basic, Client Certificate, Kerberos, OAuth 2.0), Secure Connections (TLS/SSL), and Authorizing Clients (ACL). - [Obtaining Connection Factories](https://docs.solace.com/API/Solace-Jakarta-API/Obtaining-Connection-Fac.md): Three ways to obtain a factory — programmatic creation via SolJmsUtility.createConnectionFactory(), JNDI lookup from the Solace event broker, or lookup from an external/LDAP JNDI store. - [Creating Jakarta Messaging Connections](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Jakarta-Connections.md): createConnection()/createXAConnection() and their credential overloads, plus starting (Connection.start()) and stopping/closing connections. - [Using Proxy Connections in the Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-API-Proxy-Connection.md): Connect through an HTTP or SOCKS5 proxy using JVM system properties (solace.proxy.host, .type, .port, .username, .password). - [Managing Sessions](https://docs.solace.com/API/Solace-Jakarta-API/Managing-Sessions.md): Session creation (createSession(transacted, acknowledgeMode)), the four acknowledgment modes (including Solace's SOL_CLIENT_ACKNOWLEDGE), connection time-out/retry tuning, the SolConnectionEventListener callback, and closing Sessions. #### Managing Solace JNDI Objects > Provision and inspect the Connection Factory, Topic, and Queue objects that clients look up via JNDI — a CLI/admin task, not client-side API code. - [Solace JNDI Objects](https://docs.solace.com/API/Solace-Jakarta-API/Managing-Solace-JNDI-Objects.md): What the event broker's internal JNDI store provides, JNDI object limits tied to Guaranteed Messaging/ADB, and enabling/disabling JNDI access. #### Publishing Messages > Publish to a Topic or Queue. Guaranteed Transport publishing requires the allow-guaranteed-message-send client-profile parameter and topic-publish ACL permissions. - [Publishing Messages](https://docs.solace.com/API/Solace-Jakarta-API/Publishing-Messages.md): Broker-side prerequisites for publishing (allow-guaranteed-message-send, topic-publish ACLs), and the 30 MB MESSAGE_TOO_LARGE exception for oversized Guaranteed messages. - [Supported Message Types](https://docs.solace.com/API/Solace-Jakarta-API/Supported-Message-Types.md): The six standard Jakarta Messaging body types (Message, StreamMessage, MapMessage, TextMessage, ObjectMessage, BytesMessage) and their session.create*Message() factory calls. - [Setting Message Properties](https://docs.solace.com/API/Solace-Jakarta-API/Setting-Message-Properties.md): Time-to-Live, Dead Message Queue eligibility, Eliding eligibility, Partition Key (JMSXGroupID), and end-to-end payload compression (0-9). - [Creating Message Producers](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Message-Produce.md): session.createProducer(Destination) and configuring default delivery mode, message ID/timestamp suppression, priority, and TTL. - [Working with Destinations](https://docs.solace.com/API/Solace-Jakarta-API/Working-with-Destination.md): JNDI destination lookups, creating temporary destinations, and creating durable Topics/Queues, including dynamic-durable provisioning requirements. - [Sending Messages](https://docs.solace.com/API/Solace-Jakarta-API/Sending-Messages.md): MessageProducer.send() per-call overrides (destination, deliveryMode, priority, timeToLive), and the pre-send hook mechanism (MessageProducerInterceptor). #### Receiving Messages > Consume from a Topic subscription or Queue. Non-durable Guaranteed consumers additionally need allow-guaranteed-message-create to auto-create their temp endpoint. - [Receiving Messages](https://docs.solace.com/API/Solace-Jakarta-API/Receiving-Messages.md): Broker-side prerequisites (allow-guaranteed-message-receive/-create, topic-subscribe ACLs) and the pre-receive hook mechanism (MessageReceiverInterceptor) for intercepting messages before delivery. - [Creating Message Consumers](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Message-Consume.md): session.createConsumer()/XASession.createConsumer(), durable vs. non-durable consumer rules, selective receiving (messageSelector, noLocal), and active/inactive flow indication for exclusive queue consumers. - [Receiving Messages Synchronously or Asynchronously](https://docs.solace.com/API/Solace-Jakarta-API/Receiving-Messages-Synch.md): receive()/receive(timeout)/receiveNoWait() vs. MessageListener.onMessage(), with code samples for both. - [Creating Durable Topic Subscribers](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Durable-Topic-S.md): TopicSubscriber and createDurableSubscriber(Topic, name, messageSelector, noLocal), including dynamic-durable provisioning requirements. - [Selectors](https://docs.solace.com/API/Solace-Jakarta-API/Selectors.md): SQL92-subset selector syntax (2000-byte limit) for MessageConsumer/QueueBrowser filtering, and the Jakarta-to-Solace selector identifier mapping table. #### Request-Reply and Load Balancing > Synchronous request-reply with TopicRequestor and QueueRequestor: publish to a topic or queue and wait on an auto-created temporary destination used as JMSReplyTo. - [Using Topic Requestors](https://docs.solace.com/API/Solace-Jakarta-API/Using-Topic-Requestors.md): TopicRequestor — synchronous publish-to-topic-and-wait using an auto-created temporary topic as JMSReplyTo. - [Using Queue Requestors](https://docs.solace.com/API/Solace-Jakarta-API/Using-Queue-Requestors.md): QueueRequestor — synchronous publish-to-queue-and-wait using an auto-created temporary queue as JMSReplyTo. #### Using Local Transactions > Group multiple Guaranteed sends and receives into one atomic unit (256 messages per transaction by default). Direct messages are excluded; requires allow-transacted-sessions. - [Using Transacted Sessions](https://docs.solace.com/API/Solace-Jakarta-API/Using-Transacted-Sessions.md): Per-client transacted Sessions, the 256-message-per-transaction default, and single-thread access rules for sync/async consumers. - [Creating Transacted Sessions](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Transacted-Sess.md): Connection.createSession(true, acknowledgeMode); one producer flow and up to 256 consumer flows per transacted Session. - [Publishing Messages in Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Publishing-Messages-in-T.md): Publish via a MessageProducer from the transacted Session; how reject-msg-to-sender-on-discard affects commit success. - [Consuming Messages in Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Consuming-Messages-in-Tr.md): Message.acknowledge() has no effect in transacted Sessions — commit() is what matters; TTL-expired/admin-removed messages still commit. - [Completing or Canceling Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Complete-or-Cancel-Transactions.md): commit()/rollback(), TransactionRolledBackException on commit failure, and the 3-minute auto-rollback window on reconnect failure. #### Using XA Transactions > Coordinate Jakarta Messaging operations with other resources (e.g., a database) under a Transaction Manager via the JTA/XA two-phase commit protocol. - [Using XA Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Using-XA-Transactions.md): JTA/XAResource-based distributed transactions, transaction branches vs. global transactions, two-phase commit, and that Solace doesn't provide its own Transaction Manager. - [Steps for Performing XA Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-Steps-for-XA.md): End-to-end procedure — obtain an XAConnectionFactory, create an XA Connection and Session, acquire a producer/consumer, obtain an XAResource and unique Xids, call start(), publish/consume (up to 256 messages per branch), call end() then prepare(), then repeat for the next transaction or close the XA Session. - [Creating XA Connections](https://docs.solace.com/API/Solace-Jakarta-API/Creating-XA-Connections.md): createXAConnection() with direct-transport=false/xa=true factory properties, and XASession.createXASession(); one active branch per XA Session. - [Publishing Messages in XA Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Publishing-Messages-in-XA.md): Publish via XASession.createProducer(); messages sent before XAResource.start() are non-transacted. - [Consuming Messages in XA Transactions](https://docs.solace.com/API/Solace-Jakarta-API/Consuming-Messages-in-XA.md): Consume via XASession.createConsumer(); queue-binding exclusivity between XA and non-XA consumers, and the 256-message-per-branch cap (XAException on overflow). - [Performing XA Transaction Operations](https://docs.solace.com/API/Solace-Jakarta-API/Performing-XA-Transactio.md): The full XAResource reference — Xid format, the transaction state machine (Active/Idle/Prepared/Heuristically Completed/Free), start()/end()/prepare()/commit()/rollback() flag semantics, forget() for heuristically-completed branches, and recover() for recovering prepared transactions after a server failure. - [Closing XA Sessions](https://docs.solace.com/API/Solace-Jakarta-API/Closing-XA-Sessions.md): Session.close() rolls back any active uncommitted transaction, unbinds producers/consumers, and throws XAException on outstanding or post-close operations. #### Threading and Distributed Tracing > Per-connection context threads, synchronous versus asynchronous consumer threading and the 5,000-message Direct queue limit, plus OpenTelemetry context propagation (auto- and manual instrumentation) for distributed tracing. - [Threading](https://docs.solace.com/API/Solace-Jakarta-API/Threading.md): Per-connection context threads for I/O and dispatch, synchronous vs. asynchronous consumer threading, the 5,000-message Direct queue limit, and the resizable consumer dispatcher queue. - [Context Propagation for Distributed Tracing](https://docs.solace.com/API/Solace-Jakarta-API/Context-Propagation-Distributed-Tracing.md): OpenTelemetry tracing via auto-instrumentation (Java agent + solace-opentelemetry-jms-integration) or manual instrumentation (SolaceJmsW3CTextMapSetter/Getter). #### Interoperability > Creating Jakarta-compatible messages from the JCSMP, C, .NET, and JavaScript APIs, and Schema Registry SERDES (Avro and JSON Schema) serialization and deserialization. - [Creating Jakarta-Compatible Messages With Other APIs](https://docs.solace.com/API/Solace-Jakarta-API/Creating-Jakarta-Compatible-Msgs.md): How JCSMP, C, .NET, and JavaScript APIs construct messages the Jakarta Messaging API interprets as BytesMessage, MapMessage, StreamMessage, or TextMessage (ObjectMessage is not creatable by non-Jakarta APIs). - [Serializing and Deserializing Messages with the Solace Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-API-SERDES.md): Schema Registry SERDES integration for Avro and JSON Schema — AvroSerializer/Deserializer, JsonSchemaSerializer/Deserializer; ObjectMessage is unsupported with SERDES. #### Properties Reference > The seven property sources and their priority order, plus the Initial Context, JNDI and data connection, SSL, message-delivery, message, and API property references. - [Jakarta Messaging Properties Reference](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-Properties-Reference.md): The seven property sources and their priority order — Initial Context, System (-D flags), JNDI properties file, URL, Connection Factory, API, and Message. - [Initial Context Property](https://docs.solace.com/API/Solace-Jakarta-API/Initial-Context-Property.md): The Initial Context Factory property, which must be com.solacesystems.jndi.SolJNDIInitialContextFactory. - [JNDI Connection Properties](https://docs.solace.com/API/Solace-Jakarta-API/JNDI-Connection-Properti.md): Properties governing the JNDI lookup connection — Authentication Scheme, Compression Level, Connect/Reconnect Retries, Consumer/Producer Interceptors, JAAS Login Context, and SSL. - [Data Connection Properties](https://docs.solace.com/API/Solace-Jakarta-API/Data-Connection-Properti.md): Properties governing the messaging connection — Host/Port/URL/VPN, Keep-Alive, Compression Level, Connect/Reconnect Retries, Authentication Scheme (including OAuth2/OIDC), and XA enablement. - [Data Connection Properties - SSL Related](https://docs.solace.com/API/Solace-Jakarta-API/SSL-Related-Conn-Prop.md): SSL Certificate Validation, Cipher Suite, Key Store/Trust Store, Excluded Protocols, and Trusted Common Name List. - [Message Delivery Properties](https://docs.solace.com/API/Solace-Jakarta-API/Message-Delivery-Propert.md): Direct Transport (and Optimization), the Guaranteed Message property family (Ack Threshold/Timer, Window Size, Reconnect Retry Count/Interval), and Deliver-To-One properties. - [Message Properties](https://docs.solace.com/API/Solace-Jakarta-API/Message-Properties.md): Dead Message Queue Eligible, Delivery Count/Mode, Discard Indication, Eliding Eligible, HTTP Content Type, XML Payload, End-to-End Payload Compression, and Deliver-To-One. - [API Properties](https://docs.solace.com/API/Solace-Jakarta-API/API-Properties.md): Client-API-level tuning — Consumer/Producer Dispatcher Queue Size, Dead Message Queue Name, Dynamic Durables, Respect Time-To-Live, and Use Default Context. ## Node.js API > The Solace Messaging API for Node.js developer guide for understanding how to build messaging applications using Node.js to publish and subscribe to messages from a Solace event broker. - [Getting the Node.js API Library Using npm](https://docs.solace.com/API/API-Developer-Guide-JavaScript/JavaScript-API-Getting-Node.js-API-Library-Using-npm.md): Node.js applications load the Solace Node.js API library module to make use of the API. The Messaging API for Node.js is essentially the same as the Solace Messaging API for JavaScript. For more detailed information, see the https://docs.solace.com/Content/llms/messaging-apis-javascript.txt ## Python API > The Solace Messaging API for Python developer guide for understanding how to build messaging applications using Python to publish and subscribe to messages from a Solace event broker. - [Solace Python API Developer Guide](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Dev-Guide.md): The Solace Messaging API for Python (version 1.11) provides modern development patterns and usability. - [Builder Pattern Usage in the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Builder-Pattern.md): Explains the builder design pattern used throughout the Python API to create instances of messages, messaging services, publishers, and receivers. - [Developing Python Applications Using AI](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Developing-With-AI.md): Use Solace's AI agent plugin (SolaceProducts/agent-plugins) with AI coding assistants like Claude Code to design and implement Python applications following Solace best practices. - [Messaging Service](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Messaging-Service.md#Messaging-Service): Describes the MessagingService class, which is the entry point for configuring and establishing a connection to a Solace event broker. #### Publishing Messages > Publish direct messages (high-throughput, low-latency) and persistent/guaranteed messages with PersistentMessagePublisher, including publisher setup and acknowledgment handling. - [Publishing Messages](https://docs.solace.com/API/API-Developer-Guide-Python/publishing-messages.md): Overview of message publishing in the Python API, introducing both direct and persistent delivery modes. - [Publishing Direct Messages Using the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-DM-Publish.md): Direct messages are useful when high-throughput and low-latency is required. - [Publishing Persistent Messages Using the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-PM-Publish.md): How to publish persistent (guaranteed) messages using the PersistentMessagePublisher, including setup requirements and acknowledgment handling. #### Receiving Messages > Consume direct and persistent messages (PersistentMessageReceiver), use Solace Cache for direct messaging, provision durable and non-durable queues and browse them, plus local transactions, distributed tracing, and request-reply. - [Receiving Messages](https://docs.solace.com/API/API-Developer-Guide-Python/receiving-messages.md): Overview of message consumption in the Python API, introducing how clients subscribe to topics and consume messages. - [Consuming Direct Messages Using the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-DM-Receive.md): Direct messaging is useful in scenarios where high-throughput and low-latency is required. - [Using Solace Cache With the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-PubSub-Cache.md): Solace Cache is a scalable, in-memory message cache for direct messaging. - [Consuming Persistent Messages Using the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-PM-Receive.md): How to consume persistent (guaranteed) messages from a queue using PersistentMessageReceiver, including setup and acknowledgment. - [Creating Queues with the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Create-Queues.md): How to provision durable and non-durable queues on the event broker from a Python application using PersistentMessageReceiverBuilder. - [Browsing Queues with the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Browse-Queues.md): How to browse guaranteed messages in a queue in order without consuming them, and optionally remove browsed messages. - [Using Local Transactions in the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Local-Transactions.md): How to group guaranteed message publish and receive operations into atomic local transactions using TransactionalMessagingService, with commit and rollback semantics. - [Context Propagation for Distributed Tracing in the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Distributed-Tracing.md): How to enable OpenTelemetry-based distributed tracing in Python applications by injecting and extracting trace context into and from Solace messages. - [Request-Reply Messaging in the Solace Python API](https://docs.solace.com/API/API-Developer-Guide-Python/Python-API-Request-Reply.md): How to implement the request-reply messaging pattern using separate point-to-point channels for requests and replies in the Python API. ### Reference for the Solace Messaging API for Python Online Python API reference of classes, methods, and modules, plus release notes of changes and fixes by version. - [Python API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/python/index.html): Online API reference documentation for the Solace Python API, listing classes, methods, and modules. - [Python API Release Notes](https://products.solace.com/download/PYTHON_API_RN): Release notes for the Solace Python API, listing changes and fixes by version. ## iOS API > The Solace Messaging API for iOS developer guide for understanding how to build messaging applications using iOS to publish and subscribe to messages from a Solace event broker. - [iOS API](https://docs.solace.com/API/Messaging-APIs/iOS-API/iOS-api-home.md): The Solace Messaging API for iOS is a native wrapper of the Solace C API. The Messaging API for iOS uses the Solace Messaging API for C. For more detailed information, see the https://docs.solace.com/Content/llms/messaging-apis-c.txt ## IPC Guide > The Solace IPC (Inter-Process Communication) developer guide for understanding how to build messaging applications using the C IPC add-on to publish and subscribe to messages from a Solace event broker with ultra-low latency transport. - [IPC Guide](https://docs.solace.com/API/IPC/IPC-Guide.md): Introduces the Inter-Process Communications (IPC) add-on for the C and Java RTO APIs, which enables applications co-residing on a host to communicate directly over shared memory or TCP for ultra-low latency or reduced event broker bandwidth. - [Client Application Sessions](https://docs.solace.com/API/IPC/Client-App-Sessions.md): Describes IPC multi-point sessions, which let one application establish direct communication channels to multiple peers and route messages based on subscriptions, bypassing the event broker. - [IPC Routing Behavior](https://docs.solace.com/API/IPC/IPC-Routing-Behavior.md): Explains how a multi-point session routes outgoing messages to peer applications based on their subscriptions, and why applications can only exchange messages with peers they have a direct connection to (requiring a full mesh for all-to-all communication). - [Limitations](https://docs.solace.com/API/IPC/Limitations.md): Lists IPC constraints: Direct messaging only (no Guaranteed messaging), shared memory limited to same-architecture peers, no security model for incoming connections, and no Message VPN or ACL enforcement. - [Context Threading Models](https://docs.solace.com/API/IPC/Context-Threading-Models.md): Covers how IPC uses separate threads for TCP and shared memory transports, and how to configure the shared memory thread to spin continuously for lowest latency or block to preserve CPU resources. - [Configuring Inter-Process Communications](https://docs.solace.com/API/IPC/Configuring-IPC-Communications.md): Lists the context and session properties for configuring IPC, including thread affinity, shared memory spin settings, and other transport-specific options. - [SolGateway](https://docs.solace.com/API/IPC/SolGateway.md): Documents SolGateway, a bridge application that connects local IPC peers to a Solace event broker so they can exchange messages with broker-connected applications without each application needing its own broker session. - [Using IPC with SDKPerf](https://docs.solace.com/API/IPC/Using-IPC-with-the-SDKPerf-Tool.md): Shows sdkperf_c command-line examples for testing IPC over shared memory and TCP, including how to set spin mode and processor affinities for lowest-latency benchmarking. ## SDKPerf > The Solace SDKPerf performance testing and benchmarking tool guide for understanding how to publish and receive messages from a Solace event broker to test messaging application performance. ### Using SDKPerf SDKPerf can benchmark event broker performance: the tool and its language variants (C, Java, C#, JavScript, Jakarta (JMS), REST, Python), the command-line options reference (connection, publishing, subscribing, and performance settings; -hm for the full list), and example commands. For the most up-to-date help, it is recommended to see the `-hm` option to see all the options beacuse the documentation only lists a small subset. - [Using SDKPerf](https://docs.solace.com/API/SDKPerf/SDKPerf.md): SDKPerf is a non-production tool for validating performance, checking configuration, and exploring features of a Solace event broker, available in variants for C, Java, Jakarata (JMS), C#, Python, REST, JavaScriptand other languages. - [Command Line Options for SDKPerf](https://docs.solace.com/API/SDKPerf/Command-Line-Options.md): Reference for the commonly used SDKPerf command line options covering connection, publishing, subscribing, and performance settings; run with `-hm` at startup to see the full option list. - [Example Commands for SDKPerf](https://docs.solace.com/API/SDKPerf/Example-Commands.md): Usage of SDKPerf examples with with brief descriptions of the test performed. ## AMQP > Using AMQP 1.0 with Solace brokers: getting started, why AMQP, developer subjects, and language-specific tutorials. #### Using AMQP 1.0 > How AMQP 1.0 works with Solace — covering the protocol, supported APIs, addressing conventions, and the rules for publishing and consuming messages. - [Using AMQP 1.0](https://docs.solace.com/API/AMQP/Using-AMQP.md): AMQP 1.0 is an OASIS-standardized wire-line protocol; Solace event brokers can act as AMQP 1.0 brokers, so any compliant client can interact with them as with any other AMQP broker. - [Why Solace Support for AMQP 1.0?](https://docs.solace.com/API/AMQP/Why-AMQP.md): Explains multi-protocol environments where a Solace event broker routes messages between entities using different protocols (MQTT, REST, AMQP), eliminating the need for separate brokers per protocol. - [Reference Information for Developers](https://docs.solace.com/API/AMQP/Developer-Subjects.md): The event broker supports the AMQP 1.0 broker role. - [API Recommendations for AMQP](https://docs.solace.com/API/AMQP/AMQP-API-Rec.md): Lists AMQP client APIs known to work with the Solace PubSub+ AMQP implementation, organized by environment and language, with recommended and alternative options. - [Client Support](https://docs.solace.com/API/AMQP/Client-Support.md): Documents feature limitations and restrictions for AMQP clients connecting to the event broker, covering ACLs, Guaranteed Messaging, and other broker features. - [Addressing Support for AMQP Non-JMS APIs](https://docs.solace.com/API/AMQP/Non-JMS-API-Addressing.md): Describes Solace's syntactic convention for specifying destinations when publishing and sources when consuming via non-JMS AMQP APIs, which lack the JMS protocol field to distinguish topics from queues. - [Message Publication](https://docs.solace.com/API/AMQP/Msg-Pub.md): Covers the two methods for specifying publish destinations in non-JMS AMQP APIs — via the sending link attach frame or per-message properties — with rules for queues, topics, and temporary endpoints. - [Rules for Destination Specification](https://docs.solace.com/API/AMQP/Rules-Dest-Spec.md): Specifies target capability settings in the AMQP attach frame that determine how the event broker interprets the publication destination, including queue, topic, and anonymous relay modes. - [Specifying the Message Quality of Service](https://docs.solace.com/API/AMQP/QoS.md): Explains how to set the Quality of Service level for AMQP messages using Send-Settle-Mode and the Durable header field, controlling whether messages are delivered as Persistent, Non-Persistent, or Direct. - [Message Consumption](https://docs.solace.com/API/AMQP/Msg-Con.md): Covers the rules for specifying consumption sources in non-JMS AMQP APIs, including how to bind to durable queues, non-durable queues, durable topic endpoints, and non-durable topics. - [Specifying Sources for Message Consumption](https://docs.solace.com/API/AMQP/Con-Rules.md): Details the source capability settings in the AMQP attach frame that determine how the event broker interprets the consumption source, covering queue and topic capabilities with their binding behaviors. ### Reference for AMQP for Solace Event Broker The AMQP Conformance when using the protocol with Solace event brokers. - [AMQP 1.0 Protocol Conformance](https://docs.solace.com/API/AMQP/AMQP-Protocol-Conformance.md): Documents functionally-visible restrictions, limitations, and non-conformances between the OASIS AMQP 1.0 specification and the Solace implementation, noting that Solace supports only the server-side broker role. ## MQTT 5.0 > Using MQTT with Solace brokers when working with MQTT 5.0: getting started, MQTT concepts and features, session and topic handling, tutorials, and the annotated MQTT 5.0 protocol conformance specification. The general MQTT pages apply to both MQTT 3.1.1 and 5.0; for the other version's specification, see open-apis-mqtt-311.txt. - [MQTT](https://docs.solace.com/API/MQTT/MQTT-get-started.md): Introduces MQTT support on Solace event brokers and links to the annotated MQTT 3.1.1 and 5.0 protocol conformance specifications and the MQTT tutorials. #### MQTT Concepts and Features > How specific MQTT features work on a Solace event broker — sessions, quality of service, will and retained messages, shared subscriptions, payload handling, special topics, and tutorials — and how MQTT interoperates with clients that use Solace Message Format (SMF) messages and REST messages. - [Using MQTT](https://docs.solace.com/API/MQTT/Using-MQTT.md): Explains that Solace event brokers support MQTT v3.1.1 and v5.0, and describes how MQTT clients connect to a Message VPN, including MQTT sessions and session durability. - [API Recommendations for MQTT](https://docs.solace.com/API/MQTT/MQTT-API-Rec.md): Lists, by language and environment, the MQTT client APIs known to work with the Solace MQTT implementation; none are produced or supported by Solace. - [MQTT Topic Structure and Syntax](https://docs.solace.com/API/MQTT/MQTT-Topics.md): As a publish/subscribe messaging protocol, MQTT relies on hierarchical topics. - [MQTT Sessions](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-sessions): Explains that an MQTT client connects to a Message VPN through a dedicated MQTT port and requires an MQTT session, a managed object that holds the client's topic filters and undelivered QoS 1 messages. - [MQTT Session Durability](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-session-persistence): Describes how durable sessions survive client disconnects, restarts, and HA failovers, and how session behavior differs between MQTT v3.1.1 (CleanSession) and v5.0 clients. - [Quality of Service Levels](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-qos-levels): Enumerates and describes the MQTT QoS levels and how they map to Solace message delivery modes, with QoS 0 equivalent to Direct and QoS 1 equivalent to Guaranteed. - [Payload Handling When Message Types Change](https://docs.solace.com/API/MQTT/Using-MQTT.md#payload-conversion): Explains how message payloads are converted when MQTT messages are delivered to SMF or REST clients, and when SMF or REST messages are delivered to MQTT clients. - [Will Messages](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-will-messages): Describes "last will and testament" messages that an MQTT client registers at connect time and the broker sends if the client disconnects unexpectedly, including cases where will messages are not sent. - [Retained Messages](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-retained-messages): Explains how the broker stores messages published with the retain bit set and delivers the latest one to clients when they subscribe to a matching topic; this is a Controlled Availability feature. - [MQTT Retain Caches](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-retain-caches): Describes how retained messages are stored and selected using special cache clusters called MQTT retain caches, and the ancillary objects the broker creates with each one. - [Shared Subscriptions](https://docs.solace.com/API/MQTT/Using-MQTT.md#Shared_Subscriptions): Explains how MQTT v3.1.1 and v5.0 clients can use shared subscriptions to load balance data across multiple application instances, and the considerations for implementing them, such as QoS 0 only. - [Special Characters in MQTT Topic Names and Filters](https://docs.solace.com/API/MQTT/MQTT-Topics.md#mqtt-topic-name-syntax): Explains how the broker interprets special characters in MQTT topic names and filters, such as "+", "#", a leading "!", and "$share" shared subscription filters. - [Topic Recommendations for Inter-protocol Messaging](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Publishi): Gives guidance on using a common topic syntax so MQTT and non-MQTT (SMF or REST) clients can exchange messages over intersecting topic hierarchies. - [Using Subscription Managers with MQTT Clients](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Using): Explains how clients configured as Subscription Managers can add or remove QoS 0 topic filters on behalf of other MQTT clients in the same Message VPN. - [Special MQTT Topics](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Special): Describes the reserved topics beginning with "$" that the broker uses to implement MQTT features, such as retrieving the client name or reply-to destination for a session. - [Get Started with MQTT Messaging Tutorials](https://docs.solace.com/API/MQTT/MQTT-get-started.md#MQTT-Tutorials): Introduces the MQTT tutorials, which cover common messaging requirements such as publish/subscribe, message persistence, and request/reply. #### Using MQTT 5.0 > How MQTT clients connect to and exchange messages with a Solace event broker using MQTT 5.0 — covering sessions, topic syntax, compatible client APIs, and the annotated MQTT v5.0 protocol conformance specification with Solace implementation notes. - [MQTT 5.0: Introduction](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-abstract-notices.md): MQTT is a lightweight client/server publish/subscribe messaging transport protocol ideal for use in M2M and IoT - [MQTT 5.0: Introduction](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-1-introduction.md): Solace Implementation Note - [MQTT 5.0: MQTT Control Packet format](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-2-control-packet-format.md): The MQTT protocol operates by exchanging a series of MQTT Control Packets in a defined way. - [MQTT 5.0: MQTT Control Packets](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-3-control-packets.md): Describes the MQTT v5.0 control packets, such as CONNECT, PUBLISH, and SUBSCRIBE, including their headers, properties, and reason codes. - [MQTT 5.0: Operational behavior](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-4-operational-behavior.md): Describes MQTT v5.0 operational behavior, including session state and expiry, QoS message flows, and error handling. - [MQTT 5.0: Security (non-normative)](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-5-security.md): Gives non-normative security guidance for MQTT v5.0 implementations, including the recommended use of TLS on TCP port 8883 and threats to consider. - [MQTT 5.0: Using WebSocket as a network transport](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-6-using-websocket-as-network-transport.md): Describes the conditions for carrying MQTT v5.0 over WebSocket, including binary data frames and the required "mqtt" subprotocol name. - [MQTT 5.0: Conformance](https://docs.solace.com/API/MQTT-v50-Prtl-Conformance-Spec/mqtt-v50-7-conformance.md): The MQTT specification defines conformance for MQTT Client implementations and MQTT Server implementations. ## MQTT 3.1.1 > Using MQTT with Solace brokers when working with MQTT 3.1.1: getting started, MQTT concepts and features, session and topic handling, tutorials, and the annotated MQTT 3.1.1 protocol conformance specification. The general MQTT pages apply to both MQTT 3.1.1 and 5.0; for the other version's specification, see open-apis-mqtt-5.txt. - [MQTT](https://docs.solace.com/API/MQTT/MQTT-get-started.md): Introduces MQTT support on Solace event brokers and links to the annotated MQTT 3.1.1 and 5.0 protocol conformance specifications and the MQTT tutorials. #### MQTT Concepts and Features > How specific MQTT features work on a Solace event broker — sessions, quality of service, will and retained messages, shared subscriptions, payload handling, special topics, and tutorials — and how MQTT interoperates with clients that use Solace Message Format (SMF) messages and REST messages. - [Using MQTT](https://docs.solace.com/API/MQTT/Using-MQTT.md): Explains that Solace event brokers support MQTT v3.1.1 and v5.0, and describes how MQTT clients connect to a Message VPN, including MQTT sessions and session durability. - [API Recommendations for MQTT](https://docs.solace.com/API/MQTT/MQTT-API-Rec.md): Lists, by language and environment, the MQTT client APIs known to work with the Solace MQTT implementation; none are produced or supported by Solace. - [MQTT Topic Structure and Syntax](https://docs.solace.com/API/MQTT/MQTT-Topics.md): As a publish/subscribe messaging protocol, MQTT relies on hierarchical topics. - [MQTT Sessions](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-sessions): Explains that an MQTT client connects to a Message VPN through a dedicated MQTT port and requires an MQTT session, a managed object that holds the client's topic filters and undelivered QoS 1 messages. - [MQTT Session Durability](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-session-persistence): Describes how durable sessions survive client disconnects, restarts, and HA failovers, and how session behavior differs between MQTT v3.1.1 (CleanSession) and v5.0 clients. - [Quality of Service Levels](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-qos-levels): Enumerates and describes the MQTT QoS levels and how they map to Solace message delivery modes, with QoS 0 equivalent to Direct and QoS 1 equivalent to Guaranteed. - [Payload Handling When Message Types Change](https://docs.solace.com/API/MQTT/Using-MQTT.md#payload-conversion): Explains how message payloads are converted when MQTT messages are delivered to SMF or REST clients, and when SMF or REST messages are delivered to MQTT clients. - [Will Messages](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-will-messages): Describes "last will and testament" messages that an MQTT client registers at connect time and the broker sends if the client disconnects unexpectedly, including cases where will messages are not sent. - [Retained Messages](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-retained-messages): Explains how the broker stores messages published with the retain bit set and delivers the latest one to clients when they subscribe to a matching topic; this is a Controlled Availability feature. - [MQTT Retain Caches](https://docs.solace.com/API/MQTT/Using-MQTT.md#mqtt-retain-caches): Describes how retained messages are stored and selected using special cache clusters called MQTT retain caches, and the ancillary objects the broker creates with each one. - [Shared Subscriptions](https://docs.solace.com/API/MQTT/Using-MQTT.md#Shared_Subscriptions): Explains how MQTT v3.1.1 and v5.0 clients can use shared subscriptions to load balance data across multiple application instances, and the considerations for implementing them, such as QoS 0 only. - [Special Characters in MQTT Topic Names and Filters](https://docs.solace.com/API/MQTT/MQTT-Topics.md#mqtt-topic-name-syntax): Explains how the broker interprets special characters in MQTT topic names and filters, such as "+", "#", a leading "!", and "$share" shared subscription filters. - [Topic Recommendations for Inter-protocol Messaging](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Publishi): Gives guidance on using a common topic syntax so MQTT and non-MQTT (SMF or REST) clients can exchange messages over intersecting topic hierarchies. - [Using Subscription Managers with MQTT Clients](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Using): Explains how clients configured as Subscription Managers can add or remove QoS 0 topic filters on behalf of other MQTT clients in the same Message VPN. - [Special MQTT Topics](https://docs.solace.com/API/MQTT/MQTT-Topics.md#Special): Describes the reserved topics beginning with "$" that the broker uses to implement MQTT features, such as retrieving the client name or reply-to destination for a session. - [Get Started with MQTT Messaging Tutorials](https://docs.solace.com/API/MQTT/MQTT-get-started.md#MQTT-Tutorials): Introduces the MQTT tutorials, which cover common messaging requirements such as publish/subscribe, message persistence, and request/reply. #### Using MQTT 3.1.1 > How Solace event brokers implement MQTT 3.1.1 — the annotated MQTT v3.1.1 protocol conformance specification, with Solace implementation notes on any deviations, covering control packets, session behavior, security, WebSocket transport, and conformance requirements. - [MQTT 3.1.1: Conformance](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/MQTT_311_Prtl_Conformance_Spec.md): Title page of the annotated OASIS MQTT Version 3.1.1 standard (29 October 2014), listing the specification URIs and the Solace-annotated chapters that follow. - [MQTT 3.1.1: Introduction](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/Introduction.md): Explains that this is an annotated version of the MQTT 3.1.1 specification, supported on event brokers running software version 7.1.1 or later, and that only exceptions to the specification are highlighted. - [MQTT 3.1.1: MQTT Control Packet format](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/MQTT-Control-Packet-format.md): Describes the structure of an MQTT 3.1.1 control packet, which consists of a fixed header, an optional variable header, and an optional payload. - [MQTT 3.1.1: MQTT Control Packets](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/MQTT-Control-Packets.md): Describes each MQTT 3.1.1 control packet, such as CONNECT, PUBLISH, and SUBSCRIBE, including its fixed header, variable header, payload, and expected server behavior. - [MQTT 3.1.1: Operational behavior](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/Operational_behavior.md): Describes MQTT 3.1.1 operational behavior, including session state storage, quality of service message flows, topic names and filters, and error handling. - [MQTT 3.1.1: Security](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/Security.md): Gives non-normative security guidance for MQTT 3.1.1 implementations, including the recommended use of TLS on TCP port 8883 and threats to consider. - [MQTT 3.1.1: Using WebSocket as a network transport](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/Using-WebSocket-as-a-network.md): Describes the conditions for carrying MQTT 3.1.1 over WebSocket, including binary data frames and the required "mqtt" subprotocol name. - [MQTT 3.1.1: Conformance](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/Conformance.md): Defines the conformance requirements for MQTT 3.1.1 client and server implementations. - [MQTT 3.1.1: Appendix A. Acknowledgements (non normative)](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/AppendixA.md): Credits the OASIS Technical Committee members who contributed to the MQTT 3.1.1 specification. - [MQTT 3.1.1: Appendix B. Mandatory normative statements (non normative)](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/AppendixB.md): Provides a numbered summary of the mandatory normative statements in the MQTT 3.1.1 specification for quick reference. - [MQTT 3.1.1: Appendix C. Revision history (non normative)](https://docs.solace.com/API/MQTT-311-Prtl-Conformance-Spec/AppendixC.md): Lists the revisions made to the MQTT specification, with dates, editors, and changes. ## REST > REST messaging with Solace event brokers: REST messaging concepts, publishing and consuming over REST (producers, consumers, and the REST Delivery Point), cross-protocol mapping to SMF and JMS, and the REST messaging protocol. ### REST Messaging Concepts How Solace REST messaging works: the bidirectional HTTP POST model, the producer and consumer models, and how REST integrates with other Solace messaging protocols. - [REST](https://docs.solace.com/API/REST/REST-get-start.md): Solace REST messaging uses bidirectional HTTP POST requests to exchange messages with Solace event brokers. - [REST Messaging Concepts](https://docs.solace.com/API/REST/REST-Msging-Concepts.md): Describes how Solace event brokers use bidirectional HTTP POST requests to exchange messages with REST clients in both directions, covering the producer and consumer models and the advantage over HTTP GET polling. ### REST Producers and Consumers How REST clients publish messages to a Solace event broker and how the broker delivers messages to REST consumer applications — covering the REST Delivery Point (RDP) model and cross-protocol message mapping between REST, SMF, and JMS. - [REST Producers](https://docs.solace.com/API/REST/REST-Producers.md): Sending messages to a Solace event broker is accomplished with a REST publishing client. - [REST Consumers](https://docs.solace.com/API/REST/REST-Consumers.md): Describes how a Solace event broker delivers messages to REST consumer applications via outbound HTTP POST requests, including the REST Delivery Point (RDP), queue binding, and REST consumer configuration objects required to receive messages. - [Multi Protocol Integration](https://docs.solace.com/API/REST/Multi-Protocol-Integration.md): Describes how Solace event brokers convert REST HTTP POST messages to Solace Message Format (SMF) internally for routing, and how REST message properties, destinations, and payloads map to SMF and Jakarta (JMS) message formats for cross-protocol interoperability. ### REST Messaging Protocol and Using REST The technical details of the Solace REST messaging protocol — message encoding, event broker interactions, HTTP status codes, and message exchange patterns. - [REST Messaging Protocol](https://docs.solace.com/API/RESTMessagingPrtl/Solace-REST-Overview.md): REST is a lightweight way of designing network applications. - [Solace REST HTTP Message Encoding](https://docs.solace.com/API/RESTMessagingPrtl/Solace-REST-Message-Encoding.md): The Solace REST messaging feature encodes messages using standard HTTP mechanisms. - [Message Exchange Patterns](https://docs.solace.com/API/RESTMessagingPrtl/Message-Exchange-Patterns.md): This section describes success and failure scenarios for common message exchange patterns. - [Solace Event Broker Interactions](https://docs.solace.com/API/RESTMessagingPrtl/Solace-Router-Interactions.md): Details how Solace REST messaging interacts with the event broker, covering Message VPN selection by TCP port, authentication schemes, and REST client connectivity requirements. - [Solace REST Status Codes](https://docs.solace.com/API/RESTMessagingPrtl/Solace-REST-Status-Codes.md): Describes the HTTP status codes returned by Solace event brokers when sending or receiving REST messages, and the REST client behavior expected for proper interworking. - [Solace REST Example Code](https://docs.solace.com/API/RESTMessagingPrtl/Solace-REST-Example.md): The following sections provide some example code for sending and receiving REST messages. ## Solace Schema Registry > A datastore for sharing and enforcing event schemas across teams. Covers deploying and configuring the registry, monitoring it, using the web console, serialization and deserialization, and schema-evolution best practices. - [Solace Schema Registry](https://docs.solace.com/Schema-Registry/schema-registry-overview.md): Introduces the registry and how publishers and consumers retrieve schemas to serialize and deserialize messages. Summarizes downloading, system requirements, deployment, configuration, monitoring, content management, and artifacts. - [Deploying and Configuring Solace Schema Registry](https://docs.solace.com/Schema-Registry/deploying-schema-registry.md): Compares the two deployment methods: Docker or Podman for local development and standalone use, and Kubernetes with Helm for production and high-availability environments. Links to the detailed deployment guides and the configuration reference. - [Deploying and Configuring Solace Schema Registry with Docker or Podman](https://docs.solace.com/Schema-Registry/deploying-schema-registry-docker.md): Covers installing and running the registry with Docker or Podman: package contents, prerequisites, localhost and custom hostname deployments, built-in or external identity provider authentication, monitoring and metrics, and troubleshooting. - [Deploying Solace Schema Registry with Kubernetes](https://docs.solace.com/Schema-Registry/deploying-schema-registry-helm.md): Overview of deploying the registry on Kubernetes with Helm, covering the distribution package contents, how the chart deploys the backend API, web UI, PostgreSQL database, and identity provider, and a quick start. - [Installing Solace Schema Registry with Helm](https://docs.solace.com/Schema-Registry/schema-registry-helm-installation.md): Step-by-step Helm installation: prerequisites, minimum production and multi-node cluster requirements, deployment architecture, installation steps, and troubleshooting and verification of the deployment. - [Configuring the Helm Chart](https://docs.solace.com/Schema-Registry/schema-registry-helm-configuration.md): Documents the values.yaml options for the Helm chart, including replicas, images, PostgreSQL database, ingress and TLS, and authentication settings. - [Authentication and Security](https://docs.solace.com/Schema-Registry/schema-registry-helm-authentication.md): Describes the two authentication methods, an internal identity provider and external OIDC providers (including Microsoft Entra ID), plus role-based access control and troubleshooting. - [Cloud Deployment Examples](https://docs.solace.com/Schema-Registry/schema-registry-helm-cloud.md): Walks through deploying on Google Kubernetes Engine (GKE) Autopilot, from cluster and ingress setup to install and verification, with notes for adapting to Amazon EKS and Azure AKS, troubleshooting, and best practices. - [Solace Schema Registry Configuration Reference](https://docs.solace.com/Schema-Registry/configuration-reference.md): Reference of the environment variables that configure the registry, grouped into database, external OIDC identity provider, internal identity provider, web console, deployment and network, and role-based authorization settings. - [Monitoring Solace Schema Registry](https://docs.solace.com/Schema-Registry/schema-registry-monitoring.md): Explains how to monitor registry audit logs, including the solace.audit and action log keys, DataDog integration, example queries, and alerting recommendations. - [Using Solace Schema Registry Web Console](https://docs.solace.com/Schema-Registry/schema-registry-web-console.md): Shows how to use the web console to add and view schema and API artifacts and versions, and to configure content rules that block invalid or incompatible content. - [Schema Registry Artifacts](https://docs.solace.com/Schema-Registry/schema-registry-artifacts.md): Explains registry artifacts with an Avro example, and describes artifact metadata, artifact versions, artifact groups, and references to other artifacts. - [Managing Schema References in Solace Schema Registry](https://docs.solace.com/Schema-Registry/schema-registry-references.md): Explains how to create and use reusable schema references in JSON Schema (the $id field and $ref fragment identifiers) and Avro, how to query them in the web console and REST API, how the registry validates references and protects them from deletion, and complete examples. - [Solace Schema Registry Artifact Reference](https://docs.solace.com/Schema-Registry/artifact-reference.md): Lists the supported artifact types (Avro, JSON Schema, Protobuf, and XML), artifact version states (ENABLED, DISABLED, DEPRECATED), and group, artifact, and artifact version metadata properties. - [Solace Schema Registry Content Rule Reference](https://docs.solace.com/Schema-Registry/content-rule-reference.md): Describes the VALIDITY, COMPATIBILITY, and INTEGRITY content rule types and their configuration values, support by artifact type, and precedence of artifact-specific and global rules. - [Serialization and Deserialization with Solace Schema Registry](https://docs.solace.com/Schema-Registry/schema-registry-serdes.md): Explains SERDES concepts, how to connect to the registry, choosing schema resolution strategies, performance options, and links to the Java and .NET API and protocol implementation guides. - [Advanced SERDES Configuration and Cross-Protocol Messaging](https://docs.solace.com/Schema-Registry/schema-registry-serdes-advanced-config.md): Covers auto-registration, SERDES header configuration, Avro-specific (dereferencing, encoding, record types) and JSON Schema-specific (validation, type property) settings, and cross-protocol message translation with header mapping and REST, AMQP, and SMF message flow examples. - [SERDES Property Language Support Reference](https://docs.solace.com/Schema-Registry/schema-registry-serdes-property-reference.md): A table showing which solace.registry.* SERDES properties, such as general, connection and authentication, resolution strategy, and schema lookup properties, are supported in the Java and .NET libraries. - [Best Practices for Evolving Schemas in Schema Registry](https://docs.solace.com/Schema-Registry/schema-registry-best-practices.md): Explains how to evolve schemas without breaking applications, covering forward, backward, and full compatibility rules, schema design principles, and Avro examples for adding fields and using union types. - [Solace Schema Registry REST API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/schema-registry/index.html): Online REST API reference for managing schemas and API artifacts in Solace Schema Registry, including the groups, artifacts, and versions endpoints. ### Schema Registry and the Solace Messaging APIs for Java How to integrate Solace Schema Registry SERDES libraries (Avro, JSON Schema, and generic) with the Solace JCSMP API and the Solace Jakarta Messaging API. - [Serializing and Deserializing Messages with the Solace JCSMP API](https://docs.solace.com/API/API-Developer-Guide-JCSMP/JCSMP-API-Serdes.md): Shows how to use the Avro, JSON Schema, and generic SERDES libraries with the JCSMP API: Maven BOM and dependency setup, Topic ID strategy profile examples, and Java code for serializing, sending, receiving, and deserializing Avro and JSON Schema messages. - [Serializing and Deserializing Messages with the Solace Jakarta Messaging API](https://docs.solace.com/API/Solace-Jakarta-API/Jakarta-API-SERDES.md): Shows how to use the Avro, JSON Schema, and generic SERDES libraries with the Jakarta Messaging API: Maven BOM and dependency setup, supported message types, and Java code for serializing, sending, receiving, and deserializing Avro and JSON Schema messages. ### Schema Registry and the Solace Messaging API for .NET How to integrate Solace Schema Registry SERDES libraries with .NET. - [Serializing and Deserializing Messages with the Solace.NET API](https://docs.solace.com/API/API-Developer-Guide-NET/NET-API-Serdes.md): Shows how to use the JSON Schema and generic SERDES libraries with the Solace .NET API: NuGet dependencies, configuration, synchronous and asynchronous serialization and deserialization (including to POCOs), validation error handling, and avoiding head-of-line blocking on SERDES failures. ### Schema Registry and AMQP How to integrate Solace Schema Registry SERDES libraries with AMQP messaging, enabling serialization and deserialization of structured payloads in Java (over Avro, JSON Schema) or .NET applications (over AMQPNetLite). - [AMQP](https://docs.solace.com/API/AMQP/AMQP-get-started.md#AMQP-Tutorials): Getting-started hub for AMQP on Solace event brokers, linking to AMQP concepts and to messaging tutorials for JMS 1.1, JMS 2.0, and Node.js over AMQP. - [Leveraging AMQP Messaging with Solace Schema Registry: Serializing and Deserializing Messages in Java](https://docs.solace.com/API/AMQP/AMQP-API-SERDES.md): Shows how to use the Java Avro and JSON Schema SERDES libraries over AMQP 1.0 with Apache Qpid JMS: Maven dependencies, connection configuration, cross-protocol message flow, publishing and consuming Avro and JSON Schema messages, and troubleshooting. - [Leveraging AMQP Messaging with Solace Schema Registry: Serializing and Deserializing Messages in .NET](https://docs.solace.com/API/AMQP/AMQP-API-SERDES-DOTNET.md): Shows how to use the .NET JSON Schema SERDES library over AMQP 1.0 with AMQPNetLite: NuGet dependencies, connection configuration, cross-protocol message flow, publishing and consuming JSON Schema messages, avoiding head-of-line blocking, and troubleshooting. ### Schema Registry and REST How to integrate Solace Schema Registry SERDES libraries with REST messaging, enabling serialization and deserialization of structured payloads over HTTP in Java (Avro, JSON Schema) or .NET (JSON Schema) applications. - [Leveraging REST Messaging with Solace Schema Registry: Serializing and Deserializing Messages in Java](https://docs.solace.com/API/RESTMessagingPrtl/REST-API-SERDES.md): Shows how to use the Java Avro and JSON Schema SERDES libraries with REST messaging over HTTP: Maven dependencies, REST consumer application parameters, publishing and consuming Avro and JSON Schema messages, and troubleshooting cross-protocol SERDES. - [Leveraging REST Messaging with Solace Schema Registry: Serializing and Deserializing Messages in .NET](https://docs.solace.com/API/RESTMessagingPrtl/REST-API-SERDES-DOTNET.md): Shows how to use the .NET JSON Schema SERDES library with REST messaging over HTTP using HttpClient and HttpListener: NuGet dependencies, REST consumer parameters, publishing and consuming JSON Schema messages with schema information in HTTP headers, and troubleshooting. ### SERDES API References Online API reference documentation for the Solace Schema Registry SERDES libraries, listing classes, methods, and configuration properties for Java and .NET. - [Java Avro SERDES API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java-serdes-avro/index.html): Online API reference for the Solace Avro SERDES for Java, which provides serialization and deserialization for Apache Avro formatted data. - [Java JSON SERDES API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java-serdes-jsonschema/index.html): Online API reference for the Solace JSON SERDES for Java, which provides serialization and deserialization for JSON Schema formatted data. - [Java Generic SERDES API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java-serdes-generic/index.html): Online API reference for the Solace Generic SERDES for Java, which provides generic serialization and deserialization functionality shared across schema formats. - [.NET JSON SERDES API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/dotnet-serdes-jsonschema/index.html): Online API reference for the Solace JSON Schema SERDES for .NET, which provides serialization and deserialization for JSON Schema data. - [.NET Generic SERDES API Reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/dotnet-serdes-generic/index.html): Online API reference for the Solace Generic SERDES for .NET, which provides generic serialization and deserialization functionality shared across schema formats. ## Solace Cache > Solace Cache stores Direct messages published on topics so clients can request and receive the most recent cached messages on demand (last-value and request/reply caching). Covers components, installation, configuring and managing, administration, monitoring, ingress message plugins, global caching, and redundancy. ### Overview and Components Introduces Solace Cache's distributed architecture and explains how to install and uninstall Cache Instances. - [Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-Overview.md): Introduces Solace Cache as a scalable, in-memory message cache for Direct messaging that lets applications request the most current cached messages, and links out to component, installation, configuration, monitoring, and redundancy topics. - [Solace Cache Components](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-Components.md): Describes the Cache Instances, Cache Clusters, Distributed Caches, and Designated Router components that make up Solace Cache's distributed architecture. - [Installing and Uninstalling Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Installing-PubSub-Cache.md): Covers downloading Solace Cache, system requirements, product key feature locking, installing and uninstalling Cache Instances, and required environment variables. ### Configuring Solace Cache on the Designated Router Covers configuring Message VPNs, Distributed Caches, Cache Clusters, and Cache Instances on the event broker acting as the Designated Router, plus customizing instance configuration files. - [Configuring Solace Cache on the Designated Router](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-and-Managing-PubSub-Cache.md): Lists the global and 100-tier operating limits for Solace Cache, such as the maximum number of Cache Instances per event broker, and links to per-component configuration tasks. - [Configuring Message VPNs for Caching](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-a-Message-VPN.md): Explains the Message VPN subscription export and Message VPN event publishing settings needed for Global Caching and new topic advertisements. - [Configuring Distributed Caches](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-Distributed-.md): Details the CLI commands for creating, editing, enabling, and disabling Distributed Caches, configuring heartbeat intervals, and scheduling message deletion. - [Configuring Cache Clusters](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-Cache-Clusters.md): Details the CLI commands for creating and editing Cache Clusters, including Deliver-To-One overrides, event thresholds, Global Caching, memory and topic limits, and message lifetimes. - [Configuring Solace Cache Instances](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-PubSub-Cache-Ins.md): Details the CLI commands for creating Cache Instance objects, enabling Auto Start mode, configuring stop-on-lost-message behavior, and enabling or disabling Instances. - [Customizing Solace Cache Configuration Files](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Customizing-PubSub-Cache-Ins.md): Explains how to customize the per-instance configuration file, based on the sampleConfig.txt template, that supplies connection, Message VPN, and priority parameters to a Cache Instance, and how to reload it without restarting. ### Administration and Monitoring Covers clearing events, deleting cached messages, starting instances, and backing up cached messages, plus monitoring Solace Cache through CLI show commands, debug files, and SEMP. - [Performing Solace Cache Administrative Tasks](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Performing-PubSub-Cache-Admi.md): Covers clearing Solace Cache events, deleting cached messages for a topic, starting Cache Instances that aren't in Auto Start mode, and backing up and restoring cached messages. - [Monitoring Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Monitoring-PubSub-Cache.md): Overview of the ways to monitor Solace Cache, including Cache Cluster event configuration, CLI show commands, debug file output, and SEMP monitoring. - [Solace Cache Events](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-Cache-Cluste-1.md): Describes the Solace Cache event queue and syslog events, and how to configure set and clear thresholds for data byte rate, data message rate, max memory, and max topics at the Cache Cluster level. - [Using CLI Show Commands to Monitor Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Monitoring-PubSub-Cache-Conf.md): Lists the show commands used to check product keys and the configuration and operational status of Distributed Caches, Cache Clusters, and Cache Instances. - [Writing Solace Cache Debug Information to a File](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Outputting-PubSub-Cache-Inst.md): Explains how the service solcache debug command signals a Cache Instance to write its debug state to a file. - [Using SEMP to Monitor Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Using-SEMP-to-Monitor-So.md): Explains how SEMP requests and replies parallel CLI commands for monitoring Solace Cache, and gives polling frequency guidelines to avoid overloading the event broker. ### Ingress Message Plug-Ins Explains how a custom Ingress Message Plug-In shared library can inspect and control which live data messages a Cache Instance caches. - [Ingress Message Plug-Ins](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Using-Ingress-Message-Plugins.md): Explains how an Ingress Message Plug-In shared library can inspect, modify, cache, flush, or discard incoming live data messages before a Cache Instance caches them. - [Building a Custom Plug-In Shared Library](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Building-a-Custom-Ingres.md): Describes how to build and activate a custom Ingress Message Plug-In shared library using the provided makefile and sample code, and the design considerations for ingress events, synchronization, and memory management. ### Global Caching Explains how Global Caching lets clients fetch topics homed in remote Distributed Caches over a wide area network (WAN), and how to configure and monitor it for a Cache Cluster. - [Global Caching](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Using-Global-Caching.md): Explains how Global Caching lets clients in a WAN environment fetch non-wildcarded topics that are homed in a different Distributed Cache, using Home Cache Cluster, Home Distributed Cache, and Local Distributed Cache concepts. - [How Global Caching Works](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Steps-Global-Caching.md): Walks through the steps a Cache Instance takes to fetch and locally cache messages for a global topic from its home Cache Cluster when a client requests it. - [Considerations for Implementing Global Caching](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-Global-Cachi.md): Covers the networking, Message VPN, Cache Cluster, and Cache Instance configuration considerations required to implement Global Caching. - [Configuring Global Caching for a Cache Cluster](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Configuring-Global-Cachi-1.md): Details the CLI commands for setting global cache heartbeat intervals, creating home Cache Clusters, and adding topic prefixes for global topics. - [Global Caching Notifications](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Global-Caching-Notificat.md): Describes the global prefix status messages a Cache Instance publishes to notify clients when connectivity to a home Cache Cluster is lost or restored. ### Solace Cache Redundancy and Network Deployments Covers best practices and configuration summaries for deploying Solace Cache redundantly across single event brokers, high-availability (HA) pairs, datacenters, and multi-region networks. - [Solace Cache Redundancy and Network Deployments](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-Redundancy-and-Network-Deployments.md): Introduces best-practice network deployment models for Solace Cache redundancy, including single-broker, HA pair, datacenter, and multi-region deployments. - [General Considerations](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/General-Considerations.md): Covers cross-cutting redundancy considerations including Direct message transport requirements, Distributed Cache management by the Designated Router and Cache Manager, the active/active redundancy model, and stop-on-lost-message recommendations. - [Solace Cache Redundancy on a Single Event Broker](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-Redundancy.md): Recommends deploying at least two Cache Instances per Cache Cluster on separate servers so that no cached data is lost and caching service isn't interrupted if a host server fails. - [Solace Cache and Event Broker Redundancy](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-and-Msg-Broker-Redu.md): Explains how deploying Cache Instances across event brokers in an event mesh, and choosing between the active/standby and active/active redundancy models, protects Solace Cache against event broker failures. - [Solace Cache and Datacenter Redundancy](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/PubSub-Cache-and-Data-Center.md): Describes deploying event brokers and Cache Instances in a backup datacenter, using Multiple-Node Routing, Replication, and Config-Sync, to protect against the failure of an entire datacenter. - [Global Caching with Multi-Region Deployments](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/Using-Global-Caching-for.md): Explains how to extend Global Caching across multiple regions using Home Distributed Caches and cost-based Multiple-Node Routing links, including how to cascade Home Caches across more than two regions. ### Upgrading Describes the procedures for upgrading Solace Cache Instances, with and without preserving cached messages. - [Upgrading Solace Cache](https://docs.solace.com/Additional-Products/Solace-PubSub-Cache/upgrading-pubsub-cache.md): Describes the basic Solace Cache upgrade procedure, which loses cached messages, versus the procedure for upgrading while preserving cached messages when a Cache Cluster has two or more instances.