/**
 * Copyright (c) 2017-2024 Linagora
 * 
 * This program/library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * This program/library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program/library; If not, see http://www.gnu.org/licenses/
 * for the GNU Lesser General Public License version 2.1.
 */
package org.ow2.petals.binding.rest.utils;

import java.util.Map;

import javax.jbi.messaging.MessagingException;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;

import org.ow2.petals.component.framework.api.message.Exchange;
import org.w3c.dom.Document;

/**
 * <p>
 * An {@link Exchange} having IN message cached.
 * </p>
 * <p>
 * This interface changes contract of {@link Exchange} adding:
 * </p>
 * <ul>
 * <li>the method {@link #getInMessageContentAsDocument()} reads once the IN message {@link Source} and the result is
 * cached for next accesses,</li>
 * <li>for method {@link #getInMessageContentAsSource()}, if the IN message {@link Source} was previously read by
 * {@link #getInMessageContentAsDocument()}, a new {@link DOMSource} from the cached source is returned, otherwise, the
 * original source is returned.</li>
 * </ul>
 * 
 * @author Christophe DENEUX - Linagora
 *
 */
public interface CachedExchange {

    Exchange getExchange();

    Map<String, String> getUriParameters();

    Document getInMessageContentAsDocument() throws MessagingException;

    Source getInMessageContentAsSource() throws MessagingException;
}