com.mirth.connect.server.userutil
Class DestinationSet

java.lang.Object
  com.mirth.connect.server.userutil.DestinationSet

public class DestinationSet
extends java.lang.Object

Utility class used in the preprocessor or source filter/transformer to prevent the message from being sent to specific destinations.

Constructor Summary

DestinationSet(ImmutableConnectorMessage connectorMessage)
DestinationSet instances should NOT be constructed manually.

Method Summary

boolean	remove(java.util.Collection<java.lang.Object> metaDataIdOrConnectorNames) Stop a destination from being processed for this message.
boolean	remove(java.lang.Object metaDataIdOrConnectorName) Stop a destination from being processed for this message.
boolean	removeAll() Stop all destinations from being processed for this message.
boolean	removeAllExcept(java.util.Collection<java.lang.Object> metaDataIdOrConnectorNames) Stop all except one destination from being processed for this message.
boolean	removeAllExcept(java.lang.Object metaDataIdOrConnectorName) Stop all except one destination from being processed for this message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DestinationSet

public DestinationSet(ImmutableConnectorMessage connectorMessage)

DestinationSet instances should NOT be constructed manually. The instance "destinationSet" provided in the scope should be used.

Method Detail

remove

public boolean remove(java.lang.Object metaDataIdOrConnectorName)

Stop a destination from being processed for this message.

Parameters:

metaDataIdOrConnectorName - An integer representing the metaDataId of a destination connector, or the actual destination connector name.

Returns:

A boolean indicating whether at least one destination connector was actually removed from processing for this message.

remove

public boolean remove(java.util.Collection<java.lang.Object> metaDataIdOrConnectorNames)

Stop a destination from being processed for this message.

Parameters:

metaDataIdOrConnectorNames - A collection of integers representing the metaDataId of a destination connectors, or the actual destination connector names. JavaScript arrays can be used.

Returns:

A boolean indicating whether at least one destination connector was actually removed from processing for this message.

removeAllExcept

public boolean removeAllExcept(java.lang.Object metaDataIdOrConnectorName)

Stop all except one destination from being processed for this message.

Parameters:

metaDataIdOrConnectorName - An integer representing the metaDataId of a destination connector, or the actual destination connector name.

Returns:

A boolean indicating whether at least one destination connector was actually removed from processing for this message.

removeAllExcept

public boolean removeAllExcept(java.util.Collection<java.lang.Object> metaDataIdOrConnectorNames)

Stop all except one destination from being processed for this message.

Parameters:

metaDataIdOrConnectorNames - A collection of integers representing the metaDataId of a destination connectors, or the actual destination connector names. JavaScript arrays can be used.

Returns:

A boolean indicating whether at least one destination connector was actually removed from processing for this message.

removeAll

public boolean removeAll()

Stop all destinations from being processed for this message. This does NOT mark the source message as FILTERED.

Returns:

A boolean indicating whether at least one destination connector was actually removed from processing for this message.