UserIDBroker (ActiveMQ 5.17.0 API)

java.lang.Object
- org.apache.activemq.broker.BrokerFilter
- - org.apache.activemq.broker.UserIDBroker

All Implemented Interfaces:

Broker, Region, Service
```
public class UserIDBroker
extends BrokerFilter
```
This broker filter will append the producer's user ID into the JMSXUserID header to allow folks to know reliably who the user was who produced a message. Note that you cannot trust the client, especially if working over the internet as they can spoof headers to be anything they like.

Field Summary
- Fields inherited from class org.apache.activemq.broker.BrokerFilter
  next

Constructor Summary

Constructors
Constructor Description

UserIDBroker(Broker next)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isUseAuthenticatePrincipal()`
`void`	`send(ProducerBrokerExchange producerExchange, Message messageSend)`	Send a message to the broker to using the specified destination.
`void`	`setUseAuthenticatePrincipal(boolean useAuthenticatePrincipal)`

Methods inherited from class org.apache.activemq.broker.BrokerFilter
acknowledge, addBroker, addConnection, addConsumer, addDestination, addDestinationInfo, addProducer, addSession, beginTransaction, brokerServiceStarted, commitTransaction, fastProducer, forgetTransaction, gc, getAdaptor, getAdminConnectionContext, getBrokerId, getBrokerName, getBrokerSequenceId, getBrokerService, getClients, getDestinationMap, getDestinationMap, getDestinations, getDestinations, getDurableDestinations, getExecutor, getNext, getPeerBrokerInfos, getPreparedTransactions, getRoot, getScheduler, getTempDataStore, getVmConnectorURI, isExpired, isFaultTolerantConfiguration, isFull, isStopped, messageConsumed, messageDelivered, messageDiscarded, messageExpired, messagePull, networkBridgeStarted, networkBridgeStopped, nowMasterBroker, postProcessDispatch, prepareTransaction, preProcessDispatch, processConsumerControl, processDispatchNotification, reapplyInterceptor, removeBroker, removeConnection, removeConsumer, removeDestination, removeDestinationInfo, removeProducer, removeSession, removeSubscription, rollbackTransaction, sendToDeadLetterQueue, setAdminConnectionContext, slowConsumer, start, stop, virtualDestinationAdded, virtualDestinationRemoved

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserIDBroker
```
public UserIDBroker(Broker next)
```
- Method Detail
  - send
```
public void send(ProducerBrokerExchange producerExchange,
                 Message messageSend)
          throws Exception
```
    Description copied from interface: Region
    
    Send a message to the broker to using the specified destination. The destination specified in the message does not need to match the destination the message is sent to. This is handy in case the message is being sent to a dead letter destination.
    
    Specified by:
    
    send in interface Region
    
    Overrides:
    
    send in class BrokerFilter
    
    Parameters:
    
    producerExchange - the environment the operation is being executed under.
    
    Throws:
    
    Exception - TODO
  - isUseAuthenticatePrincipal
```
public boolean isUseAuthenticatePrincipal()
```
  - setUseAuthenticatePrincipal
```
public void setUseAuthenticatePrincipal(boolean useAuthenticatePrincipal)
```