org.springframework.oxm.mime.MimeMarshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-oxm Show documentation

Spring Object/XML Mapping abstraction

There is a newer version: 1.5.10

/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.oxm.mime;

import java.io.IOException;
import javax.xml.transform.Result;

import org.springframework.oxm.Marshaller;
import org.springframework.oxm.XmlMappingException;

/**
 * Subinterface of {@link Marshaller} that can use MIME attachments to optimize storage of binary data. Attachments can
 * be added as MTOM, XOP, or SwA.
 *
 * @author Arjen Poutsma
 * @see SOAP Message Transmission Optimization
 *      Mechanism
 * @see XML-binary Optimized Packaging
 * @since 1.0.0
 */
public interface MimeMarshaller extends Marshaller {

    /**
     * Marshals the object graph with the given root into the provided {@link Result}, writing binary data to a {@link
     * MimeContainer}.
     *
     * @param graph         the root of the object graph to marshal
     * @param result        the result to marshal to
     * @param mimeContainer the MIME container to write extracted binary content to
     * @throws XmlMappingException if the given object cannot be marshalled to the result
     * @throws IOException         if an I/O exception occurs
     */
    void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException, IOException;


}