com.sun.xml.messaging.saaj.packaging.mime.MultipartDataSource Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* @(#)MultipartDataSource.java 1.6 02/03/27
*/
package com.sun.xml.messaging.saaj.packaging.mime;
import com.sun.xml.messaging.saaj.packaging.mime.internet.MimeBodyPart;
import jakarta.activation.DataSource;
/**
* MultipartDataSource is a DataSource that contains body
* parts. This allows "mail aware" DataContentHandlers to
* be implemented more efficiently by being aware of such
* DataSources and using the appropriate methods to access
* BodyParts.
*
* Note that the data of a MultipartDataSource is also available as
* an input stream.
*
* This interface will typically be implemented by providers that
* preparse multipart bodies, for example an IMAP provider.
*
* @version 1.6, 02/03/27
* @author John Mani
* @see jakarta.activation.DataSource
*/
public interface MultipartDataSource extends DataSource {
/**
* Return the number of enclosed MimeBodyPart objects.
*
* @return number of parts
*/
public int getCount();
/**
* Get the specified MimeBodyPart. Parts are numbered starting at 0.
*
* @param index the index of the desired MimeBodyPart
* @return the MimeBodyPart
* @exception IndexOutOfBoundsException if the given index
* is out of range.
* @exception MessagingException thrown in case of error
*/
public MimeBodyPart getBodyPart(int index) throws MessagingException;
}