Package org.apache.activemq.artemis.core.config

Class DivertConfiguration

java.lang.Object

org.apache.activemq.artemis.core.config.DivertConfiguration

All Implemented Interfaces:

Serializable, EncodingSupport

public class DivertConfiguration
extends Object
implements Serializable, EncodingSupport

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADDRESS
static String	EXCLUSIVE
static String	FILTER_STRING
static String	FORWARDING_ADDRESS
static String	NAME
static String	ROUTING_NAME
static String	ROUTING_TYPE
static String	TRANSFORMER_CONFIGURATION

Constructor Summary

Constructors

Constructor	Description
DivertConfiguration()

Method Summary

Modifier and Type	Method	Description
void	decode(ActiveMQBuffer buffer)
void	encode(ActiveMQBuffer buffer)
boolean	equals(Object obj)
static DivertConfiguration	fromJSON(String jsonString)	This method returns a DivertConfiguration created from the JSON-formatted input String.
String	getAddress()
int	getEncodeSize()
String	getFilterString()
String	getForwardingAddress()
String	getName()
String	getRoutingName()
ComponentConfigurationRoutingType	getRoutingType()
TransformerConfiguration	getTransformerConfiguration()
int	hashCode()
boolean	isExclusive()
DivertConfiguration	set(String key, String value)	Set the value of a parameter based on its "key" String.
DivertConfiguration	setAddress(String address)
DivertConfiguration	setExclusive(boolean exclusive)
DivertConfiguration	setFilterString(String filterString)
DivertConfiguration	setForwardingAddress(String forwardingAddress)
DivertConfiguration	setName(String name)
DivertConfiguration	setRoutingName(String routingName)	Sets the routingName.
DivertConfiguration	setRoutingType(ComponentConfigurationRoutingType routingType)
DivertConfiguration	setTransformerConfiguration(TransformerConfiguration transformerConfiguration)
String	toJSON()	This method returns a JSON-formatted String representation of this DivertConfiguration.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static String NAME

ROUTING_NAME

public static String ROUTING_NAME

ADDRESS

public static String ADDRESS

FORWARDING_ADDRESS

public static String FORWARDING_ADDRESS

EXCLUSIVE

public static String EXCLUSIVE

FILTER_STRING

public static String FILTER_STRING

TRANSFORMER_CONFIGURATION

public static String TRANSFORMER_CONFIGURATION

ROUTING_TYPE

public static String ROUTING_TYPE

Constructor Details

DivertConfiguration

public DivertConfiguration()

Method Details

set

public DivertConfiguration set(String key,
 String value)

Set the value of a parameter based on its "key" String. Valid key names and corresponding static final are:

• name: NAME
• routing-name: ROUTING_NAME
• address: ADDRESS
• forwarding-address: FORWARDING_ADDRESS
• exclusive: EXCLUSIVE
• filter-string: FILTER_STRING
• transformer-configuration: TRANSFORMER_CONFIGURATION
• routing-type: ROUTING_TYPE

The String-based values will be converted to the proper value types based on the underlying property. For example, if you pass the value "TRUE" for the key "exclusive" the String "TRUE" will be converted to the Boolean true.

Parameters:

key - the key to set to the value

value - the value to set for the key

Returns:

this DivertConfiguration

getName

public String getName()

getRoutingName

public String getRoutingName()

getAddress

public String getAddress()

getForwardingAddress

public String getForwardingAddress()

isExclusive

public boolean isExclusive()

getFilterString

public String getFilterString()

getTransformerConfiguration

public TransformerConfiguration getTransformerConfiguration()

getRoutingType

public ComponentConfigurationRoutingType getRoutingType()

setName

public DivertConfiguration setName(String name)

setRoutingName

public DivertConfiguration setRoutingName(String routingName)

Sets the routingName. If the input is null then a random routingName will be generated.

Parameters:

routingName - the routingName to set

setAddress

public DivertConfiguration setAddress(String address)

setForwardingAddress

public DivertConfiguration setForwardingAddress(String forwardingAddress)

setExclusive

public DivertConfiguration setExclusive(boolean exclusive)

setFilterString

public DivertConfiguration setFilterString(String filterString)

setTransformerConfiguration

public DivertConfiguration setTransformerConfiguration(TransformerConfiguration transformerConfiguration)

setRoutingType

public DivertConfiguration setRoutingType(ComponentConfigurationRoutingType routingType)

toJSON

public String toJSON()

This method returns a JSON-formatted String representation of this DivertConfiguration. It is a simple collection of key/value pairs. The keys used are referenced in set(String, String).

Returns:

a JSON-formatted String representation of this DivertConfiguration

fromJSON

public static DivertConfiguration fromJSON(String jsonString)

This method returns a DivertConfiguration created from the JSON-formatted input String. The input should be a simple object of key/value pairs. Valid keys are referenced in set(String, String).

Parameters:

jsonString - json string

Returns:

the DivertConfiguration created from the JSON-formatted input String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEncodeSize

public int getEncodeSize()

Specified by:

getEncodeSize in interface EncodingSupport

encode

public void encode(ActiveMQBuffer buffer)

Specified by:

encode in interface EncodingSupport

toString

public String toString()

Overrides:

toString in class Object

decode

public void decode(ActiveMQBuffer buffer)

Specified by:

decode in interface EncodingSupport