Package org.springframework.core.io
Interface InputStreamSource
- All Known Subinterfaces:
ContextResource
,EncodedResource
,MultipartFile
,Resource
,VersionedResource
,WritableResource
- All Known Implementing Classes:
AbstractFileResolvingResource
,AbstractResource
,ByteArrayResource
,ClassPathResource
,CommonsMultipartFile
,DefaultResourceLoader.ClassPathContextResource
,DescriptiveResource
,EncodedResource
,FileSystemResource
,InputStreamResource
,MockMultipartFile
,PathResource
,PortletContextResource
,ServletContextResource
,TransformedResource
,UrlResource
,VfsResource
public interface InputStreamSource
Simple interface for objects that are sources for anInputStream
.This is the base interface for Spring's more extensive
Resource
interface.For single-use streams,
InputStreamResource
can be used for any givenInputStream
. Spring'sByteArrayResource
or any file-basedResource
implementation can be used as a concrete instance, allowing one to read the underlying content stream multiple times. This makes this interface useful as an abstract content source for mail attachments, for example.- Since:
- 20.01.2004
- Author:
- Juergen Hoeller
- See Also:
InputStream
,Resource
,InputStreamResource
,ByteArrayResource
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InputStream
getInputStream()
Return anInputStream
for the content of an underlying resource.
Method Detail
getInputStream
InputStream getInputStream() throws IOException
Return anInputStream
for the content of an underlying resource.It is expected that each call creates a fresh stream.
This requirement is particularly important when you consider an API such as JavaMail, which needs to be able to read the stream multiple times when creating mail attachments. For such a use case, it is required that each
getInputStream()
call returns a fresh stream.- Returns:
- the input stream for the underlying resource (must not be
null
) - Throws:
FileNotFoundException
- if the underlying resource doesn't existIOException
- if the content stream could not be opened