net.shibboleth.ext.spring.resource

Class ConditionalResource

java.lang.Object

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

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

net.shibboleth.ext.spring.resource.ConditionalResource

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.resource.Resource, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.core.io.InputStreamSource

public class ConditionalResource
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements org.springframework.core.io.Resource, org.springframework.beans.factory.BeanNameAware, net.shibboleth.utilities.java.support.resource.Resource

A wrapper that guards a Resource that may be absent by returning an empty bean file instead.

Since:

5.4.0

Field Summary

Fields

Modifier and Type	Field and Description
private static String	EMPTY_RESOURCE Dummy content.
private org.slf4j.Logger	log Logger.
private String	logPrefix Cached log prefix.
private org.springframework.core.io.Resource	wrappedResource Resource to wrap.

Constructor Summary

Constructors

Constructor and Description
ConditionalResource(org.springframework.core.io.Resource wrapped) Constructor.

Method Summary

Modifier and Type	Method and Description
long	contentLength()
org.springframework.core.io.Resource	createRelative(String relativePath)
net.shibboleth.utilities.java.support.resource.Resource	createRelativeResource(String relativePath)
boolean	exists()
String	getDescription()
File	getFile()
String	getFilename()
InputStream	getInputStream()
protected String	getLogPrefix() Return a prefix for logging messages for this component.
URI	getURI()
URL	getURL()
boolean	isOpen()
boolean	isReadable()
long	lastModified()
void	setBeanName(String name)
void	setId(String id)

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

doInitialize, getId

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

EMPTY_RESOURCE

@Nonnull
 @NotEmpty
private static final String EMPTY_RESOURCE

Dummy content.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Logger.

logPrefix

@Nullable
private String logPrefix

Cached log prefix.

wrappedResource

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

Resource to wrap.

Constructor Detail

ConditionalResource

public ConditionalResource(@Nonnull
                           org.springframework.core.io.Resource wrapped)

Constructor.

Parameters:

wrapped - the resource to wrap

Method Detail

setId

public void setId(@Nonnull @NotEmpty
                  String id)

Overrides:

setId in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

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

Specified by:

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

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

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

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

createRelative

public org.springframework.core.io.Resource createRelative(String relativePath)
                                                    throws IOException

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

getLogPrefix

@Nonnull
 @NotEmpty
protected String getLogPrefix()

Return a prefix for logging messages for this component.

Returns:

a string for insertion at the beginning of any log messages