public class CorrelationRuleFilter extends RuleFilter
correlation id
content type
subject
message id
reply-to
reply-to session id
session id
to
user-defined properties
A match exists when an arriving message's value for a property is equal to the value specified in the correlation
filter. For string expressions, the comparison is case-sensitive. When specifying multiple match properties, the
filter combines them as a logical AND
condition, meaning all conditions must match for the filter to
match.
This provides an efficient shortcut for declarations of filters that deal only with correlation
equality. In this case the cost of the lexigraphical analysis of the expression can be avoided. Not only will
correlation filters be optimized at declaration time, but they will also be optimized at runtime. Correlation filter
matching can be reduced to a hashtable lookup, which aggregates the complexity of the set of defined correlation
filters to O(1)
.
Constructor and Description |
---|
CorrelationRuleFilter()
Initializes a new instance of
CorrelationRuleFilter with default values. |
CorrelationRuleFilter(String correlationId)
Initializes a new instance of
CorrelationRuleFilter with default values with the specified correlation
identifier. |
Modifier and Type | Method and Description |
---|---|
String |
getContentType()
Gets the content type of the message.
|
String |
getCorrelationId()
Gets the correlation identifier.
|
String |
getLabel()
Gets the application specific label.
|
String |
getMessageId()
Gets the identifier for the message.
|
Map<String,Object> |
getProperties()
Gets application specific properties of the message.
|
String |
getReplyTo()
Gets the address of the queue or subscription to reply to.
|
String |
getReplyToSessionId()
Gets the session identifier to reply to.
|
String |
getSessionId()
Gets the session identifier.
|
String |
getTo()
Gets the address to send to.
|
CorrelationRuleFilter |
setContentType(String contentType)
Sets the content type of the message.
|
CorrelationRuleFilter |
setCorrelationId(String correlationId)
Sets the correlation identifier.
|
CorrelationRuleFilter |
setLabel(String label)
Sets the application specific label.
|
CorrelationRuleFilter |
setMessageId(String messageId)
Sets the identifier for the message.
|
CorrelationRuleFilter |
setReplyTo(String replyTo)
Sets the address of the queue or subscription to reply to.
|
CorrelationRuleFilter |
setReplyToSessionId(String replyToSessionId)
Sets the session identifier to reply to.
|
CorrelationRuleFilter |
setSessionId(String sessionId)
Sets the session identifier.
|
CorrelationRuleFilter |
setTo(String to)
Sets the address to send to.
|
String |
toString()
Converts the value of the current instance to its equivalent string representation.
|
public CorrelationRuleFilter()
CorrelationRuleFilter
with default values.public CorrelationRuleFilter(String correlationId)
CorrelationRuleFilter
with default values with the specified correlation
identifier.correlationId
- The identifier for the correlation.IllegalArgumentException
- If correlationId
is an empty string.NullPointerException
- If correlationId
is null.public String getContentType()
public CorrelationRuleFilter setContentType(String contentType)
contentType
- The content type of the message.CorrelationRuleFilter
itself.public String getCorrelationId()
public CorrelationRuleFilter setCorrelationId(String correlationId)
correlationId
- The correlation identifier.CorrelationRuleFilter
itself.public String getLabel()
public CorrelationRuleFilter setLabel(String label)
label
- The application specific label.CorrelationRuleFilter
itself.public String getMessageId()
public CorrelationRuleFilter setMessageId(String messageId)
messageId
- The identifier for the message.CorrelationRuleFilter
itself.public Map<String,Object> getProperties()
public String getReplyTo()
public CorrelationRuleFilter setReplyTo(String replyTo)
replyTo
- The address of the queue or subscription to reply to.CorrelationRuleFilter
itself.public String getReplyToSessionId()
public CorrelationRuleFilter setReplyToSessionId(String replyToSessionId)
replyToSessionId
is 128.replyToSessionId
- The session identifier to reply to.CorrelationRuleFilter
itself.public String getSessionId()
public CorrelationRuleFilter setSessionId(String sessionId)
sessionId
is 128 chars.sessionId
- The session identifier.CorrelationRuleFilter
itself.public String getTo()
public CorrelationRuleFilter setTo(String to)
to
- The address to send to.CorrelationRuleFilter
itself.Copyright © 2021 Microsoft Corporation. All rights reserved.