INT-3557 Clarify MessageHeaders Constants

JIRA: https://jira.spring.io/browse/INT-3557

Add class names and code tags.

Add missing header constants.

Polishing for `timestamp` header doc.

Fix JavaDocs issues: https://build.spring.io/browse/INT-EIGHTAPI-296
This commit is contained in:
Gary Russell
2014-11-10 09:51:35 -05:00
committed by Artem Bilan
parent 0cc9273a2e
commit 0f568c0526
5 changed files with 95 additions and 30 deletions

View File

@@ -46,6 +46,10 @@ public class IntegrationMessageHeaderAccessor extends MessageHeaderAccessor {
public static final String SEQUENCE_DETAILS = "sequenceDetails";
/**
* @deprecated Not used; will be removed in 4.2.
*/
@Deprecated
public static final String POSTPROCESS_RESULT = "postProcessResult";
public static final String ROUTING_SLIP = "routingSlip";
@@ -107,7 +111,7 @@ public class IntegrationMessageHeaderAccessor extends MessageHeaderAccessor {
}
else if (IntegrationMessageHeaderAccessor.ROUTING_SLIP.equals(headerName)) {
Assert.isTrue(Map.class.isAssignableFrom(headerValue.getClass()), "The '" + headerName
+ "' header value must be an List.");
+ "' header value must be a Map.");
}
else if (IntegrationMessageHeaderAccessor.DUPLICATE_MESSAGE.equals(headerName)) {
Assert.isTrue(Boolean.class.isAssignableFrom(headerValue.getClass()), "The '" + headerName

View File

@@ -124,6 +124,7 @@ public class DefaultHeaderChannelRegistry extends IntegrationObjectSupport
/**
* @deprecated - this class will not implement {@link SmartLifecycle} in 4.2, just {@code Lifecycle}.
* @param phase - the phase to set.
*/
@Deprecated
public final void setPhase(int phase) {
@@ -141,6 +142,7 @@ public class DefaultHeaderChannelRegistry extends IntegrationObjectSupport
/**
* @deprecated - this class will not implement {@link SmartLifecycle} in 4.2, just {@code Lifecycle}.
* @param autoStartup the boolean flag to specify {@code autoStartup} behaviour.
*/
@Deprecated
public final void setAutoStartup(boolean autoStartup) {

View File

@@ -33,8 +33,9 @@ import org.springframework.util.Assert;
* Used to advise {@link MessageHandler}s.
* Two expressions 'onSuccessExpression' and 'onFailureExpression' are evaluated when
* appropriate. If the evaluation returns a result, a message is sent to the onSuccessChannel
* or onFailureChannel as appropriate; the message is the input message with a header
* {@link org.springframework.integration.IntegrationMessageHeaderAccessor#POSTPROCESS_RESULT} containing the evaluation result.
* or onFailureChannel as appropriate; the message is an {@link AdviceMessage}
* containing the evaluation result in its payload and the {@code inputMessage} property containing
* the original message that was sent to the endpoint.
* The failure expression is NOT evaluated if the success expression throws an exception.
*
* @author Gary Russell

View File

@@ -25,10 +25,10 @@ import org.springframework.util.Assert;
/**
* The {@link MessageSelector} implementation using a {@link ConcurrentMetadataStore}
* and {@link MessageProcessor<String>}.
* and {@link MessageProcessor}.
* <p>
* The {@link #accept} method extracts {@code metadataKey} from the provided {@code message}
* using {@link MessageProcessor<String>} and uses the {@code timestamp} header as the {@code value}
* using {@link MessageProcessor} and uses the {@code timestamp} header as the {@code value}
* (hex) by default. The {@link #valueStrategy} can be provided to override the default behaviour.
* <p>
* The successful result of the {@link #accept} method is based on the