EncodedResourceResolver.EncodedResource

java.lang.Object
- org.springframework.core.io.AbstractResource
- - org.springframework.web.servlet.resource.EncodedResourceResolver.EncodedResource

All Implemented Interfaces:

InputStreamSource, Resource, HttpResource

Enclosing class:

EncodedResourceResolver
```
static final class EncodedResourceResolver.EncodedResource
extends AbstractResource
implements HttpResource
```
An encoded HttpResource.

Field Summary

Fields
Modifier and Type Field and Description

private java.lang.String coding

private Resource encoded

private Resource original

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`coding`
`private Resource`	`encoded`
`private Resource`	`original`

Constructor Summary

Constructors
Constructor and Description

EncodedResource(Resource original, java.lang.String coding, java.lang.String extension)

Constructors
Constructor and Description
`EncodedResource(Resource original, java.lang.String coding, java.lang.String extension)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`contentLength()` This implementation reads the entire InputStream to calculate the content length.
`Resource`	`createRelative(java.lang.String relativePath)` This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.
`boolean`	`exists()` This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.
`java.lang.String`	`getDescription()` Return a description for this resource, to be used for error output when working with the resource.
`java.io.File`	`getFile()` This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.
`java.lang.String`	`getFilename()` This implementation always returns `null`, assuming that this resource type does not have a filename.
`java.io.InputStream`	`getInputStream()` Return an `InputStream` for the content of an underlying resource.
`HttpHeaders`	`getResponseHeaders()` The HTTP headers to be contributed to the HTTP response that serves the current resource.
`java.net.URI`	`getURI()` This implementation builds a URI based on the URL returned by `AbstractResource.getURL()`.
`java.net.URL`	`getURL()` This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.
`boolean`	`isFile()` This implementation always returns `false`.
`boolean`	`isOpen()` This implementation always returns `false`.
`boolean`	`isReadable()` This implementation always returns `true` for a resource that `exists` (revised as of 5.1).
`long`	`lastModified()` This implementation checks the timestamp of the underlying File, if available.

Methods inherited from class org.springframework.core.io.AbstractResource
equals, getFileForLastModifiedCheck, hashCode, readableChannel, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.io.Resource
readableChannel

- Field Detail
  - original
```
private final Resource original
```
  - coding
```
private final java.lang.String coding
```
  - encoded
```
private final Resource encoded
```
- Constructor Detail
  - EncodedResource
```
EncodedResource(Resource original,
                java.lang.String coding,
                java.lang.String extension)
         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Description copied from interface: InputStreamSource
    
    Return an InputStream 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.
    
    Specified by:
    
    getInputStream in interface InputStreamSource
    
    Returns:
    
    the input stream for the underlying resource (must not be null)
    
    Throws:
    
    java.io.FileNotFoundException - if the underlying resource doesn't exist
    
    java.io.IOException - if the content stream could not be opened
  - exists
```
public boolean exists()
```
    Description copied from class: AbstractResource
    
    This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened. This will cover both directories and content resources.
    
    Specified by:
    
    exists in interface Resource
    
    Overrides:
    
    exists in class AbstractResource
  - isReadable
```
public boolean isReadable()
```
    Description copied from class: AbstractResource
    
    This implementation always returns true for a resource that exists (revised as of 5.1).
    
    Specified by:
    
    isReadable in interface Resource
    
    Overrides:
    
    isReadable in class AbstractResource
    
    See Also:
    
    InputStreamSource.getInputStream(), Resource.exists()
  - isOpen
```
public boolean isOpen()
```
    Description copied from class: AbstractResource
    
    This implementation always returns false.
    
    Specified by:
    
    isOpen in interface Resource
    
    Overrides:
    
    isOpen in class AbstractResource
  - isFile
```
public boolean isFile()
```
    Description copied from class: AbstractResource
    
    This implementation always returns false.
    
    Specified by:
    
    isFile in interface Resource
    
    Overrides:
    
    isFile in class AbstractResource
    
    See Also:
    
    Resource.getFile()
  - getURL
```
public java.net.URL getURL()
                    throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.
    
    Specified by:
    
    getURL in interface Resource
    
    Overrides:
    
    getURL in class AbstractResource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as descriptor
  - getURI
```
public java.net.URI getURI()
                    throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation builds a URI based on the URL returned by AbstractResource.getURL().
    
    Specified by:
    
    getURI in interface Resource
    
    Overrides:
    
    getURI in class AbstractResource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as descriptor
  - getFile
```
public java.io.File getFile()
                     throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.
    
    Specified by:
    
    getFile in interface Resource
    
    Overrides:
    
    getFile in class AbstractResource
    
    Throws:
    
    java.io.FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system
    
    java.io.IOException - in case of general resolution/reading failures
    
    See Also:
    
    InputStreamSource.getInputStream()
  - contentLength
```
public long contentLength()
                   throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation reads the entire InputStream to calculate the content length. Subclasses will almost always be able to provide a more optimal version of this, e.g. checking a File length.
    
    Specified by:
    
    contentLength in interface Resource
    
    Overrides:
    
    contentLength in class AbstractResource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
    
    See Also:
    
    InputStreamSource.getInputStream()
  - lastModified
```
public long lastModified()
                  throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation checks the timestamp of the underlying File, if available.
    
    Specified by:
    
    lastModified in interface Resource
    
    Overrides:
    
    lastModified in class AbstractResource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
    
    See Also:
    
    AbstractResource.getFileForLastModifiedCheck()
  - createRelative
```
public Resource createRelative(java.lang.String relativePath)
                        throws java.io.IOException
```
    Description copied from class: AbstractResource
    
    This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.
    
    Specified by:
    
    createRelative in interface Resource
    
    Overrides:
    
    createRelative in class AbstractResource
    
    Parameters:
    
    relativePath - the relative path (relative to this resource)
    
    Returns:
    
    the resource handle for the relative resource
    
    Throws:
    
    java.io.IOException - if the relative resource cannot be determined
  - getFilename
```
@Nullable
public java.lang.String getFilename()
```
    Description copied from class: AbstractResource
    
    This implementation always returns null, assuming that this resource type does not have a filename.
    
    Specified by:
    
    getFilename in interface Resource
    
    Overrides:
    
    getFilename in class AbstractResource
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Resource
    
    Return a description for this resource, to be used for error output when working with the resource.
    Implementations are also encouraged to return this value from their toString method.
    
    Specified by:
    
    getDescription in interface Resource
    
    See Also:
    
    Object.toString()
  - getResponseHeaders
```
public HttpHeaders getResponseHeaders()
```
    Description copied from interface: HttpResource
    
    The HTTP headers to be contributed to the HTTP response that serves the current resource.
    
    Specified by:
    
    getResponseHeaders in interface HttpResource
    
    Returns:
    
    the HTTP response headers

Class EncodedResourceResolver.EncodedResource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.springframework.core.io.AbstractResource

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.core.io.Resource

Field Detail

original

coding

encoded

Constructor Detail

EncodedResource

Method Detail

getInputStream

exists

isReadable

isOpen

isFile

getURL

getURI

getFile

contentLength

lastModified

createRelative

getFilename

getDescription

getResponseHeaders