net.shibboleth.ext.spring.resource

Class FileBackedHTTPResource

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.resource.HTTPResource

net.shibboleth.ext.spring.resource.FileBackedHTTPResource

All Implemented Interfaces:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resource, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.core.io.InputStreamSource

public class FileBackedHTTPResource
extends HTTPResource

A resource representing a file read from an HTTP(S) location. Every time the file is successfully read from the URL location it is written to a backing file. If the file can not be read from the URL it is read from this backing file, if available.

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.core.io.Resource	backingResource Backing resource file.
private org.slf4j.Logger	log Logger.

Constructor Summary

Constructors

Constructor and Description
FileBackedHTTPResource(HttpClient client, String url, org.springframework.core.io.Resource resource) Deprecated. use FileBackedHTTPResource(String, HttpClient, String)
FileBackedHTTPResource(HttpClient client, URL url, org.springframework.core.io.Resource resource) Deprecated. use FileBackedHTTPResource(String, HttpClient, URL)
FileBackedHTTPResource(String backingFile, HttpClient client, String url) Constructor.
FileBackedHTTPResource(String backingFile, HttpClient client, URL url) Constructor.

Method Summary

Modifier and Type	Method and Description
long	contentLength()
HTTPResource	createRelative(String relativePath) Based on UrlResource.
boolean	exists()
String	getDescription()
InputStream	getInputStream()
long	lastModified()
protected InputStream	saveAndClone(InputStream input) saveAndClone.

Methods inherited from class net.shibboleth.ext.spring.resource.HTTPResource

afterPropertiesSet, buildHttpClientContext, closeResponse, createRelativeResource, getFile, getFilename, getResourceHeaders, getResponseHeader, getURI, getURL, isOpen, isReadable, reportCachingStatus, setBeanName, setHttpClientContextHandler

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId, setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Logger.

backingResource

@Nonnull
private final org.springframework.core.io.Resource backingResource

Backing resource file.

Constructor Detail

FileBackedHTTPResource

@Deprecated
public FileBackedHTTPResource(@Nonnull @ParameterName(name="client")
                                          HttpClient client,
                                          @NotEmpty @Nonnull @ParameterName(name="url")
                                          String url,
                                          @Nonnull @ParameterName(name="resource")
                                          org.springframework.core.io.Resource resource)
                                   throws IOException

Deprecated. use FileBackedHTTPResource(String, HttpClient, String)

Constructor.

Parameters:

client - the client we use to connect with.

url - URL to the remote data

resource - the file to use as backing store

Throws:

IOException - if the URL was badly formed

FileBackedHTTPResource

@Deprecated
public FileBackedHTTPResource(@Nonnull @ParameterName(name="client")
                                          HttpClient client,
                                          @Nonnull @NotEmpty @ParameterName(name="url")
                                          URL url,
                                          @Nonnull @ParameterName(name="resource")
                                          org.springframework.core.io.Resource resource)
                                   throws IOException

Deprecated. use FileBackedHTTPResource(String, HttpClient, URL)

Constructor.

Parameters:

client - the client we use to connect with.

url - URL to the remote data

resource - the file to use as backing store

Throws:

IOException - if the URL was badly formed

FileBackedHTTPResource

public FileBackedHTTPResource(@Nonnull @ParameterName(name="backingFile")
                              String backingFile,
                              @Nonnull @ParameterName(name="client")
                              HttpClient client,
                              @NotEmpty @Nonnull @ParameterName(name="url")
                              String url)
                       throws IOException

Constructor.

Parameters:

backingFile - the file to use as backing store

client - the client we use to connect with.

url - URL to the remote data

Throws:

IOException - if the URL was badly formed

FileBackedHTTPResource

public FileBackedHTTPResource(@Nonnull @ParameterName(name="backingFile")
                              String backingFile,
                              @Nonnull @ParameterName(name="client")
                              HttpClient client,
                              @Nonnull @ParameterName(name="url")
                              URL url)
                       throws IOException

Constructor.

Parameters:

backingFile - the file to use as backing store

client - the client we use to connect with.

url - URL to the remote data

Throws:

IOException - if the URL was badly formed

Method Detail

saveAndClone

protected InputStream saveAndClone(InputStream input)
                            throws IOException

saveAndClone. Read the contents into memory and then write out to the backing file. Finally

Parameters:

input - the input stream

Returns:

the cloned stream.

Throws:

IOException - if an error happens. If the backing file might have been corrupted we delete it.

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface Resource

Specified by:

getInputStream in interface org.springframework.core.io.InputStreamSource

Overrides:

getInputStream in class HTTPResource

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface Resource

Overrides:

exists in class HTTPResource

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Overrides:

contentLength in class HTTPResource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Overrides:

lastModified in class HTTPResource

Throws:

IOException

createRelative

public HTTPResource createRelative(String relativePath)
                            throws IOException

Based on UrlResource.

Overrides:

createRelative in class HTTPResource

Throws:

IOException

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource

Overrides:

getDescription in class HTTPResource