LibraryLink ToToggle FramesPrintFeedback
Prev   Next

The Message Interface

Overview

An instance of org.apache.camel.Message type can represent any kind of message (In or Out). Figure 11.1 shows the inheritance hierarchy for the message type. You do not always need to implement a custom message type for a component. In many cases, the default implementation, DefaultMessage, is adequate.

Figure 11.1. Message Inheritance Hierarchy

Message inheritance hierarchy

The Message interface

Example 11.1 shows the definition of the org.apache.camel.Message interface.

Example 11.1. Message Interface

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);
    <T> T getHeader(String name, Class<T> type);
    void setHeader(String name, Object value);
    Object removeHeader(String name);
    Map<String, Object> getHeaders();
    void setHeaders(Map<String, Object> headers);
    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 methods

The Message interface defines the following methods:

Prev Up Next
 Home