第 44 章 消息接口


摘要

本章论述了如何实现 Message 接口,这是 Apache Camel 组件实现的可选步骤。

44.1. 消息接口

概述

一个 org.apache.camel.Message 类型的实例可以代表任何类型的消息(InOut)。图 44.1 “消息继承层次结构” 显示消息类型的继承层次结构。您不需要始终为组件实施自定义消息类型。在很多情况下,默认的实现 DefaultMessage 足够了。

图 44.1. 消息继承层次结构

消息继承层次结构

Message 接口

例 44.1 “消息接口” 显示 org.apache.camel.Message 接口的定义。

例 44.1. 消息接口

package org.apache.camel;

import java.util.Map;
import java.util.Set;

import javax.activation.DataHandler;

public interface Message {

    String getMessageId();
    void setMessageId(String messageId);

    Exchange getExchange();

    boolean isFault();
    void    setFault(boolean fault);

    Object getHeader(String name);
    Object getHeader(String name, Object defaultValue);
    <T> T getHeader(String name, Class<T> type);
    <T> T getHeader(String name, Object defaultValue, Class<T> type);
    Map<String, Object> getHeaders();
    void setHeader(String name, Object value);
    void setHeaders(Map<String, Object> headers);
    Object  removeHeader(String name);
    boolean removeHeaders(String pattern);
    boolean hasHeaders();

    Object getBody();
    Object getMandatoryBody() throws InvalidPayloadException;
    <T> T  getBody(Class<T> type);
    <T> T  getMandatoryBody(Class<T> type) throws InvalidPayloadException;
    void     setBody(Object body);
    <T> void setBody(Object body, Class<T> type);

    DataHandler getAttachment(String id);
    Map<String, DataHandler> getAttachments();
    Set<String> getAttachmentNames();
    void removeAttachment(String id);
    void addAttachment(String id, DataHandler content);
    void setAttachments(Map<String, DataHandler> attachments);
    boolean hasAttachments();

    Message copy();

    void copyFrom(Message message);

    String createExchangeId();
}

消息方法

Message 接口定义了以下方法:

  • setMessageId (), getMessageId () categories-PROFILEGetter 和 setter 方法用于消息 ID。是否需要在自定义组件中使用消息 ID 是一个实现详情。
  • getExchange () mvapichReturns 对父交换对象的引用。
  • isFault (), setFault () criu-unmarshalGetter 和 setter 方法用于 fault 标志,它指示此消息是否是 fault 消息。
  • getHeader (), getHeaders (), setHeader (), setHeaders (), removeHeader (), hasHeaders () 来包括消息标头的 setter 方法。通常,这些消息标头可用于存储实际标头数据,或存储各种元数据。
  • getBody (), getMandatoryBody (), setBody () iwl-wagonGetter 和 setter 方法用于消息正文。getMandatoryBody ()accessor 确保返回的正文不是 null,否则会抛出 InvalidPayloadException 异常。
  • getattachment (), getAttachments (), getAttachmentNames (), removeAttachment (), addAttachment (), setAttachments (), hasAttachments () to get, set, add, and remove attachments.
  • copy () criu-busyboxCreates a new, identicals a new, the message ID),当前自定义消息对象的副本。
  • 将指定通用消息对象的消息 复制到 当前消息实例中的完整内容(包括消息 ID)。由于此方法必须能够从任何消息类型复制,所以它会复制通用消息属性,但不能复制自定义属性。
  • 如果消息实施能够提供 ID;否则,createExchangeId () 将返回 null 的唯一 ID。
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.