Package 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:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resource, Aware, BeanNameAware, InputStreamSource, Resource

public class ConditionalResource
extends AbstractIdentifiedInitializableComponent
implements Resource, BeanNameAware, 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	Description
private static final String	DEFAULT_CONTENT	Dummy content.
private String	defaultContent	Content to return if the resource is missing.
private final org.slf4j.Logger	log	Logger.
private String	logPrefix	Cached log prefix.
private final Resource	wrappedResource	Resource to wrap.

Constructor Summary

Constructors

Constructor	Description
ConditionalResource(Resource wrapped)	Constructor.

Method Summary

Modifier and Type	Method	Description
long	contentLength()
Resource	createRelative(String relativePath)
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	setDefaultContent(String content)	Set the default content to return if the underlying resource is absent.
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

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

isFile, readableChannel

Field Details

DEFAULT_CONTENT

@Nonnull
@NotEmpty
private static final String DEFAULT_CONTENT

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 Resource wrappedResource

Resource to wrap.

defaultContent

@NonnullAfterInit
private String defaultContent

Content to return if the resource is missing.

Constructor Details

ConditionalResource

public ConditionalResource(@Nonnull
 Resource wrapped)

Constructor.

Parameters:

wrapped - the resource to wrap

Method Details

setId

public void setId(@Nonnull @NotEmpty
 String id)

Overrides:

setId in class AbstractIdentifiedInitializableComponent

setDefaultContent

public void setDefaultContent(@Nonnull
 String content)

Set the default content to return if the underlying resource is absent.

Parameters:

content - default "empty" content

Since:

6.1.0

getInputStream

@Nonnull
public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface InputStreamSource

Specified by:

getInputStream in interface Resource

Throws:

IOException

createRelativeResource

public Resource createRelativeResource(String relativePath)
                                throws IOException

Specified by:

createRelativeResource in interface Resource

Throws:

IOException

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

exists

public boolean exists()

Specified by:

exists in interface Resource

Specified by:

exists in interface Resource

isReadable

public boolean isReadable()

Specified by:

isReadable in interface Resource

Specified by:

isReadable in interface Resource

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Resource

Specified by:

isOpen in interface Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface Resource

Specified by:

getURL in interface Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface Resource

Specified by:

getURI in interface Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface Resource

Specified by:

getFile in interface Resource

Throws:

IOException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Specified by:

contentLength in interface Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Specified by:

lastModified in interface Resource

Throws:

IOException

createRelative

public Resource createRelative(String relativePath)
                        throws IOException

Specified by:

createRelative in interface Resource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface Resource

Specified by:

getFilename in interface Resource

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource

Specified by:

getDescription in interface 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