Module net.shibboleth.ext.spring

Package net.shibboleth.ext.spring.resource

Class ResourceHelper

java.lang.Object

net.shibboleth.ext.spring.resource.ResourceHelper

All Implemented Interfaces:

Resource

public final class ResourceHelper
extends Object
implements Resource

Bridging class between Resource and Resource.

Field Summary

Fields

Modifier and Type	Field	Description
private Resource	springResource	The cached Spring Resource.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ResourceHelper(Resource theResource)	A private for shimming the provided input.

Method Summary

Modifier and Type	Method	Description
long	contentLength()
Resource	createRelativeResource(String relativePath)
boolean	exists()
String	getDescription()
File	getFile()
String	getFilename()
InputStream	getInputStream()
URI	getURI()
URL	getURL()
boolean	isOpen()
boolean	isReadable()
long	lastModified()
static Resource	of(Resource springResource)	Return a Resource that does all the work of the provided Resource.

Methods inherited from class java.lang.Object

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

Field Detail

springResource

private Resource springResource

The cached Spring Resource.

Constructor Detail

ResourceHelper

private ResourceHelper(@Nonnull
                       Resource theResource)

A private for shimming the provided input.

Parameters:

theResource - the spring resource;

Method Detail

of

@Nonnull
public static Resource of(@ParameterName(name="springResource")
                          Resource springResource)

Return a Resource that does all the work of the provided Resource.

If the input implements Resource then it is cast to the output, other a shim class is generated.

Parameters:

springResource - the input

Returns:

a Resource which reflects what the Spring one does

getInputStream

@Nonnull
public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface Resource

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface Resource

isReadable

public boolean isReadable()

Specified by:

isReadable in interface Resource

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface Resource

Throws:

IOException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Throws:

IOException

createRelativeResource

public Resource createRelativeResource(String relativePath)
                                throws IOException

Specified by:

createRelativeResource in interface Resource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface Resource

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource