1 /* 2 * Copyright 2007 the original author or authors. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package org.springframework.oxm.mime; 18 19 import java.io.IOException; 20 import javax.xml.transform.Result; 21 22 import org.springframework.oxm.Marshaller; 23 import org.springframework.oxm.XmlMappingException; 24 25 /** 26 * Subinterface of {@link Marshaller} that can use MIME attachments to optimize storage of binary data. Attachments can 27 * be added as MTOM, XOP, or SwA. 28 * 29 * @author Arjen Poutsma 30 * @see <a href="http://www.w3.org/TR/2004/WD-soap12-mtom-20040608/">SOAP Message Transmission Optimization 31 * Mechanism</a> 32 * @see <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Packaging</a> 33 * @since 1.0.0 34 */ 35 public interface MimeMarshaller extends Marshaller { 36 37 /** 38 * Marshals the object graph with the given root into the provided {@link Result}, writing binary data to a {@link 39 * MimeContainer}. 40 * 41 * @param graph the root of the object graph to marshal 42 * @param result the result to marshal to 43 * @param mimeContainer the MIME container to write extracted binary content to 44 * @throws XmlMappingException if the given object cannot be marshalled to the result 45 * @throws IOException if an I/O exception occurs 46 */ 47 void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException, IOException; 48 49 50 }