Module net.shibboleth.ext.spring

Package net.shibboleth.ext.spring.resource

Class RunnableFileSystemResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.core.io.FileSystemResource

net.shibboleth.ext.spring.resource.RunnableFileSystemResource

All Implemented Interfaces:

Resource, InputStreamSource, Resource, WritableResource

public class RunnableFileSystemResource
extends FileSystemResource
implements Resource, Resource

A file backed resource which calls out to a provided Runnable as appropriate such that the resource becomes reloadable.

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	The log.
private String	thePrefix	Log prefix.
private Runnable	theRunnable	What to run at the appropriate time.

Constructor Summary

Constructors

Constructor	Description
RunnableFileSystemResource(File file, Runnable runnable)	Constructor.
RunnableFileSystemResource(String path, Runnable runnable)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	callRunnable()	Call the runnable and catch every event thrown.
RunnableFileSystemResource	createRelativeResource(String relativePath)
boolean	exists()
InputStream	getInputStream()
long	lastModified()

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

contentLength, createRelative, equals, getDescription, getFile, getFilename, getOutputStream, getPath, getURI, getURL, hashCode, isFile, isReadable, isWritable, readableChannel, writableChannel

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

getFileForLastModifiedCheck, isOpen, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.resource.Resource

contentLength, getDescription, getFile, getFilename, getURI, getURL, isOpen, isReadable

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

contentLength, createRelative, getDescription, getFile, getFilename, getURI, getURL, isFile, isOpen, isReadable, readableChannel

Field Detail

theRunnable

@Nonnull
private final Runnable theRunnable

What to run at the appropriate time.

log

@Nonnull
private final org.slf4j.Logger log

The log.

thePrefix

@Nonnull
@NotEmpty
private final String thePrefix

Log prefix.

Constructor Detail

RunnableFileSystemResource

public RunnableFileSystemResource(@Nonnull @ParameterName(name="file")
                                  File file,
                                  @Nonnull @ParameterName(name="runnable")
                                  Runnable runnable)

Constructor.

Parameters:

file - The file to back.

runnable - a Runnable to call at appropriate times

RunnableFileSystemResource

public RunnableFileSystemResource(@Nonnull @NotEmpty @ParameterName(name="path")
                                  String path,
                                  @Nonnull @ParameterName(name="runnable")
                                  Runnable runnable)

Constructor.

Parameters:

path - the path to the file to look at.

runnable - a Runnable to call at appropriate times

Method Detail

createRelativeResource

public RunnableFileSystemResource createRelativeResource(String relativePath)
                                                  throws IOException

Specified by:

createRelativeResource in interface Resource

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface Resource

Specified by:

exists in interface Resource

Overrides:

exists in class FileSystemResource

getInputStream

@Nonnull
public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface InputStreamSource

Specified by:

getInputStream in interface Resource

Overrides:

getInputStream in class FileSystemResource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Specified by:

lastModified in interface Resource

Overrides:

lastModified in class FileSystemResource

Throws:

IOException

callRunnable

protected void callRunnable()
                     throws IOException

Call the runnable and catch every event thrown.

Throws:

IOException - if anything bad happens