Module org.apache.wicket.core

Package org.apache.wicket.core.util.resource

Class WebExternalResourceStream

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.core.util.resource.WebExternalResourceStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, IClusterable, IResourceStream, IModifiable

public class WebExternalResourceStream
extends AbstractResourceStream

An IResourceStream that reads data from a file in the web application

Author:

Jean-Baptiste Quenot

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebExternalResourceStream(String url)	Construct.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the resource.
String	getContentType()	Gets the mime type of this resource
InputStream	getInputStream()	Gets the resource stream.
Instant	lastModifiedTime()	Gets the last time this modifiable thing changed.
Bytes	length()	Gets the size of this resource

Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream

getLocale, getStyle, getVariation, setLocale, setStyle, setVariation

Methods inherited from class java.lang.Object

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

Constructor Details

WebExternalResourceStream

public WebExternalResourceStream(String url)

Construct.

Parameters:

url - the relative url of the external resource

Method Details

length

public Bytes length()

Description copied from interface: IResourceStream

Gets the size of this resource

Specified by:

length in interface IResourceStream

Overrides:

length in class AbstractResourceStream

Returns:

The size of this resource in the number of bytes, or null if unknown

close

public void close()
           throws IOException

Description copied from interface: IResourceStream

Closes the resource. Normally, this includes closing any underlying input stream returned by getInputStream().

Throws:

IOException

lastModifiedTime

public Instant lastModifiedTime()

Description copied from interface: IModifiable

Gets the last time this modifiable thing changed.

Specified by:

lastModifiedTime in interface IModifiable

Overrides:

lastModifiedTime in class AbstractResourceStream

Returns:

the last modification Time or null if that information is not available

getContentType

public String getContentType()

Description copied from interface: IResourceStream

Gets the mime type of this resource

Specified by:

getContentType in interface IResourceStream

Overrides:

getContentType in class AbstractResourceStream

Returns:

The mime type of this resource, such as "image/jpeg" or "text/html". Return null to let ResourceStreamRequestHandler handle the Content-Type automatically

getInputStream

public InputStream getInputStream()
                           throws ResourceStreamNotFoundException

Description copied from interface: IResourceStream

Gets the resource stream. You should not directly close this stream. Instead call the close() method on IResourceStream.

Returns:

Returns the inputStream.

Throws:

ResourceStreamNotFoundException

See Also:

• IResourceStream.close()