•  webMethods Broker Documentation
  •  About this Documentation
    • Document Conventions
    • Online Information and Support
    • Data Protection
  •  Installing and Upgrading webMethods Broker
    •  Hardware Requirements
      • Overview
    • Version Interoperability
    •  Installing and Uninstalling Broker
      • Overview
      •  Installing Broker
        • Software Requirements and Considerations
        • Prepare Your Machine
        •  Install Products
          • Start the Installer, Provide General Information, and Choose the Products to Install
          • Supply Product Configuration Information
        •  Complete the Installation
          • Install Latest Fix
          • Make Sure Broker Server is Running and the Default Broker Exists
          • Start, Configure, and Customize Products
      •  Register Daemons to Automatically Start and Shut Down Broker Monitors on UNIX Systems
        • webMethods Boker Daemons and rc-scripts
      •  International Operating Environments
        • Language Packs
      • Uninstall Broker
    •  Upgrading webMethods Broker
      • Overview
      • Requirements for upgrading Broker
      • Upgrading from Old Broker to New Broker
      • Create a Broker Server and Use the Old Storage
  •  Administering webMethods Broker
    •  webMethods Broker
      • Overview
      •  Publish-and-Subscribe Model
        • Producers and Consumers Are De-coupled
        • Interaction Is Asynchronous
        • Delivery Quality of Service
      •  Broker's Relationship with Other webMethods Components
        • Broker Client APIs
      •  webMethods Broker Architecture and Components
        • Broker Server
        • Brokers
        • Broker Monitor
        • Broker User Interface
        • Document Types
        • Client Groups
        • Clients (Client State Objects)
        • Subscriptions
        • Queues
        • Storage Type
        • Queue Storage (QS)
        • Territories
        • Territory Gateways
        • Clusters
        • Cluster Gateways
      • Broker Security Model
      •  Working with Firewalls
        • Accessing webMethods Broker through a Firewall
      • Enable Full Core Dumps on an AIX System
    •  Using My webMethods to Administer webMethods Broker
      •  Managing Broker Using My webMethods
        • Using My webMethods with Earlier Versions of Broker
      •  Who Can Use the Broker User Interface?
        • Extending Access to Other Users
      •  Accessing the Broker User Interface
        • How My webMethods Interacts with Broker Servers
      • Logging Out of My webMethods
      •  Adding Broker Servers to My webMethods
        • Adding an Individual Broker Server to My webMethods
        • Discovering Broker Servers on a Specified Broker Monitor Host Machine
        •  Uploading a List of Broker Servers into My webMethods
          • Creating the Definitions File
          • Uploading the Definitions File to My webMethods
      • Removing Broker Servers from My webMethods
      •  Configuring the Connection Parameters
        • Viewing and Editing the Connection Parameters
      • Using My webMethods with ACL-Protected Broker Servers
    •  Broker Monitor
      •  The Role of Broker Monitor
        • How Broker Monitor Starts Broker Servers
        • How Broker Monitor Monitors the State of Broker Servers
        • Status Messages Logged by Broker Monitor
      •  Starting Broker Monitor
        • Starting Broker Monitor Automatically on Windows Systems
        • Starting Broker Monitor Manually on Windows Systems
        • Starting Broker Monitor Automatically on UNIX Systems
        • Starting Broker Monitor Manually on UNIX Systems
      •  Stopping Broker Monitor
        • Stopping Broker Monitor on Windows
        • Stopping Broker Monitor on UNIX
      • How to Secure Broker Monitor Access
      •  How to Determine Whether Broker Monitor Is Running
        • Checking on Windows
        • Checking on UNIX
      •  Ports and Running Multiple Instances of Broker Monitor
        • Viewing the Port Setting for Broker Monitor
        • Changing the Port Setting for Broker Monitor
    •  Managing Broker Servers
      •  Overview
        • Broker Data Directory
        • Broker Server Configuration File (awbroker.cfg)
      •  Starting Broker Server
        • Starting Broker Server from My webMethods
        • Starting Broker Server Using the broker_start Command
        • Starting Broker Server from Windows Control Panel
      •  Stopping Broker Server
        • Stopping Broker Server from My webMethods
        • Stopping Broker Server Using the broker_stop Command
        • Stopping Broker Server from Windows Control Panel
      •  Broker Server Communication Ports
        • Ports Used by Broker Server
        • Ports and Multiple Broker Servers
        • Viewing the Base Port Setting
        • Changing the Base Port Setting
      • Choosing the Storage Solution for Broker Server
      •  Broker Server Memory
        • Controlling Queue Size for Volatile Documents
        • Limiting Memory Usage by Broker Server
        • Maximum Limit Notification
        • Values for the max-memory-size Parameter
        • The preallocate-memory Parameter
        • Selecting the Maximum Memory Size
        • Limitations of the Maximum Memory Size
      • Configuring the hostname Parameter
      • Configuring the max-memory-size Parameter
      •  Configuring Queue Storage
        • The Log File
        • The Storage Files
        • Combined and Separate Storage Sessions
        • Default Queue Storage Files Created by the Installer
        • Default File Names and Sizes Created by server_config
        • Modifying the Size of the Log File
        • Modifying the Size of a Storage File
        • Adding a Storage File
      • Viewing Queue Storage Utilization and Settings
      •  Configuring the Cache Settings
        • Default Cache Settings
        • Selecting a Cache Size
        • Modifying the Cache Size
        • Viewing the Cache Settings
      •  Configuring Broker Server to Use Asynchronous Write Mode
        • Viewing the Write-Mode Setting
      •  Running Multiple Broker Servers on the Same Host Machine
        • Running Multiple Broker Servers in a Single webMethods Broker Environment
        • Running Multiple Instances of webMethods Broker on the Same Host
      • Creating a Broker Server with the Default Log and Storage Files
      • Creating a Broker Server that Specifies Size and Location of Files
      • Deleting a Broker Server
      • Viewing Status Information for a Broker Server
      •  Broker Server License
        • Transaction-based Pricing through License
        • Contents of License File
        • Viewing and Changing the License Using My webMethods
        • Viewing and Changing the License Using server_config
      • Monitoring Resource Utilization
      • Logging
      •  The Broker Server Log
        • Log File Names and Locations
        •  Message Types
          • Including Log Messages in Other Logging Systems
        • Configuring the Logging Behavior of Broker Server
        • Configuring the Logging Behavior of Broker Monitor
        • Viewing the Broker Server Log
        • Purging the Broker Server Log
      •  The Messaging Log
        • Message Types
        •  Log File Names and Locations
          • Continuous versus Daily Log Files
        • Viewing the Messaging Log
        • Configuring the Messaging Log
        • Purging the Messaging Log that Uses Daily Files
        • Purging the Messaging Log that Uses Continuous Files
      • Internet Protocol Support
      •  Backing Up and Restoring a Broker Server
        • Metadata that Is Backed Up
        • When to Perform a Backup
        • Other Files That You Should Backup
        • Backing Up Territories and Gateways
        • Choosing the Correct Backup Procedure
        • Backing Up a Separate Storage Configuration
        •  Files that Are Backed Up
          • Backing Up an ACL-Protected Broker Server
        •  Restoring a Separate Storage Configuration
          • Resynchronizing a Restored Broker with its Territory
        •  Backing Up a Combined Storage Configuration
          • Preparing for the Backup
          • Precautions and Alternatives
        • Restoring a Combined Storage Configuration
      • Pausing Document Publishing on the Broker Server
      •  Configuring Broker Server for high throughput in high-latency and high-bandwidth networks
        • Configuring Streaming in Broker Servers
        • Configuring Parallel Channels in Broker Servers
      • Setting the Locale
    •  Managing Brokers
      • Role of Broker
      • Creating a Broker
      • Deleting a Broker
      •  Configuring a Default Broker
        • Determining Which Broker Is the Default
        • Designating a Default Broker
      •  Using Document Logging
        • Determining Whether Document Logging Is Enabled
        • Checking the Length of the Document Logging Queue
      •  Routing Documents to the Dead Letter Queue
        •  The Dead Letter Client
          • Relationship to Dead Letter Queues Created by Client Applications
        • Activating the Dead Letter Queue
        • Viewing and Purging the Dead Letter Queue
        • Disabling the Dead Letter Queue
      • Viewing Status Information for a Broker
      • Viewing Basic Operating Statistics for the Broker
      •  Managing Transactions
        • Viewing Running Transactions
        • About Configuring the Transaction Timeout Options
        • Configuring the Transaction Timeout Options
        • Setting the Recover Mode for XA Transactions
        • Manually Performing a Commit or Roll Back
        • Viewing and Purging Lost Transactions
    •  Managing Document Types
      • Overview
      •  What Are Documents and Document Types?
        • Creating Document Types
        • About Document Type Names
        •  Document Type Properties
          • Time to Live
          • Document Type Validation
          • Document Type Storage Types
          • Client Group Storage Types and Document Type Storage Types
        • Document Field Information
        • Infosets Information
      • Viewing Document Types on a Broker
      • Viewing Document Type Configuration Information
      • Viewing Document Type Fields and Infosets
      • Viewing Which Clients Subscribed to a Document Type
      • Modifying Document Type Properties
      •  Copying Document Types Between Brokers
        • Copying and Pasting Document Types
      • Deleting Document Types
    •  Managing Client Groups
      • Overview
      • Defining a Client Group
      • Client Groups and Broker Security
      •  Client Group Properties
        •  Client Queue Storage Type
          • Queue Storage Type and Lifecycle
          • Queue Storage Type and Document Type
        • Client Lifecycle
        • Client Group Access Control Lists (ACLs)
      •  System-Defined Client Groups
        • admin Client Group
        • accessLabelAdapter Client Group
        • adapters Client Group
        • eventLog Client Group
      •  Working with Client Groups
        • Searching for Client Groups
        • Creating a Client Group
        • Viewing and Editing Client Groups
        • Adding Document Type Permissions for Client Groups
        • Removing Document Type Permissions for Client Groups
        •  Copying Client Groups between Brokers
          • Using Copy and Paste
        • Deleting a Client Group
    •  Managing Clients
      • Overview
      •  What Is a Client?
        • Client State
        •  Shared State Clients
          • Shared State Order
        • Storage Type and Lifecycle
      • Viewing Clients on a Broker
      • Viewing Client Configuration Information
      • Viewing Client Statistics
      •  Managing Subscriptions
        • Viewing Subscriptions
        • Deleting Subscriptions
      •  Managing Sessions
        • Viewing Session Information
        • Viewing Detailed Session Information
        •  About Disconnecting Sessions
          • Before Disconnecting a Session
          • Disconnecting a Session
      •  Copying Clients between Brokers
        • Copying and Pasting Clients
      • Deleting Clients
    •  Working with Test Clients
      • Overview
      • What Is a Test Client?
      • Viewing Test Clients on a Broker
      •  Creating Test Clients
        • Creating a Test Client that Uses Basic Authentication
        • Creating a Test Client that Uses SSL Authentication
        • Creating a Test Client that Uses One-way SSL Authentication
      • Working in Test Client View
      •  Managing Document Subscriptions for a Test Client
        •  Creating Subscriptions for a Test Client
          • Creating or Editing a Filter
        • Deleting Subscriptions for a Test Client
      •  Publishing Documents with a Test Client
        •  Building an Outgoing Documents List
          • Adding Blank Documents
          • Loading Documents from a File
          • Copying and Pasting Documents in the Outgoing Documents List
          • Adding Comments to Documents
        •  Publishing Documents with a Test Client
          • Before Publishing Documents with a Test Client
          • Publishing or Delivering Documents with a Test Client
        • Stopping Publishing by a Test Client
      •  Retrieving Documents for a Test Client
        • Clearing the Incoming Documents List
        • Clearing the Test Client Queue
      • Saving Outgoing or Incoming Documents
      • Disconnecting a Test Client
      •  Reconnecting Test Clients
        • Reconnecting a Test Client that Uses Basic Authentication
        • Reconnecting a Test Client that Uses SSL Authentication
        • Reconnecting a Test Client that Uses One-way SSL Authentication
      • Deleting a Test Client
    •  Managing Client Queues
      • Overview
      •  What Is a Client Queue?
        • Client Queue Ownership
      • Viewing Client Queue Statistics
      • Locking a Client Queue
      •  Unlocking a Client Queue
        • Viewing Lock Information for a Queue
      •  Browsing a Client Queue
        • Filtering Queue Contents while Browsing
      • Saving Client Queue Documents to a File
      •  Inserting Documents into a Client Queue
        • Loading Documents from a File
        • Copying and Pasting Documents
        • Inserting Documents
      • Deleting Documents from a Client Queue
      •  Clearing Client Queues
        • Before Clearing a Client Queue
        • Clearing a Client Queue
      • Proactively Deleting Documents from a Client Queue
    •  Managing Forwarding Queues
      • Overview
      • What Is a Forwarding Queue?
      •  Navigating to the Forwarding Queue Browser Page
        • Navigating to the Forwarding Queue for a Remote Broker in Your Territory
        • Navigating to the Forwarding Queue for a Remote Broker in Your Cluster
        • Navigating to the Forwarding Queue for a Remote Broker in a Remote Territory
        • Navigating to the Forwarding Queue for a Remote Broker in a Remote Cluster
      • Locking and Unlocking the Forwarding Queue
      •  Browsing a Forwarding Queue
        •  Filtering Forwarding Queue Contents while Browsing
          • Filtering Contents for a Remote Broker in Your Territory or Cluster
          • Filtering Contents for a Remote Broker in a Remote Territory or Cluster
      • Saving the Forwarding Queue Documents to a File
      •  Inserting Documents into a Forwarding Queue
        • Loading Documents from a File
        • Copying and Pasting Documents
        • Inserting Documents
      • Deleting Documents from a Forwarding Queue
      • Proactively Deleting Documents from a Forwarding Queue
      • Forwarding Messages to a Remote Cluster or Territory
    •  Using Topology View and Document Trace
      •  Topology View of Brokers
        • Data Displayed in the Broker Topology View
        • Displaying the Broker Topology View
        • About Tracing Documents in Broker Topology View
        • Tracing Documents in the Topology View
        •  Setting Your User Preferences for the Display Settings
          • Defining How to Display Data in the Broker Topology View
          •  Defining the Brokers and Clients to Display in the Topology View
            • Editing Existing Node Groupings
            • Deleting Node Groupings
            • About Ordering the Node Groupings
            • Ordering Node Groupings
          • Defining the Documents to Include in Traces
      •  Table View of Trace Information
        • Data Displayed in Trace View
        • Setting Your User Preferences for the Trace View
        •  Running Document Traces in Trace View
          • Refreshing the Data in the Trace View
          • Stopping the Trace in the Trace View
          • Exporting the Data in the Trace View to a .csv File
          • Clearing the Trace Data
      •  Topology View of Territories
        • Data Displayed in the Territory Topology View
        • Displaying the Territory Topology View
        • About Tracing a Document in the Territory Topology View
        • Tracing a Document in the Territory Topology View
        •  Setting Your User Preferences for the Territory Topology View
          • Defining How to Display Data in the Territory Topology View
          •  Identifying the Territories to Show in the Topology View
            • Editing Existing Node Groupings
            • Deleting Node Groupings
            • About Ordering the Node Groupings
            • Ordering Node Groupings
          • Viewing Documents that Are Included in Territory Topology Document Traces
    •  Managing Broker Security
      • Overview
      • Data Protection
      •  Broker Security Model
        • Authentication Identities
        • Access Control Lists (ACLs)
        •  Securing Broker System Components
          • Securing the Broker Server
          • Securing the Broker User Interface
          • Securing Broker Command-Line Utilities
          • Securing Client Groups
          • Securing Territories and Gateways
          • Securing Clusters and Cluster Gateways
      •  Securing Broker Server Using Basic Authentication
        • Using the Basic Authentication Security Model
        • Enabling Basic Authentication
        •  Basic Authentication Configuration File
          • Basic Authentication on UNIX
          •  Basic Authentication Configuration Parameters
            • Default Values for Active Directory Parameters
            • Default Values for SunOne Parameters
            • Default Values for OpenLdap Parameters
        •  Basic Authentication Alias
          • Disabling Basic Authentication Alias
        • Configuring Basic Authentication Identity for a Broker Server
        • Disabling the Basic Authentication Identity of a Broker Server
      •  Securing Broker Server Using SSL
        • Broker Security Model and OpenSSL
        • Assigning SSL Identities for a Broker Server
        •  One-Way and Two-Way SSL Authentication
          • SSL Authentication and Broker Port Usage
          • Broker Server Identity and SSL
        •  Certificate Files
          •  Keystore File
            • Keystore File Formats
            • Certificate Chains
            • Installing a Certificate
          •  Truststore File
            • Truststore File Formats
          • How Broker Uses a Keystore and Truststore
          • Protecting Keystore and Truststore Files
        •  Using SSL Encryption
          • OpenSSL Cryptography
        •  Configuring SSL for Broker Server
          • Creating Keystores and Truststores
          •  Loading Keystores and Truststores into My webMethods
            • Loading Keystores from the Machine on Which Broker is Administered
            • Loading Keystores on the Machine Hosting My webMethods Server
            • Loading Truststores from the Machine on Which Broker is Administered
            • Loading Truststores on the Machine Hosting My webMethods Server
          • Modifying Keystores and Truststores
        •  Configuring an SSL Identity for a Broker Server
          • Disabling the SSL Identity for a Broker Server
        • Configuring SSL for Clients
        •  Securing Broker Server Using CRL
          • Configuring Certificate Revocation Checking
          • Configuring CRL Checking For the Entire Certificate Chain
      • Securing Broker Server Using Basic Authentication Over SSL
      •  Securing Broker Server Using FIPS
        • Starting Broker Server in FIPS mode
      •  Access Control Lists
        • Authenticator vs. User ACLs
        • How User Rights Are Granted
        • Client Group ACLs
        • admin Client Group ACLs
        • Broker Server ACLs
        • Territory ACLs
        • Cluster ACLs
        • Territory Gateway ACLs
        • Cluster Gateway ACLs
        •  Configuring Access Control Lists
          •  About Configuring Broker Server ACLs
            • Adding Authenticator Names
            • Adding User Names
            • Disabling Broker Server ACLs
            • Deleting Authenticator Names
            • Granting Access Permissions to a New Client
          •  About Configuring Client Group ACLs
            • Registering User Names
            • Registering Authenticator Names
          •  About Controlling Which Brokers Can Join a Territory
            • Specifying Brokers Using User Name DNs
            • Specifying Brokers Using Authenticator Names
            • Deleting Brokers From a Territory ACL
          •  About Controlling Which Brokers Can Join a Cluster
            • Specifying Brokers Using User Names
            • Specifying Brokers Using Authenticator Names
            • Deleting Brokers From a Cluster
          •  Setting Permissions to Connect to Remote Brokers across a Territory Gateway
            • Configuring Broker Gateway ACLs Using User Names
            • Configuring Broker Gateway ACLs Using Authenticator Names
          •  About Setting Permissions to Connect to Remote Brokers across a Cluster Gateway
            • Configuring Cluster Gateway ACLs Using Broker User Names
            • Configuring Cluster Gateway ACLs Using Broker Authenticator Names
          • ACLs and Migration Issues
      •  Broker Security and My webMethods Server
        • Configuring a Basic Authentication Identity for the Broker User Interface Component
        • Configuring an SSL Identity for the Broker User Interface Component
        • Configuring for One-way SSL Authentication
        • Reconfiguring the Identity of the Broker User Interface Component
        • Disabling the Identity of User Interface Component to the Broker Server
        • Viewing the Identity Details of the Broker User Interface Component to the Broker Server
      •  Converting Certificate Files
        •  Broker Certificate Conversion Utility
          • Single Certificate Format
          • Trusted Roots and Truststore Files
          • Downloading the Broker Certificate Conversion Utility
          • Command Usage
          • Remarks
    •  Managing Territories
      •  Introduction to Territories
        • Why Implement a Territory?
        •  How Brokers in a Territory Communicate with Each Other
          •  Subscriptions Maintained by a Remote Broker Object
            • How Subscription Filters Are Handled in a Territory
          •  The Queue Maintained by a Remote Broker
            • How Delivered Documents Are Handled in a Territory
        • How Brokers Synchronize Metadata
        • Exporting and Importing Territory Information
        • Securing a Territory
        • Leaving a Territory
      •  Creating a Territory
        • Requirements Checklist
        • Creating Territories
      • Adding Brokers to a Territory
      • Removing a Broker from a Territory
      • Deleting a Territory
      • Viewing a List of Known Territories
      • Viewing Information about a Remote Broker Object
      • Deleting a Remote Broker Object
    •  Managing Territory Gateways
      •  Overview
        • Territory Gateway Connections, Territory Gateways, and Territory Gateway Pairs
        • Territory Gateway Names
        • Connecting Multiple Territories with Territory Gateway Connections
      •  Creating a Territory Gateway Connection
        • Creating a "One-Way" Territory Gateway
      • Configuring and Controlling Territory Gateway Behavior
      •  Creating a Territory Gateway Pair if You Control Both Brokers
        • Defining the Territory Gateway Pair
        • Specifying which Documents Types Territories Can Exchange
        • Specifying Permissions for Receiving Individual Document Types
        • Specifying Permissions for Forwarding Individual Document Types
        • Using Client Groups to Specify Permissions on Document Types
      •  Creating a Territory Gateway Pair if You Control Only One Broker
        • Defining One Side of a Territory Gateway Pair
        • Specifying which Documents the Territory Gateway Can Forward and Receive
      •  Using Territory Gateway Filters
        • Filtering Documents
        • Filter Rules
        • Filter Operators
      • Viewing Information about a Territory Gateway
      • Viewing Information about Documents Flowing between the Gateways
      • Deleting a Territory Gateway Connection
      • Removing an Allowed Document Type from a Territory Gateway
      •  Pausing and Resuming a Territory Gateway
        • Pausing a Territory Gateway
        • Resume a Territory Gateway
      •  Preventing Connection Timeouts between Territories
        • Viewing and Modifying the Keep-Alive Setting
      • Configuring the Forwarding Mode
      •  Refusing Document-Type Updates
        • Viewing or Configuring the Global Refuse Update Option
        • Viewing or Configuring the Refuse Update Option for an Individual Document Type
      •  Using Broker Remote Publish
        • Broker in the Same Territory
        • Broker Peer of Local Territory Gateway
        • Broker in a Different Territory
        • Same as Delivering Broker
    •  Managing Clusters
      •  Introduction to Clusters
        • Why Implement a Cluster?
        •  How Brokers in a Cluster Communicate with Each Other
          • How Delivered Documents Are Handled in a Cluster
        • How Brokers Synchronize Metadata
        • Exporting and Importing Cluster Information
        • Securing a Cluster
        • Leaving a Cluster
      •  Creating Clusters
        • Requirements Checklist
        • Creating a Cluster
      • Adding Brokers to a Cluster
      • Removing a Broker from a Cluster
      • Deleting a Cluster
      • Viewing a List of Known Clusters
    •  Managing Cluster Gateways
      •  Overview
        • Cluster Gateway Connections, Cluster Gateways, Cluster Gateway Pairs, and Cluster Gateway Brokers
        • Cluster Gateway Names
        • Connecting Multiple Clusters with Cluster Gateways
      •  Creating a Cluster Gateway
        • Creating a "One-Way" Cluster Gateway
      • Configuring and Controlling Cluster Gateway Behavior
      •  Creating a Cluster Gateway when You Control Both Sides
        • Defining the Cluster Gateway Pair
      •  Exchanging Document Types across a Cluster Gateway
        • Specifying Individual Document Types a Cluster Gateway Can Receive
        • Specifying Individual Document Types a Cluster Gateway Can Forward
        • About Using Client Groups to Specify Permissions on Document Types
        • Using Client Groups to Specify Permissions on Document Types
      •  Creating a Cluster Gateway when You Control Only One Side
        • Defining One Side of a Cluster Gateway Pair
        • Specifying which Documents the Cluster Gateway Can Forward and Receive
      •  Filtering Documents across a Cluster Gateway
        • Filtering Documents
        • Filter Rules
        • Filter Operators
      • Viewing Cluster Gateway Details
      • Editing Cluster Gateway Details
      • Viewing Document Details across a Cluster Gateway
      • Deleting a Cluster Gateway
      • Removing an Allowed Document Type from a Cluster Gateway
      •  Pausing and Resuming a Cluster Gateway
        • Pausing a Cluster Gateway
        • Resuming a Cluster Gateway
      • Preventing Connection Timeouts between Clusters
      • Configuring the Forwarding Mode
      •  Refusing Document Type Updates from a Remote Cluster Gateway
        • Blocking Document Types Globally
        • Blocking Document Types Individually
    •  Using My webMethods with JMS
      • Overview
      • JMS and Traditional Broker Applications
      •  webMethods Broker as a JMS Provider
        • JMS Messages
        •  JMS Messaging Model
          • Pub-Sub Messaging
          • Point-to-Point Messaging
        • JMS Connections
        • Session
        • Message Consumer
        • Durable Subscribers
        • Message Delivery Mode
        • Message Acknowledgement Mode
        • Temporary Topics and Queues
      • Binding Administered Objects in JNDI
      • Using Basic Authentication with JMS
      • Using SSL with JMS
      • Managing JMS Clients: A Road Map
      •  Managing JNDI Naming Directories
        • Listing the JNDI Providers
        • Viewing a JNDI Provider's Properties
        • Editing a JNDI Provider's Properties
        •  Adding a JNDI Provider
          • Including additional JAR files required by the JNDI provider
      •  Managing Connection Factories
        • Viewing the List of Connection Factories
        • Viewing the Detailed Information About Connection Factories
        • Adding Connection Factories
        • Modifying Connection Factories
        • Deleting Connection Factories
      •  Managing Cluster Connection Factories
        • Viewing a List of Cluster Connection Factories
        • Viewing Detailed Information About Cluster Connection Factories
        • Adding Cluster Connection Factories
        • Load-Balancing Policies for Clusters
        • Editing Cluster Configuration
        • Modifying Cluster Connection Factories
        • Deleting Cluster Connection Factories
      •  Managing Composite Cluster Connection Factories
        • Viewing Detailed Information About Composite Cluster Connection Factories
        • Adding Composite Cluster Connection Factories
        • Modifying Composite Cluster Connection Factories
        • Deleting Composite Cluster Connection Factories
      •  Managing Destinations
        • Binding Destinations to JNDI
        •  About Creating Destinations
          • Creating a JMS Topic From a Naming Directory (JNDI)
          • Creating a JMS Topic Without Using a Naming Directory (JNDI)
          • Creating a JMS Queue From a Naming Directory (JNDI)
          • Creating a JMS Queue Without Using a Naming Directory (JNDI)
        • Viewing and Editing Destinations
        • Deleting a Destination
      • Assigning Publish and Subscribe Permissions
      • Creating a Durable Subscription
    •  Exporting and Importing Broker Metadata
      • Overview
      • Description of Functionality
      •  Using Command-Line Utilities for Export and Import
        • Exporting Broker Data
        • Importing Broker Data
        • Automating Export and Import with Command Files
      •  Replicating Broker Metadata
        • Building a Production System Using Export and Import
      •  Importing and Exporting Territories and Clusters
        • Exporting Territories
        • Importing Territories
        • Exporting Territory Gateway Information
        • Importing Territory Gateway Information
        • Exporting Clusters
        • Importing Clusters
        • Exporting Cluster Gateway Information
        • Importing Cluster Gateway Information
    •  Exporting, Importing, and Deploying Assets
      • Overview
      • Exporting and Importing Broker Server and Broker Information
      • Asset Types and Dependencies
      • Exporting Broker Server and Broker Configuration to a File
      • Selecting JNDI Assets for Export
      • Importing Broker Server and Broker Configuration from a File
      • Exporting and Importing Territory Gateways
      •  Deploying Broker Assets
        • Building Assets for Deployment
        •  Deploying Assets Using webMethods Deployer
          •  Partial Deployment
            • Checkpoint and Roll Back Assets
    •  Using Command Central to Manage Broker
      • About webMethods Broker Administration
      • Configuring Broker Server License
      • Configuring SSL in Broker Server
      • Retrieving Configuration Details of Broker Server Base Port
      • Pausing and Resuming Message Publishing in Broker Servers
      •  Using the Administration Link of Broker Server
        • Configuring the Host and Port of My webMethods Server
        • Pre-requisites for Viewing the Broker Server Details Page in My webMethods
        • Viewing the Broker Server Details Page in My webMethods
      •  Administering Broker Server Using My webMethods
        • About Administering Broker Server Using My webMethods
        • Configuring the Host and Port of My webMethods Server for webMethods Broker User Interface
        • Pre-requisites for Viewing the webMethods Broker User Interface in My webMethods
        • Viewing the webMethods Broker User Interface in My webMethods
      •  webMethods Broker and the Command Line Interface
        • Commands that webMethods Broker Supports
        • Configuration Types that webMethods Broker Supports
        • Lifecycle Actions for Broker Server
        • Monitoring Run-time Statuses for webMethods Broker
        • Monitoring Run-time States for webMethods Broker
      •  Monitoring webMethods Broker KPIs
        • Overview
        •  Storage Utilization KPI
          • Marginal, Critical, and Maximum Values for Broker Server’s Storage Utilization
          • Storage Utilization Display
        •  Memory Utilization KPI
          • Marginal, Critical, and Maximum Values for Memory Utilization
        • Stalled Queues KPI
    •  webMethods Broker Command-Line Utilities
      •  Startup and Shutdown Utilities
        • startup
        • shutdown
      •  Backup and Restore Utilities
        • server_conf_backup
        • server_conf_restore
      •  Broker Server Configuration Utility
        • server_config add
        • server_config create
        • server_config delete
        • server_config help
        • server_config list
        • server_config relocate
        • server_config remove
        • server_config start
        • server_config stop
        • server_config stopall
        • server_config storage
        • server_config update
      •  Broker Utilities
        • broker_buildall
        • broker_create
        • broker_delete
        • broker_load
        •  broker_ping
          • broker_ping Return Codes
        • broker_save
        • broker_start
        • broker_status
        • broker_stop
        • broker_update
      • Directing Command-line Utilities to Use a Non-Default JRE or JDK
      • Specifying the JVM Options in Command-line Utilities
    •  webMethods Broker Storage Utility
      •  Overview
        • Supported Broker Servers
      • Processing Modes
      • Processing Phases
      •  Files on which the Utility Operates
        • Filenames and Locations for Separate Storage Sessions
        • Filenames and Locations for a Combined Storage Session
      • Running the Broker Storage Utility in Check Mode
      • Running the Broker Storage Utility in Fix Mode
      •  server_qsck Command Reference
        • server_qsck check
        • server_qsck fix
        • server_qsck help
        • server_qsck -version
    •  Broker SSL Distinguished Name Syntax
      • Overview
      • Distinguished Name Syntax
      • Using Distinguished Names with Broker
    •  Managing Certificate Files with OpenSSL
      • Overview
      •  Managing Certificate Files
        • Generating a Key and Certificate Request
        • Viewing the Certificate Request
        • Building a Keystore
        • Viewing a Certificate in a PKCS#12 File
        • Viewing a Certificate in a PEM File
        • Building a Trust Store
    •  Using Access Labels
      • Overview
      • Types of Access Control
      • Per-Message Security
      • What Is an Access Label?
      • Using Access Labels
      •  Acquiring an Access Label through Access Label Adapter
        • ALA Communication
        • Error Handling
        • The Access Label Process
        • Expiration of Labels
      • Behavior Across Broker Boundaries
    •  Configuration Audit Logging
      • Overview
      •  Audit Log Description and Functionality
        • Audit Log File Name and Location
        • Audit Log File Size and Cache Size
        • Audit Log Categories
      • Configure Audit Logging and Identify the Information to Log
      • Viewing the Audit Log
      • Deleting the old Audit Log Files
      • Editing the Audit Log Parameters in the Broker Server Configuration File
    •  webMethods Broker Document Logging
      • webMethods Broker Document Logging
      •  Logging Utility Client Groups and Clients
        • Client ID
        • Identifying a Logging Utility Client by Client ID
      •  Setting Up Document Logging
        • Enable Document Logging
        • Identify Document Types to Log
        • Subscribe to Document Types from Other Brokers in the Territory or Cluster
        • Specify User-Defined Document IDs
        • Specify Number of Logged Documents to Give to Integration Server at One Time
        • Other Configuration Settings
      •  Logging Utility Management
        • Managing the Logging Utility
      •  Built-In Services
        • pub.loggingUtility.util:brokerLoggingLength
        • pub.loggingUtility.util:brokerLoggingPeek
        • pub.loggingUtility.util:brokerLoggingSingleExtract
    •  webMethods Broker Server Configuration Parameters
      • Introduction
      • Broker Server Configuration Parameters
    •  Broker Monitor Configuration Parameters
      • Introduction
      • Broker Monitor Configuration Parameters
    •  webMethods Broker Light-weight Configuration Parameters
      • Introduction
      • Database Configuration Parameters
      • Monitor Configuration Parameters
      • Compress Configuration Parameters
  •  webMethods Broker Messaging Programmer's Guide
    •  Introduction
      •  Introduction to webMethods Broker Messaging
        • Overview
        •  webMethods Broker
          • JMS Clients
          • C# Clients
          • Client Interoperability
        • webMethods Broker Messaging Technology
        •  Highlights
          • Shared State
          • Basic Authentication Support
          • SSL Support
          • Java EE Connector Architecture (JCA) Support (JMS Clients Only)
          • Java Transaction API Support (JMS Clients Only)
        •  Managing Administered Objects
          • Saving Administered Objects
        • Developing Applications with webMethods Messaging
        •  Configuring Environment Variables
          • Setting the CLASSPATH Variable (JMS Clients)
          • Setting the Windows PATH (C# Clients)
        • Properties Specific to webMethods Broker Used as a JMS Provider
        • Configuring the C# Application
      •  Basics of webMethods Messaging
        • Overview
        •  webMethods Messaging
          • JMS Messaging
          • C# Messaging
        •  Messaging Styles
          • Point-to-Point (PTP) Messaging
          •  Publish-Subscribe Messaging
            • Durable Subscriptions
            • Non-durable Subscriptions
        •  JMS API Programming Model
          •  Administered Objects
            •  Types of Administered Object
              • Connection Factories
              • Destinations
          • Connections
          • Sessions
          • Message Producer
          •  Message Consumer
            • Message Listener
            • Message Selector
          •  Messages
            • Message Structure
            • Message Delivery
            • Message Acknowledgment
    •  webMethods Messaging Administration
      •  Configuring Administered Objects
        • Overview
        •  Administrator Tools
          • Working with Administered Objects
          •  Choosing an Administrative Tool
            • Standard webMethods Tools for Administered Objects
            • Using the webMethods Broker APIs for JMS and C# APIs
        • Broker Administration API
        •  Client Groups and Permissions
          • JMS Client Groups
          • Setting Client Group Access Permissions
        • Using JNDI Providers (Naming Directories)
        • Configuring Time-out for JMS Client Connections
        •  Configuring Keep-alive
          • Configuring Keep-alive for Broker Server
          • Configuring Keep-alive for JMS Clients
      •  The JMSAdmin Command-Line Tool
        • Overview
        • Modes of Operation
        • Before Using JMSAdmin
        •  Starting JMSAdmin
          • Start-up Options
          • Basic Authentication Enabled Brokers
          • SSL-Enabled Brokers
        • JMSAdmin Command Syntax
        •  JMSAdmin Variables
          • Using Variables to Set Parameters
          • System Variables
        • Managing Contexts
        •  JMSAdmin Properties
          • Sample JNDI Properties File
        • Error Messages
        • Sample JMSAdmin Command Sequence
      •  JMSAdmin Command Reference
        • Overview
        • Command Syntax Conventions
        •  JMSAdmin Command Descriptions
          • Bind ClusterConnectionFactory
          • Bind ClusterQueueConnectionFactory
          • Bind ClusterTopicConnectionFactory
          • Bind CompositeConnectionFactory
          • Bind CompositeQueueConnectionFactory
          • Bind CompositeTopicConnectionFactory
          • Bind ConnectionFactory
          • Bind Queue
          • Bind QueueConnectionFactory
          • Bind String
          • Bind Topic
          • Bind TopicConnectionFactory
          • Change Context
          • Connect
          • Copy
          • Create Broker
          • Create Context
          • Create Durable Subscriber
          • Create Group
          • Create Queue
          • Create Topic
          • Delete Broker
          • Delete Context
          • Delete Durable Subscriber
          • Delete Group
          • Delete Queue
          • Delete Topic
          • Deny
          • Disconnect
          • Display
          • End
          • Export
          • Help
          • Import
          • Initialize Broker
          • List Context
          • Modify ClusterConnectionFactory
          • Modify ClusterQueueConnectionFactory
          • Modify ClusterTopicConnectionFactory
          • Modify CompositeConnectionFactory
          • Modify CompositeQueueConnectionFactory
          • Modify CompositeTopicConnectionFactory
          • Modify ConnectionFactory
          • Modify Queue
          • Modify QueueConnectionFactory
          • Modify String
          • Modify Topic
          • Modify TopicConnectionFactory
          • Move
          • Permit
          • Set
          • Set Broker
          • Set Encoding
          • Set RecoverMode
          • Show
          • Unbind
      •  Configuring webMethods Messaging Clients for SSL
        • Overview
        •  Securing JMS Clients with SSL
          • Enabling FIPS in JMS Clients
          • Upgrading JMS Clients that Use SSL
        • Securing C# Clients with SSL
        • Securing Other Broker Components with SSL
        • Encrypting Data
        • SSL Authorization and Access Control Lists
      •  Configuring Messaging Clients for Basic Authentication
        • Overview
        • Enabling Basic Authentication Clients Using the webMethods APIs for JMS
        • Setting the System Properties to Enable Basic Authentication Clients Using the webMethods APIs for JMS
        • Using the wmjms.properties File to Secure JMS Clients with Basic Authentication
        • Securing C# Clients with Basic Authentication
    •  Application Server Support
      •  Application Server Support When You Use webMethods Broker as a JMS Provider
        • Overview
        •  JMS Application Server Support
          •  Support through JCA
            • webMethods Resource Adapter for JMS
          • Support through ASF
        •  Sample IBM WebSphere Application Server Configuration through JCA
          • Overview
          •  Configuring IBM WebSphere Application Server 7.0
            • WebSphere Application Server Usage Notes
        •  Sample JBoss Application Server Configuration through JCA
          • Overview
          • Configuring JBoss Application Server 5.0.1
        •  Sample Oracle WebLogic Application Server Configuration through ASF
          • Overview
          •  Configuring Oracle WebLogic Application Server 10.3.3
            • Setting the CLASSPATH and Environment Variables
            • Configuring XML Descriptor Files
            • Deploying the JMS Client
            • WebLogic Application Server Usage Notes
        • Application Server Usage Notes
        • Resource Adapter Configuration Properties in ra.xml File
    •  Coding Messaging Client Applications
      •  A Basic JMS Sender-Receiver Client
        • Overview
        •  Sender-Receiver Application Components
          • JNDI Properties File
        • JNDI Lookup Code
        •  Coding Messaging Objects
          • Message Sender
          • Message Receiver
        • Managing the Connection
        • Implementing Message Sending and Reception
        •  Configuring the Administered Objects and Running the Client
          • Administrative Setup Commands
      •  JMS Request-Reply Application with a Message Selector
        • Overview
        •  Request-Reply Application: Description
          • Application Components
          • Using a Message Selector
          • Message and Data Flow
          • Using a Second Messaging Thread
        •  Application Code
          • Implementing an Asynchronous Message Listener
          • Linking a Reply to a Request Message
          • Implementing a Local Transaction
          • Using a Temporary Queue
          • Using a Message Selector
          • Implementing Messaging on a Second Thread
        •  Administrative Setup Commands
          • Binding the Administered Objects to JNDI
          • Creating the Administered Objects
          • Assigning Group Permissions
        • Client Startup
        •  Application Configurations
          • Shared-State Configuration
          • Broker Territory Configuration
          • Message-Driven Bean Configuration
      •  C# Messaging Clients
        • Overview
        • webMethods Broker C# Messaging Library
        •  Sender-Receiver Application
          • Application Classes
          • Binding Administered Objects in C#
          • Sending Messages in C#
          • Receiving Messages in C#
        •  Request-Reply Application: Description
          • Application Components
          • Using a Message Selector
          • Message and Data Flow
          • Using a Second Messaging Thread
        •  Application Code
          • Implementing an Asynchronous Message Listener
          • Building the Query (Request) Message
          • Linking a Reply to a Request Message
          • Implementing a Local Transaction
          • Using a Message Selector
          • Implementing Messaging on a Second Thread
        •  Administrative Setup Commands
          • Creating the Administered Objects
          • Assigning Group Permissions
        • Client Startup
    •  webMethods Naming Service for JMS: Configuration Settings and Properties
      • Overview
      • What Is the webMethods Naming Service for JMS?
      •  Configuring the Provider
        • Before Configuring the Provider
        • Configuring the CLASSPATH
      •  Using a JNDI Properties File
        • File Syntax
        • Typical Properties File
        • Provider Property Descriptions
    •  Broker to JMS Mappings
      • Overview
      •  JMS Message Field Mappings
        • JMS Message: Header Fields
        • JMS Message: Property Fields
        • JMS Message: Body Fields
      •  Broker-to-JMS Mappings
        • Broker Client Group
        • Broker Client
        • Document Type
    •  JMS Marshalling
      • Overview
      •  Introduction
        • Marshalling and Message Producers
        • Marshalling and Message Consumers
      • Marshalling and Connection Factories
      •  Outbound Marshalling
        • Program Control Flow for Outbound Marshalling
        • Outbound Marshalling Code Example
      •  Inbound Marshalling
        • Program Control Flow for Inbound Marshalling
        • Inbound Marshalling Code Example
      • Marshalling and Message Processing
      • Marshalling and the Broker Java API
      •  Marshalling API Reference
        •  WmMessageFactory
          • Parameters
          • Interface
          • Remarks
        •  WmMarshalIn
          • Parameters
          • Interface
          • Remarks
        •  WmMarshalOut
          • Parameters
          • Interface
          • Remarks
        •  WmBrokerEventWrapper
          • Parameters
          • Class
          • Remarks
    •  Message Compression
      • Introduction
      • Classes
      •  Enabling Message Compression
        • Compressing a Single Message
        • Compressing All Messages From a Producer
    •  Message Streaming
      • Overview
      • Introduction
      •  Supporting Interfaces
        • JMS
        • C#
      • Support for Multiple Message Producers
      • Support for Read Timeout Setting
      •  Recovery Operations
        • JMS
        • C#
      •  Example
        • JMS
        • C#
      • Size Guidelines
      • Technical Considerations
    •  Using Access Labels with webMethods Messaging
      • Overview
      • Introduction
      •  Supporting Interfaces
        • JMS
        • C#
      •  Setting a Client Access Label
        • Setting the Client Access Label Automatically
      • Getting a Client Access Label
      • Specifying an Access Label Hint for a Broker Client
    •  webMethods Messaging Publisher Reconnect
      • Overview
      •  Introduction
        • Considerations
      •  Enabling Publisher Reconnect
        • Set the Connection Order
    •  C# Application Configuration File
      • Overview
      •  Using a Custom Application Configuration File
        • Example
    •  JMS Policy Based Client-Side Clustering
      • Overview
      •  What is Client-Side Clustering for JMS Client Applications?
        • JMS Policy Based Clustering
        • Indications for Using Load Balancing
        • Supported Messaging Features
        • Distributing Message Volume (Load Balancing)
      • Failover Mechanism in Clusters
      • Client-Side Failover vs. High-Availability (HA) Clustering
      •  Cluster Load Balancing Policies
        • How Does the Round Robin Cluster Policy Work?
        • How Does the Sticky Policy Work?
        •  How Does the Multisend Best Effort Policy Work?
          • Defining the Maximum Number of Receiving Brokers in a Cluster
        • How Does the Multisend Guaranteed Policy Work?
        •  Message Pre-Acknowledgement
          • Message Pre-Acknowledgement Time Interval Setting
          • Example
      •  Overriding Cluster Policy
        • Specifying Cluster Policy Override At Design Time
        • Specifying Cluster Policy Override At Runtime
      •  JMS Local Transactions in Clusters
        •  Transaction Logging
          • Enabling Transaction Logging
      •  Composite Cluster Connection
        • Composite Cluster Connection Load Balancing Policies
        • Usage of Composite Cluster Connections
        • Message Flow in a Composite Cluster Connection
      • JMS Client-Side Clustering Requirements
      •  Configuring webMethods Client-Side Clustering for JMS
        • Application Server and webMethods Client-Side Clustering for JMS
        • Message Logging
        • Enabling Load Balancing and Failover in Your JMS Applications
      •  JTA /XA Support in a JMS Clustered Environment
        • Managing Transactions in Clusters
      •  Samples
        • Sample 1: Defining Weighted Round Robin Policy in a Cluster
        • Sample 2: Defining Multisend Best Effort Policy in a Cluster
        • Sample 3: Creating Composite Connection Factory
    • Glossary
  •  webMethods Broker Administration Java API Programmer’s Guide
    •  Getting Started
      • Overview
      •  Overview of the webMethods Broker Administration API
        • BrokerServerClient
        • BrokerAdminClient
        • Monitoring Brokers
        • Managing Security Configurations
        • Managing Territories
        • Managing Clusters
        • Managing Configurations
      •  Using the Administration API for Java
        • Compatibility
        • Application Development with webMethods Broker
        • Application Deployment
      • webMethods Broker Java API Documentation
    •  Managing Brokers and Broker Servers
      • Overview
      •  Understanding Broker Server Clients
        • Creating a BrokerServerClient
        • Destroying a BrokerServerClient
        •  Connection Notification
          • Defining a Callback Object
        • Registering the Callback Object
        • Un-Registering Callback Objects
      •  Managing a Broker Server Configuration
        • Getting Broker Server Statistics
        • Getting System Usage Statistics
        • Getting and Setting the Default Broker
        • Getting and Setting Log Configuration
        • Getting the Port Information
        • Getting and Setting the License
        • Starting and Stopping the Host Process
        • Managing Security Configurations
      •  Managing Brokers
        • Using Change Locks
        • Listing all Brokers on a Host
        • Creating and Destroying Brokers
    •  Managing Broker Clients
      • Overview
      •  Understanding BrokerAdminClients
        • Creating a BrokerAdminClient
        • Destroying a BrokerAdminClient
        • Using Multiple BrokerAdminClients
        • Disconnecting a BrokerAdminClient
        •  Reconnecting a BrokerAdminClient
          • Using the newOrReconnectAdmin Method
      •  Broker Administration
        • Destroying a Broker
        • Getting and Setting the Broker Description
        • Getting Broker Statistics
      •  Broker Client Administration
        • Obtaining Broker Client Identifiers
        • Getting Broker Client Information
        • Creating Broker Clients
        • Reconnecting a Remote Broker
        • Disconnecting Broker Clients
        • Disconnecting by Session Identifier
        • Destroying Broker Clients
        • Client State Sharing
        • Setting the Last-published Sequence Number
        • Clearing a Broker Client's Queue
        •  Broker Client Subscriptions
          • Listing Subscriptions
          • Testing the Existence of a Subscription
          • Creating Subscriptions
          • Destroying Subscriptions
        • Getting Broker Client Statistics
        • Getting Broker Client Infosets
    •  Managing Client Groups
      • Overview
      • Listing Client Groups
      • Listing Client Identifiers by Group
      • Getting Client Group Statistics
      •  Creating and Destroying Client Groups
        • Life Cycle
        • Storage Type
        • Setting Client Group Descriptions
        • Destroying Client Groups
      • BrokerClientGroupInfo
      • Controlling Event Publications
      • Controlling Event Subscriptions
      • Controlling Group Access
    •  Managing Broker Event Types
      • Overview
      • Understanding the BrokerAdminTypeDef
      •  Listing Event Type Definitions
        • Getting Multiple Event Type Definitions
        • Getting Event Type Definitions by Scope
      • Getting Event Type Statistics
      •  Creating and Modifying Event Type Definitions
        • Modifying Event Fields
        • Creating or Modifying Multiple Event Type Definitions
      •  Destroying Event Type Definitions
        • Destroying Multiple Event Types
      •  Event Type Infosets
        • Setting Event Type Infosets
        • Creating or Modifying Multiple Infosets
      •  Destroying Infosets
        • Destroying Multiple Infosets
    •  Managing Security Configurations
      • Overview
      •  Access Control Lists
        • Getting and Setting Authenticator Names
        • Getting and Setting Names
        • Converting to a String
      •  Broker Server Security Configurations
        • Retrieving and Setting Broker Server Security Configurations
        • Retrieving and Setting Broker Server ACLs
      •  Client Group Security Configurations
        • Obtaining Security Information for Client Sessions
      •  Territory Security Configurations
        • Setting Territory Security
        • Territory ACLs
      •  Territory Gateway Security Configurations
        • Setting Territory Security
        • Territory Gateway ACLs
      •  Cluster Security Configurations
        • Setting Cluster Security
        • Cluster ACLs
      •  Cluster Gateway Security Configurations
        • Setting Cluster Security
        • Cluster Gateway ACLs
    •  Managing Broker Territories
      • Overview
      •  Using Territories
        • Creating a New Territory
        • Adding a Broker to an Existing Territory
        • Removing a Broker from a Territory
        • Getting Territory Information
        • Listing Brokers in a Territory
        • Obtaining Territory Statistics
        •  Maintaining a Connection Between Brokers in a Territory
          • Activating the Keep-Alive Feature between Territory Brokers
          • Checking the Keep-Alive Settings for a Broker
        • Setting Territory Security
      •  Using Territory Gateways
        • Creating and Destroying Gateways
        • Setting Shared Event Types
        • Listing Local Gateways
        • Listing All Gateways
        • Managing Event Types
        • Obtaining Gateway Statistics
        •  Maintaining a Connection Between Gateway Brokers
          • Activating the Keep-Alive Feature between Gateway Brokers
          • Checking the Keep-Alive Settings for a Gateway Broker
        •  Pausing a Gateway Broker
          • Pausing Traffic in Both Directions
          • Pausing Traffic to and from Multiple Territories
          • Unpausing a Gateway Broker
          • Checking the Current Pause Setting
        • Static Gateway Forwarding
        •  Refusing Document Type Updates Across a Gateway
          • Update Refusal Classes and Methods
          • Synchronizing Updates
        • Setting Territory Gateway Security
    •  Managing Broker Clusters
      • Overview
      •  Using Clusters
        • Creating a New Cluster
        • Adding a Broker to an Existing Cluster
        • Removing a Broker from a Cluster
        • Getting Cluster Information
        • Listing Brokers in a Cluster
        • Obtaining Cluster Statistics
        •  Maintaining a Connection Between Brokers in a Cluster
          • Activating the Keep-Alive Feature between Cluster Brokers
          • Checking the Keep-Alive Settings for a Broker
        • Setting Cluster Security
      •  Using Cluster Gateways
        • Creating and Destroying Cluster Gateways
        • Setting Shared Event Types
        • Setting Primary Gateway
        • Listing Local Gateways
        • Listing All Gateways
        • Managing Event Types
        • Obtaining Gateway Statistics
        •  Maintaining a Connection Between Gateway Brokers
          • Activating the Keep-Alive Feature between Gateway Brokers
          • Checking the Keep-Alive Settings for a Cluster Gateway Broker
        •  Pausing a Gateway Broker
          • Pausing Traffic in Both Directions
          • Pausing Traffic to and from Multiple Clusters
          • Unpausing a Cluster Gateway Broker
          • Checking the Current Pause Setting
        • Static Gateway Forwarding
        •  Refusing Document Type Updates Across a Gateway
          • Update Refusal Classes and Methods
          • Synchronizing Updates
        • Setting Cluster Gateway Security
    •  Managing Site Configurations
      • Overview
      • Collection Information
      • Server Information
      • Broker Information
      • Client Information
      • Client Group Information
      • Event Type Information
      • Territory Information
      • Territory Gateway Information
    •  Monitoring Broker Activity
      • Overview
      •  Activity and Trace Events
        •  Activity Events
          • Client Changes
          • Client Group Changes
          • Client Subscription Changes
          • Event Type Changes
          • Remote Subscription Changes
          • Territory Changes
        •  Trace Events
          • Dropped Events
          • Remotely Dropped Events
          • Enqueued Events
          • Remotely Enqueued Events
          • Published Events
          • Remotely Published Event
          • Received Events
          • Remotely Received Event
          • Peek Events
          • Insert Events
          • Delete Events
        • Modify Events
      •  Activity Traces
        • Understanding the BrokerTraceEvent
        • Obtaining Activity Traces
      •  Broker Logging
        • Understanding the BrokerLogConfig
        • Understanding the BrokerLogEntry
      •  Broker Server Logs
        • Obtaining Log Entries
        • Obtaining Log Information
        • Deleting Log Entries
    •  Using Queue Browsers
      • Overview
      •  Client Queue Browser
        • Using Client Queue Browser
      •  Forwarding Queue Browser
        • Using Forwarding Queue Browser
      •  Creating and Closing Client Queue Browsers
        • For a Client Queue Browser
        • For an Administrative Queue Browser With No Lock
        • For a Administrative Queue Browser With a Lock
      •  Creating and Closing Forwarding Queue Browsers
        • For an Administrative Queue Browser With No Lock
      • Acquiring a Queue Lock
      • Releasing a Queue Lock
      • Queue Position
      •  Filters on a Queue Browser
        • Setting a Single Filter on Queue Browser
        • Setting Multiple Filters on Queue Browser
        • Resetting Filters on Queue Browser
        • Viewing Currently Set Filters on Queue Browser
      •  Viewing Queue Content
        • Viewing a Client's Own Queue Content
        • Administratively Viewing Contents of an Unlocked Client Queue
        • Administratively Viewing Contents of a Locked Client Queue
        • Administratively Viewing Contents of an Unlocked Forwarding Queue
        • Administratively Viewing Contents of a Locked Forwarding Queue
        • Identifying "Unacknowledged" Documents
      •  Rearranging Queue Content
        • Modifying Documents
        • Inserting Documents
        • Deleting Documents
        • Unblocking the Forwarding Queue in a Territory or Cluster
        • Unblocking the Forwarding Queue in a Territory Gateway or Cluster Gateway
      • BrokerAdminClient
      • BrokerClient
      • BrokerQueueBrowser and BrokerClientQueueBrowser
      • BrokerLockedQueueBrowser and BrokerLockedClientQueueBrowser
    • API Exceptions
  •  webMethods Broker Client Java API Programmer's Guide
    •  Getting Started
      • Overview
      •  Event-Based Applications
        • Events
        • Broker Clients
        • The Broker
        • Broker-to-Broker Communication
      •  Using the webMethods Broker Java API
        • Application Development with webMethods Broker
        • Application Deployment
      • webMethods Broker Java API Online Documentation
    •  Using Broker Clients
      • Overview
      •  Understanding Broker Clients
        • Client State
        •  Client Groups
          • Client Life Cycle
          • Queue Storage Types
        • Client Infoset
      •  Creating and Destroying Broker Clients
        •  Client Identifiers
          • Assigning Client Identifiers
          • Obtaining Client Identifiers
          • Hard-coding Client Identifiers
        • Destroying a Broker Client
        • Using Several Broker Clients
      •  Disconnecting and Reconnecting
        • Disconnecting a Broker Client
        •  Reconnecting a Broker Client
          • Using the newOrReconnect Method
      •  Connection Notification
        • Defining a Callback Object
        • Registering the Callback Object
        • Un-Registering Callback Objects
      •  Obtaining Client State and Status
        • Basic Properties
        • Client Queue Methods
      •  Advanced Features
        •  Connection Settings
          • Client Time-out Settings
          • Platform Information
          • Broker Territory and Broker-to-Broker Communication
      •  Broker Connection Descriptors
        • Creating Connection Descriptors
        •  Obtaining a Client's Connection Descriptor
          • Converting to String
        •  Automatic Re-connection
          • Using Automatic Re-connection
          • Rules for Automatic Re-connection
        •  Using Client Keep-Alive
          • Setting the Keep-Alive Parameters
          • Getting the Current Keep-Alive Parameters
          • Using the Keep-Alive Feature with a Shared Connection
        • Sharing Connections
        •  Sharing Client State
          • Event Processing with Shared Client State
          • By-Publisher Event Ordering
          • Event Processing without Ordering
          • When is Sharing State Useful?
          • State Sharing Methods
          • Calling Sequence for Sharing Client State
        •  Priority Ordering for Broker Queues
          • Priority Ordering and Performance
        • Using Security Features
        • Redelivery Counting
    •  Using the Callback Model
      • Overview
      •  Understanding Callbacks
        • Using Callbacks
        • Implementing a Callback
        • Passing Arguments to Callback Methods
      •  General Callback Objects
        • Using General Callbacks
      •  Specific Callback Objects
        • Using Specific Callbacks
      •  Dispatching Callback Methods
        • Using dispatch
        • Using mainLoop
        • Using threadedCallbacks
        • Event Dispatching Rules
    •  Creating and Initializing Events
      • Overview
      •  Event Overview
        • Event Types
        • Event Type Cache
        • Event Type Names
        • Event Fields
        • Event Identifier
      •  Creating Events
        • General Event Methods
        • Field Type Checking
        • Converting Events as Binary Data
        • Restoring Events from Binary Data
      •  Event Data Fields
        • Field Data Types
        • Obtaining Field Names
      •  Regular Data Fields
        • Setting Regular Data Fields
        • Getting Regular Field Values
      •  Sequence Data Fields
        • Setting Sequence Fields
        • Getting Sequence Field Values
      •  Structure Data Fields
        •  Setting Structure Fields
          • Setting a Struct Field from an Event
          • Setting a Struct Sequence Field from an Event
        •  Getting Structure Field Values
          • Getting a Struct Field as an Event
          • Getting a Struct Sequence Field
      •  Envelope Fields
        •  Read-only Envelope Fields
          • The connectionIntegrity Envelope Field
          • The pubNetAddr Envelope Field
          • The route Envelope Field
      • Specifying Field Names
    •  Subscribing to and Receiving Events
      • Overview
      •  Event Subscriptions
        • Limits on Subscriptions
        •  Subscribing to Events
          • Uniqueness of Subscriptions
        • Canceling a Subscription
        • Using Wildcards
      •  Receiving Events in the Get-Events Model
        • Getting Multiple Events
        • Synchronous Get Events
        •  Detecting Redelivered Events
          • Manual Redelivery Counting
          • Automatic Redelivery Counting
        • Redelivery and Older Versions of webMethods Software
        •  Subscription Identifiers
          • Specifying Subscription IDs
          • Obtaining Subscription Identifiers
          • Generating Subscription Identifiers
        • BrokerSubscription Objects
      •  Getting Events using the poll Method
        • The BrokerClientPoll Object
        • Key Methods used in the Polling Model
        •  Using the poll Method
          • A Polling Example
      •  Detecting Deadletters
        • Creating a Deadletter Subscription
        • Dead Letter Subscriptions and Filters
        •  Dead Letter Permissions and Persistence
          • How Dead Letter Subscriptions Relate to Regular Subscriptions
          • Dead Letter Behavior in a Territory
    •  Using Request-Reply
      • Overview
      •  The Request-Reply Model
        •  Request Events and the Tag Field
          • Getting and Setting the Tag
        • Using the trackId Field
        •  Reply Events
          • Determining a Reply Event's Type
      •  The Requestor
        • Using the Get-event Approach
        • Callbacks with Tags
        • Using publishRequestAndWait
      •  The Server
        • Checking Subscription and Publishing Permissions
        • Processing Request Events
        •  Delivering Replies
          • Delivering Acknowledgment Replies
          • Delivering Error Replies
          • Delivering Null Replies
          • Delivering One or More Reply Events
          • Delivering Partial Replies
    •  Transaction Semantics
      • Overview
      •  About Transactional Client Processing
        • About the BrokerTransactionalClient Class
        • Transaction Support
      •  Using Broker Transaction Clients
        • Obtaining an External Transaction ID
        • Beginning a Transaction
        •  Operating within a Transaction
          • Publishing a Transaction
          • Publishing Multiple Events
          • Delivering a Transaction
          • Getting Events
        • Preparing Transactions For Commit
        •  Ending a Transaction
          • Committing a Transaction
          • Aborting a Transaction
        • Destroying the Transactional Client
        • Creating a Transactional Client
    •  Publishing and Delivering Events
      •  Publishing Events
        • Limits on Publication
        • Publishing an Event
        • Publishing Multiple Events
      •  Delivering Events
        • Obtaining the Client Identifier
        • Delivering an Event
        • Delivering Multiple Events
    •  Handling Errors
      • Overview
      •  BrokerExceptions
        • Catching Exceptions
        • Determining the Exception Type
        • Getting an Exception Description
      • Setting the System Diagnostic Level
    •  Using BrokerDate Objects
      • Overview
      • Date and Time Representation
      • BrokerDate Methods
    •  Using Sequence Numbers
      • Overview
      • Sequence Numbers
      •  Publisher Sequence Numbers
        • Using Publisher Sequence Numbers
        • Maintaining Publish Sequence Number State
      •  Receipt Sequence Numbers
        • Default Acknowledgment
        • Default Acknowledgment With Callbacks
        • Explicitly Acknowledging Events
        • Maintaining Receipt Sequence Number State
        • Other Considerations
    •  Managing Event Types
      • Overview
      •  Event Type Definitions
        • Obtaining Event Type Names
        • Obtaining Event Type Definitions
        •  Obtaining Event Field Information
          • Obtaining Event Type Descriptions
          • Obtaining Storage Type Property
          • Obtaining the Time-to-live Property
          • Obtaining Type Definitions as Strings
        •  Obtaining Broker Information
          • Broker Territory and Broker-to-Broker Communication
      •  Event Type Definition Cache
        • Notification of Event Type Definition Changes
        • Locking the Type Definition Cache
      • Infosets
    •  Using Event Filters
      • Overview
      •  Filter Strings
        • Specifying Filter Strings
        • Locale Considerations
        • Filter Rules
        • Field Names
        •  Filter Operators
          • Logical Filter Operators
          • Comparison Filter Operators
          • Arithmetic Filter Operators
          • Bitwise Operators
          • String Operators
        • Operator Precedence
        • Using Regular Expressions
        • Using Hints
        •  Filter Functions
          • charAt
          • contains
          • date
          • date
          • endsWith
          • regexpMatch
          • startsWith
          • substring
          • toDouble
          • toInt
          • toLong
          • toLowerCase
          • toString
          • toUpperCase
          • toUpperCase
      • Using Filters with Subscriptions
      •  Using BrokerFilters
        • Obtaining Filter Strings
        • Obtaining Event Type Names
        • Converting Broker Filters to Strings
    •  Load Balancing and Failover for Publish Operations
      • Overview
      •  Understanding Clustering
        •  BrokerClusterPublishers
          • Monitoring Territory Activity
          • Executing Publish/Deliver Operations
        •  Load Balancing
          • Publishers and Subscribers
        • Failover
      •  Using BrokerClusterPublisher
        •  Creating and Destroying BrokerClusterPublisher
          • Creating a BrokerClientPublisher
        • Client Identifiers
        • Obtaining Client Identifiers
        • Destroying a BrokerClusterPublisher
        • Disconnecting and Reconnecting BrokerClusterPublisher
        • Disconnecting a BrokerClusterPublisher
        • Reconnecting a BrokerClusterPublisher
        • Using the newOrReconnect method
      •  Broker Cluster Publisher Connection Notification
        • Defining a Connection Callback Object
        • Registering the Connection Callback Object
        • Canceling the Connection Callback Object
      •  Broker Cluster Publisher Selection Notification
        • Defining a Selection Callback Object
        • Registering the Selection Callback Object
        • Canceling the Selection Callback Object
      • Obtaining BrokerClusterPublisher Status
      •  Publishing and Delivering Events
        • Creating a New BrokerEvent
        • Field Type Checking
        • Publishing Events
        • Publishing an Event
        • Publishing Multiple Events
        • Delivering Events
        • Delivering an Event
        • Delivering Multiple Events
        • Request-Reply Model
        • Using publishRequestAndWait
        • Include-Exclude Brokers
    •  Working with Basic Authentication
      • Overview
      • Basic Authentication
      •  Configuring the Broker Java Client for Basic Authentication
        • Configuring Basic Authentication by using BrokerConnectionDescriptor Class
        • Configuring Basic Authentication by Using System Properties
    •  Working with SSL
      • Overview
      • Broker SSL Security
      • Certificate Files
      •  Configuring the Broker Java Client for SSL
        • Configuring SSL Using the BrokerConnectionDescriptor Class
        • Configuring SSL by Using the System Properties
        • Setting Encryption
        • Retrieving a Broker Server's Certificate
        • Enabling FIPS in Java Clients
    • API Exceptions
    •  Parameter Naming Rules
      • Overview
      • Length Restriction
      • Restricted Characters
      •  Reserved Words
        • EventType and Infoset Names
      • System Parameters
      • webMethods Broker Parameters
  •  webMethods Broker Client C API Programmer's Guide
    •  Getting Started
      • Overview
      •  Overview of Event-Based Applications
        • Events
        • Broker Clients
        • The Broker
        • Broker-to-Broker Communication
      •  Using webMethods Broker C API
        • Compatibility
        • Application Development with webMethods Broker
        • webMethods Broker Client Include Files
        • webMethods Broker C API Library Files
    •  Creating and Initializing Events
      •  Event Overview
        •  Event Types
          • Event Type Cache
        • Event Type Names
        • Event Fields
        • Event Identifier
      •  Creating Events
        • General Event Functions
        • Field Type Checking
      • Deleting Events
      •  Converting Events as Binary Data
        • Restoring Events from Binary Data
      •  Event Data Fields
        • Field Data Types
        • Obtaining Field Names
        • Determining if a Field is Set
      •  Regular Data Fields
        • Setting Regular Data Fields
        • Getting Regular Field Values
        • Unicode Transform Function 8
      •  Sequence Data Fields
        • Setting Sequence Fields
        • Getting Sequence Field Values
        • Unicode Transform Function 8
      •  Structure Data Fields
        •  Setting Structure Fields
          • Setting a Struct Field from an Event
          • Setting a Struct Sequence Field from an Event
        •  Getting Structure Field Values
          • Getting a Struct Field as an Event
          • Getting a Struct Sequence Field
      •  Envelope Fields
        •  Read-only Envelope Fields
          • The connectionIntegrity Envelope Field
          • The pubNetAddr Envelope Field
          • The route Envelope Field
      • Specifying Field Names
    •  Using Broker Clients
      •  Understanding Broker Clients
        • Client State
        •  Client Groups
          • Client Life Cycle
          • Queue Storage Types
        • Client Infoset
      •  Creating and Destroying Broker Clients
        •  Client Identifiers
          • Assigning Client Identifiers
          • Obtaining Client Identifiers
          • Hard-coding Client Identifiers
        • Destroying a Broker Client
        • Using Several Broker Clients
      •  Disconnecting and Reconnecting
        • Disconnecting a Broker client
        •  Reconnecting a Broker Client
          • Using the awNewOrReconnect Function
      •  Connection Notification
        • Defining a Connection Callback Function
        • Registering the Callback Object
        • Un-Registering Callback Objects
      •  Obtaining Client State and Status
        • Basic Properties
        • Client Queue Functions
      •  Advanced Features
        • Connection Settings
        • Client Time-out Settings
        • Platform Information
        • Broker Territory and Broker-to-Broker Communication
      •  Broker Connection Descriptors
        • Creating Connection Descriptors
        • Obtaining a Client's Connection Descriptor
        • Copying Connection Descriptors
        • Destroying Connection Descriptors
        •  Automatic Reconnection
          • Using Automatic Reconnection
          • Rules for Automatic Reconnection
        • Sharing Connections
        •  Sharing Client State
          • Event Processing with Shared Client State
          • By-Publisher Event Ordering
          • Event Processing without Ordering
        •  State Sharing Functions
          • Calling Sequence for Sharing Client State
        • Enabling SSL Features
    •  Subscribing to and Receiving Events
      • Overview
      •  Event Subscriptions
        • Limits on Subscriptions
        •  Subscribing to Events
          • Uniqueness of Subscriptions
        • Cancelling a Subscription
        • Using Wildcards
      •  Receiving Events in the Get-Events Model
        • Getting Multiple Events
        •  Subscription Identifiers
          • Specifying Subscription IDs
          • Obtaining Subscription Identifiers
          • Generating Subscription Identifiers
        • BrokerSubscription Objects
    •  Publishing and Delivering Events
      • Overview
      •  Publishing Events
        • Limits on Publication
        • Publishing an Event
        • Publishing Multiple Events
      •  Delivering Events
        • Obtaining the Client Identifier
        • Delivering an Event
        • Delivering Multiple Events
    •  Using the Callback Model
      • Overview
      •  Understanding Callbacks
        • Using Callbacks
        • Defining a Callback Function
        • Passing Arguments to Callback Functions
      •  General Callback Functions
        • Using General Callbacks
      •  Specific Callback Functions
        • Using Specific Callbacks
      •  Dispatching Callback Functions
        • Using awDispatch
        • Using awMainLoop
        • Using awThreadedCallbacks
        • Event Dispatching Rules
    •  Transaction Semantics
      • Overview
      •  Transactional Client Processing
        • Transaction Context Support
      •  Using Transaction Processing
        • Obtaining an External Transaction ID
        • Beginning a Transaction
        • Operations Within a Transaction
        •  Publishing Events
          • Determining if an Event Can be Published
          • Publishing a Single Event
          • Publishing Multiple Events
        •  Delivering Events
          • Delivering a Single Event
          • Delivering Multiple Events
        •  Subscribing and Getting Events
          • Creating a Subscribing Client
          • Beginning a Transaction on the Subscribing Client
          • Getting an Event Within a Transaction
        •  Ending a Transaction
          • Committing a Transaction
          • Aborting a Transaction
    •  Using Request-Reply
      • Overview
      •  The Request-Reply Model
        •  Request Events and the Tag Field
          • Getting and Setting the Tag
        • Using the trackId Field
        •  Reply Events
          • Determining a Reply Event's Type
      •  The Requestor
        • Using the Get-event Approach
        • Other Reply Event Functions
        • Callback Functions with Tags
        • Using awPublishRequestAndWait
        • Delivering Request Events
      •  The Server
        • Checking Subscription and Publishing Permissions
        • Processing Request Events
        •  Delivering Replies
          • Delivering Acknowledgment Replies
          • Delivering Error Replies
          • Delivering Null Replies
          • Delivering One or More Reply Events
          • Delivering Partial Replies
    •  Handling Errors
      • Overview
      •  Using BrokerErrors
        • Getting the Error Code
        • Getting an Error Description
        • Other Error Functions
        • Preserving Errors During Recovery Processing
      • Setting the System Diagnostic Level
    •  Using BrokerDate Objects
      • Overview
      • Date and Time Representation
      • BrokerDate Functions
    •  Managing Event Types
      • Overview
      •  Event Type Definitions
        • Obtaining Event Type Names
        •  Obtaining Event Type Definitions
          • Obtaining Event Type Descriptions
          • Obtaining Storage Type Property
          • Obtaining the Time-to-live Property
          • Obtaining Type Definitions as Strings
        • Obtaining Event Field Information
        •  Obtaining Broker Information
          • Broker Territory and Broker-to-Broker Communication
      •  Event Type Definition Cache
        • Notification of Event Type Definition Changes
        • Locking the Type Definition Cache
      • Infosets
    •  Configuring Broker Client Security
      • Overview
      •  Working with Basic Authentication
        • Configuring the Broker C Client for Basic Authentication
        • Configuring Basic Authentication by using the Broker Connection Descriptor
      •  Working with Secure Socket Layer (SSL)
        •  Enabling SSL Authentication and Encryption
          • Server Authentication with Encryption
          • Server Authentication without Encryption
          • Server and Client-side Authentication with Encryption
          • Server and Client Authentication without Encryption
        • Retrieving a Broker's Certificate
        • Retrieving the SSL Settings for a Descriptor
        • Retrieving Information from a Certificate File
        • Obtaining the SSL Encryption Strength
        • Broker Ports used for SSL
        • Converting Certificates to Strings
        • Certificate Files
    •  Using Event Filters
      • Overview
      •  Filter Strings
        • Specifying Filter Strings
        • Locale Considerations
        • Unicode Considerations
        • Filter Rules
        • Field Names
        •  Filter Operators
          • Logical Filter Operators
          • Comparison Filter Operators
          • Arithmetic Filter Operators
          • Bitwise Operators
          • String Operators
        • Operator Precedence
        • Using Regular Expressions
        • Using Hints
        • Filter Functions
        • charAt
        • contains
        • date
        • date
        • endsWith
        • regexpMatch
        • startsWith
        • substring
        • toDouble
        • toInt
        • toLong
        • toLowerCase
        • toString
        • toUpperCase
        • toUpperCase
      • Using Filters with Subscriptions
      •  Using BrokerFilters
        • Destroying Broker Filters
        • Obtaining Filter Strings
        • Obtaining Event Type Names
        • Converting Broker Filters to Strings
    •  API Reference
      •  awAbort
        • awAbortTransactions
      •  awAcknowledge
        • awAcknowledge
        • awAcknowledgeEvents
        • awAcknowledgeThrough
      •  awBegin
        • awBeginTransaction
      •  awBroker
        • awBrokerLongFromString
        • awBrokerLongToString
        • awBrokerToNativeLong
      •  awCan
        • awCanPublish
        • awCanSubscribe
      •  awCancel
        • awCancelCallbackForSubId
        • awCancelCallbackForTag
        • awCancelCallbacks
        • awCancelSubscription
        • awCancelSubscriptionFromStruct
        • awCancelSubscriptionsFromStructs
        • awCancelTxSubscription
        • awCancelTxSubscriptionFromStruct
        • awCancelTxSubscriptionsFromStructs
      •  awClear
        • awClearClientQueue
        • awClearDate
        • awClearEvent
        • awClearEventField
        • awClearTime
        • awClearTxClientQueue
      •  awClient
        • awClientLastPublishSequenceNumber
        • awClientToString
      •  awCommit
        • awCommitTransactions
      •  awCompare
        • awCompareDate
      •  awCopy
        • awCopyDate
        • awCopyDescriptor
        • awCopyError
        • awCopyEvent
      •  awDate
        • awDateToLocalizedString
        • awDateToString
      •  awDelete
        • awDeleteClientQueueLock
        • awDeleteDate
        • awDeleteDescriptor
        • awDeleteError
        • awDeleteEvent
        • awDeleteFilter
        • awDeleteString
        • awDeleteStringWrapper
      •  awDeliver
        • awDeliverAckReplyEvent
        • awDeliverErrorReplyEvent
        • awDeliverEvent
        • awDeliverEvents
        • awDeliverEventsWithAck
        • awDeliverNullReplyEvent
        • awDeliverPartialReplyEvents
        • awDeliverReplyEvent
        • awDeliverReplyEvents
        • awDeliverRequestAndWait
      •  awDescriptor
        • awDescriptorToString
      •  awDestroy
        • awDestroyClient
        • awDestroyTxClient
      •  awDisconnect
        • awDisconnectClient
        • awDisconnectTxClient
      •  awDispatch
        • awDispatch
      •  awDoes
        • awDoesSubscriptionExist
        • awDoesTxSubscriptionExist
      •  awEnd
        • awEndTransaction
      •  awError
        • awErrorToCompleteString
        • awErrorToCompleteStringUC
        • awErrorToString
        • awErrorToStringUC
      •  awEvent
        • awEventFormatAssemble
        • awEventFormatBindVariable
        • awEventFormatFree
        • awEventFormatPreparse
        • awEventFormatTokens
        • awEventFromBinData
        • awEventToBinData
        • awEventToFormattedString
        • awEventToLocalizedString
        • awEventToString
      •  awFilter
        • awFilterToString
      •  awFree
        • awFree
      •  awFlush
        • awFlushTypeDefCache
      •  awGet
        • awGet<type>Field
        • awGet<type>SeqField
        • awGetBooleanField
        • awGetBooleanSeqField
        • awGetBrokerLong
        • awGetBrokerSSLCertificate
        • awGetBrokerVersionNumber
        • awGetByteField
        • awGetByteSeqField
        • awGetCanPublishNames
        • awGetCanPublishTypeDefs
        • awGetCanSubscribeNames
        • awGetCanSubscribeTypeDefs
        • awGetCharField
        • awGetCharSeqField
        • awGetClientAccessLabel
        • awGetClientApplicationName
        • awGetClientBrokerHost
        • awGetClientBrokerName
        • awGetClientBrokerPort
        • awGetClientConnectionDescriptor
        • awGetClientGroup
        • awGetClientId
        • awGetClientInfoset
        • awGetClientLastPublishSequenceNumber
        • awGetClientQueueLength
        • awGetClientSSLBrokerDistinguishedName
        • awGetClientSSLBrokerIssuerDistinguishedName
        • awGetClientSSLEncryptionLevel
        • awGetClientStateShareLimit
        • awGetClientTerritoryName
        • awGetDateCtime
        • awGetDateField
        • awGetDateSeqField
        • awGetDefaultBrokerPort
        • awGetDescriptorAccessLabelHint
        • awGetDescriptorAuthUserName
        • awGetDescriptorAutomaticReconnect
        • awGetDescriptorAutomaticRedeliveryCount
        • awGetDescriptorConnectionShare
        • awGetDescriptorForcedReconnect
        • awGetDescriptorKeepAlive
        • awGetDescriptorRedeliveryCountEnabled
        • awGetDescriptorSharedEventOrdering
        • awGetDescriptorSSLCertificate
        • awGetDescriptorSSLEncrypted
        • awGetDescriptorStateShare
        • awGetDiagnostics
        • awGetDoubleField
        • awGetDoubleSeqField
        • awGetErrorCode
        • awGetErrorMinorCode
        • awGetEvent
        • awGetEventClient
        • awGetEventFieldType
        • awGetEventId
        • awGetEventPublishSequenceNumber
        • awGetEventReceiptSequenceNumber
        • awGetEvents
        • awGetEventsWithAck
        • awGetEventTag
        • awGetEventTypeBaseName
        • awGetEventTypeDef
        • awGetEventTypeDefs
        • awGetEventTypeFamilyName
        • awGetEventTypeInfoset
        • awGetEventTypeInfosetNames
        • awGetEventTypeInfosets
        • awGetEventTypeName
        • awGetEventTypeNames
        • awGetEventTypeScopeName
        • awGetFamilyNames
        • awGetFamilyEventTypeNames
        • awGetFd
        • awGetFds
        • awGetField
        • awGetFieldNames
        • awGetFilterEventTypeName
        • awGetFilterString
        • awGetFloatField
        • awGetFloatSeqField
        • awGetIntegerField
        • awGetIntegerSeqField
        • awGetLockedClientId
        • awGetLockingClientInfo
        • awGetLongField
        • awGetLongFieldNative
        • awGetLongSeqField
        • awGetPlatformInfo
        • awGetPlatformInfoKeys
        • awGetScopeEventTypeNames
        • awGetScopeNames
        • awGetSequenceField
        • awGetSequenceFieldSize
        • awGetShortField
        • awGetShortSeqField
        • awGetSSLCertificate
        • awGetSSLEncryptionLevel
        • awGetStringField
        • awGetStringSeqField
        • awGetStructFieldAsEvent
        • awGetStructSeqFieldAsEvents
        • awGetSubscriptionIds
        • awGetSubscriptions
        • awGetTxBrokerSSLCertificate
        • awGetTxClientAccessLabel
        • awGetTxClientApplicationName
        • awGetTxBrokerVersionNumber
        • awGetTxClientBrokerHost
        • awGetTxClientBrokerName
        • awGetTxClientBrokerPort
        • awGetTxClientConnectionDescriptor
        • awGetTxClientGroup
        • awGetTxClientId
        • awGetTxClientInfoset
        • awGetTxClientQueueLength
        • awGetTxClientLastPublishSequenceNumber
        • awGetTxClientSSLBrokerDistinguishedName
        • awGetTxClientSSLBrokerIssuerDistinguishedName
        • awGetTxClientSSLEncryptionLevel
        • awGetTxClientStateShareLimit
        • awGetTxClientTerritoryName
        • awGetTxDefaultBrokerPort
        • awGetTxExternalId
        • awGetTxId
        • awGetTxState
        • awGetTxSubscriptions
        • awGetTypeDefBaseName
        • awGetTypeDefBrokerHost
        • awGetTypeDefBrokerName
        • awGetTypeDefBrokerPort
        • awGetTypeDefDescription
        • awGetTypeDefFamilyName
        • awGetTypeDefFieldDef
        • awGetTypeDefFieldNames
        • awGetTypeDefFieldType
        • awGetTypeDefFromEvent
        • awGetTypeDefScopeName
        • awGetTypeDefStorageType
        • awGetTypeDefTerritoryName
        • awGetTypeDefTimeToLive
        • awGetTypeDefTypeName
        • awGetUCCharField
        • awGetUCCharSeqField
        • awGetUCStringField
        • awGetUCStringFieldAsA
        • awGetUCStringFieldAsUTF8
        • awGetUCStringSeqField
        • awGetUCStringSeqFieldAsUTF8
      •  awInit
        • awInitForThreads
      •  awInterrupt
        • awInterruptDispatch
        • awInterruptGetEvents
      •  awIs
        • awIsAckReplyEvent
        • awIsClientConnected
        • awIsClientPending
        • awIsClientQueueLocked
        • awIsErrorReplyEvent
        • awIsEventFieldSet
        • awIsLastReplyEvent
        • awIsNullReplyEvent
        • awIsPending
        • awIsTxClientConnected
      •  awLock
        • awLockTypeDefCache
      •  awMain
        • awMainLoop
      •  awMake
        • awMakeSubId
        • awMakeTag
        • awMakeTransactionId
        • awMakeTxSubId
        • awMakeTxTag
        • awMakeTxTransactionId
        • awMakeUniqueSubId
        • awMakeUniqueTxSubId
      •  awMalloc
        • awMalloc
      •  awMatch
        • awMatchFilter
      •  awNative
        • awNativetoBrokerLong
      •  awNew
        • awNewBrokerClient
        • awNewBrokerConnectionDescriptor
        • awNewBrokerDate
        • awNewBrokerDateSequence
        • awNewBrokerEvent
        • awNewBrokerFilter
        • awNewBrokerString
        • awNewBrokerTxClient
        • awNewEmptyBrokerDate
        • awNewOrReconnectBrokerClient
        • awNewOrReconnectBrokerTxClient
        • awNewSubscription
        • awNewSubscriptionFromStruct
        • awNewSubscriptionsFromStructs
        • awNewSubscriptionWithId
        • awNewTxSubscription
        • awNewTxSubscriptionFromStruct
        • awNewTxSubscriptionsFromStructs
        • awNewTxSubscriptionWithId
      •  awParse
        • awParseLongFromString
        • awParseNumberFromString
        • awParseStringFromString
      •  awPrime
        • awPrimeAllClients
        • awPrimeClient
      •  awPublish
        • awPublishEvent
        • awPublishEvents
        • awPublishEventsWithAck
        • awPublishRequestAndWait
      •  awRealloc
        • awRealloc
      •  awReconnect
        • awReconnectBrokerClient
        • awReconnectBrokerTxClient
      •  awRegister
        • awRegisterCallback
        • awRegisterCallbackForSubId
        • awRegisterCallbackForTag
        • awRegisterClientConnectionCallback
        • awRegisterTxClientConnectionCallback
      •  awResend
        • awResendUnacknowledgedEvents
      •  awSet
        • awSet<type>Field
        • awSet<type>SeqField
        • awSetBooleanField
        • awSetBooleanSeqField
        • awSetBrokerLong
        • awSetByteField
        • awSetByteSeqField
        • awSetCharField
        • awSetCharSeqField
        • awSetClientAutomaticControlLabel
        • awSetClientInfoset
        • awSetClientStateShareLimit
        • awSetCurrentError
        • awSetDate
        • awSetDateCtime
        • awSetDateField
        • awSetDateSeqField
        • awSetDateTime
        • awSetDefaultClientTimeout
        • awSetDescriptorAccessLabelHint
        • awSetDescriptorAuthInfo
        • awSetDescriptorAutomaticReconnect
        • awSetDescriptorAutomaticRedeliveryCount
        • awSetDescriptorConnectionShare
        • awSetDescriptorForcedReconnect
        • awSetDescriptorKeepAlive
        • awSetDescriptorRedeliveryCountEnabled
        • awSetDescriptorSharedEventOrdering
        • awSetDescriptorSSLCertificate
        • awSetDescriptorSSLEncrypted
        • awSetDescriptorStateShare
        • awSetDiagnostics
        • awSetDoubleField
        • awSetDoubleSeqField
        • awSetEventPublishSequenceNumber
        • awSetEventTag
        • awSetField
        • awSetFloatField
        • awSetFloatSeqField
        • awSetFormatMode
        • awSetIntegerField
        • awSetIntegerSeqField
        • awSetlocale
        • awSetLongField
        • awSetLongFieldNative
        • awSetLongSeqField
        • awSetPlatformInfo
        • awSetSequenceField
        • awSetSequenceFieldSize
        • awSetShortField
        • awSetShortSeqField
        • awSetStringField
        • awSetStringFieldToSubstring
        • awSetStringSeqField
        • awSetStructFieldFromEvent
        • awSetStructSeqFieldFromEvents
        • awSetTime
        • awSetTxClientAutomaticControlLabel
        • awSetTxClientInfoset
        • awSetTxClientStateShareLimit
        • awSetUCCharField
        • awSetUCCharSeqField
        • awSetUCStringField
        • awSetUCStringFieldAsA
        • awSetUCStringFieldAsUTF8
        • awSetUCStringFieldToSubstring
        • awSetUCStringSeqField
        • awSetUCStringSeqFieldAsUTF8
      •  awSSL
        • awSSLCertificateToIndentedString
        • awSSLCertificateToString
      •  awStop
        • awStopMainLoop
      •  awString
        • awStringAppend
        • awStringAppendByte
        • awStringAppendChar
        • awStringAppendDouble
        • awStringAppendDoubleLocalized
        • awStringAppendFloat
        • awStringAppendFloatLocalized
        • awStringAppendInteger
        • awStringAppendLong
        • awStringAppendNString
        • awStringAppendNUCString
        • awStringAppendShort
        • awStringAppendUCChar
        • awStringAppendUCString
        • awStringClip
        • awStringDecIndent
        • awStringIncIndent
        • awStringIndent
        • awStringLength
        • awStringPointer
        • awStringResetIndent
      •  awThreaded
        • awThreadedCallbacks
      •  awTx
        • awTxAbort
        • awTxBeginTransaction
        • awTxCanPublish
        • awTxCanSubscribe
        • awTxClientToString
        • awTxCommit
        • awTxDeliverAckReplyEvent
        • awTxDeliverErrorReplyEvent
        • awTxDeliverEvent
        • awTxDeliverEvents
        • awTxDeliverEventsWithAck
        • awTxDeliverNullReplyEvent
        • awTxDeliverPartialReplyEvents
        • awTxDeliverReplyEvent
        • awTxDeliverReplyEvents
        • awTxGetEvent
        • awTxGetEvents
        • awTxGetEventsWithAck
        • awTxPublishEvent
        • awTxPublishEvents
        • awTxPublishEventsWithAck
      •  awType
        • awTypeDefToString
      •  awUnlock
        • awUnlockTypeDefCache
      •  awValidate
        • awValidateEvent
    •  Using Sequence Numbers
      • Overview
      • Sequence Numbers
      •  Publisher Sequence Numbers
        • Using Publisher Sequence Numbers
        • Maintaining Publish Sequence Number State
      •  Receipt Sequence Numbers
        • Default Acknowledgment
        • Default Acknowledgment With Callbacks
        •  Explicitly Acknowledging Events
          • Maintaining Receipt Sequence Number State
        • Other Considerations with Receipt Sequence Numbers
    • Error Definitions
    •  Parameter Naming Rules
      • Overview
      • Length Restriction
      • Restricted Characters
      •  Reserved Words
        • EventType and Infoset Names
      • System Parameters
      • Broker Parameter Restrictions
    •  Unicode String Functions
      • Overview
      •  Basic Unicode String Functions
        • awStrcpyUC
        • awStrncpyUC
        • awStrdupUC
        • awStrlenUC
        • awStrcmpUC
        • awStrncmpUC
        • awStrcatUC
        • awStrchrUC
        • awStrstrUC
      •  Unicode String Conversion Functions
        • awAtoUC
        • awAtoUTF8
        • awUCtoA
        • awUCtoUTF8
        • awUTF8toA
        • awUTF8toUC
      •  Unicode String Copy/Conversion Functions
        • awCopyAtoUC
        • awCopyAtoUTF8
        • awCopyUCtoA
        • awCopyUCtoUTF8
        • awCopyUTF8toA
        • awCopyUTF8toUC
      •  Unicode String Length Functions
        • awAlengthInUC
        • awAlengthInUTF8
        • awUClengthInA
        • awUClengthInUTF8
        • awUTF8lengthInA
        • awUTF8lengthInUC
    •  Transactional Client Processing with Adapters
      • Overview
      •  Transaction Processing
        •  Transaction Levels
          • Non-transactional Behavior
          • Pseudo-transaction Support
          • Basic Transaction Support
          • Conversational Transaction Support
      •  Using Transaction Processing
        • Obtaining a Transaction ID
        •  Beginning a Transaction
          • Transaction Level Negotiation
          • Multiple Participants
          • Requesting Acknowledgment
          • Publishing Events within a Transaction
          • Ending a Transaction
          • Time-outs
  •  Running webMethods Broker in a High-Availability UNIX Cluster
    •  Overview
      •  Overview of High-Availability Clustering
        • Virtual IP Addresses
        • Types of Cluster Configuration
      • Running Applications in a High-Availability Cluster
      • Running the webMethods Broker Application in a High-Availability Cluster
      • Setting Up webMethods Broker to Run in a High-Availability Cluster Environment
    •  Installation and Configuration
      • Introduction
      •  Install and Configure the webMethods Broker Software
        • Installing on the First Node
        • Installing on the Second Node
        • Verify That webMethods Broker Is Running
      • Configure webMethods Broker Monitor
      • Configure Broker Server
      •  Configure the webMethods Broker High-Availability Cluster Scripts
        • Configure the High-Availability Cluster Scripts
        • Edit the wment-defs.sh File
        •  Verify the webMethods Scripts Work Correctly
          • startBroker.sh
          • brokerStatus.sh
          • stopBroker.sh
          • Debugging the Scripts
  •  Running webMethods Broker in a High-Availability Windows Enterprise Server 2019 Cluster
    •  Overview
      •  What is a Cluster?
        • Cluster Hardware
      •  How Does webMethods Broker Run in a Windows Cluster?
        • Cluster Services
      • Overview of webMethods Broker High Availability Installation
    •  Before You Begin
      •  Prepare for Installation
        •  Installation Worksheets
          • General Information
          • Cluster Information
          • webMethods Broker Cluster Group Information
        • Login as Administrator
      • Verify the Cluster
    •  webMethods Broker Installation
      • Install webMethods Broker On Both Cluster Nodes
      • Remove the Installed Default Broker Server
    •  Cluster Configuration On Windows
      • Configure the Shared Drive
      • Create the Broker Cluster
      •  Create and Configure the Broker Server on Each Node
        • Create and Configure the Broker Server on Node A
        • Remove the Broker Server Dependency on Node A
        • Create and Configure the Broker Server on Node B
        • Remove the Broker Server Dependency on Node B
      •  Configure the Cluster
        • Add the Broker Monitor Service to the Cluster
        • Add the Broker Server Service to the Cluster
        • Add the Broker Server Dependency to the Broker Monitor
        • Add the Registry Replication for the Broker Monitor and the Broker Server
        • Verify Failover in the Cluster
        • Customize Broker Server Startup Behavior
      •  Complete the Installation
        •  Completion Worksheets
          • Customer Information Sheet
          • Installation Checklist
          • Installation Configuration
      •  Common Post-Installation Tasks
        • Shut Down the Service
        • Un-register the Service
        • Reinstall webMethods Broker
• Copyright

webMethods Broker Documentation

Copyright