org.springframework.oxm.mime.MimeContainer Maven / Gradle / Ivy
/*
* Copyright 2002-2012 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
*
* https://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 javax.activation.DataHandler;
import org.springframework.lang.Nullable;
/**
* Represents a container for MIME attachments
* Concrete implementations might adapt a SOAPMessage or an email message.
*
* @author Arjen Poutsma
* @since 3.0
* @see XML-binary Optimized Packaging
*/
public interface MimeContainer {
/**
* Indicate whether this container is a XOP package.
* @return {@code true} when the constraints specified in
* Identifying XOP Documents
* are met
* @see XOP Packages
*/
boolean isXopPackage();
/**
* Turn this message into a XOP package.
* @return {@code true} when the message actually is a XOP package
* @see XOP Packages
*/
boolean convertToXopPackage();
/**
* Add the given data handler as an attachment to this container.
* @param contentId the content id of the attachment
* @param dataHandler the data handler containing the data of the attachment
*/
void addAttachment(String contentId, DataHandler dataHandler);
/**
* Return the attachment with the given content id, or {@code null} if not found.
* @param contentId the content id
* @return the attachment, as a data handler
*/
@Nullable
DataHandler getAttachment(String contentId);
}