net.shibboleth.ext.spring.resource

Class ResourceHelper

java.lang.Object

net.shibboleth.ext.spring.resource.ResourceHelper

All Implemented Interfaces:

net.shibboleth.utilities.java.support.resource.Resource

public final class ResourceHelper
extends Object
implements net.shibboleth.utilities.java.support.resource.Resource

Bridging class between Resource and Resource.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
long	contentLength()
net.shibboleth.utilities.java.support.resource.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 net.shibboleth.utilities.java.support.resource.Resource	of(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.

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

public static net.shibboleth.utilities.java.support.resource.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

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface net.shibboleth.utilities.java.support.resource.Resource

isReadable

public boolean isReadable()

Specified by:

isReadable in interface net.shibboleth.utilities.java.support.resource.Resource

isOpen

public boolean isOpen()

Specified by:

isOpen in interface net.shibboleth.utilities.java.support.resource.Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

createRelativeResource

public net.shibboleth.utilities.java.support.resource.Resource createRelativeResource(String relativePath)
                                                                               throws IOException

Specified by:

createRelativeResource in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface net.shibboleth.utilities.java.support.resource.Resource

getDescription

public String getDescription()

Specified by:

getDescription in interface net.shibboleth.utilities.java.support.resource.Resource