Module org.apache.wicket.core

Package org.apache.wicket.request.resource

Class ResourceStreamResource

java.lang.Object

org.apache.wicket.request.resource.AbstractResource

org.apache.wicket.request.resource.ResourceStreamResource

All Implemented Interfaces:

Serializable, IResource, IClusterable

public class ResourceStreamResource
extends AbstractResource

A resource that loads its data from IResourceStream

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.request.resource.AbstractResource

AbstractResource.ContentRangeType, AbstractResource.ResourceResponse, AbstractResource.WriteCallback

Nested classes/interfaces inherited from interface org.apache.wicket.request.resource.IResource

IResource.Attributes

Field Summary

Fields inherited from class org.apache.wicket.request.resource.AbstractResource

CONTENT_DISPOSITION_HEADER_NAME, CONTENT_RANGE_ENDBYTE, CONTENT_RANGE_STARTBYTE, INTERNAL_HEADERS

Constructor Summary

Constructors

Constructor	Description
ResourceStreamResource()	Constructor.
ResourceStreamResource(IResourceStream stream)	Constructor.

Method Summary

Modifier and Type	Method	Description
Duration	getCacheDuration()
protected IResourceStream	getResourceStream(IResource.Attributes attributes)	Lazy or dynamic initialization of the wrapped IResourceStream(Writer)
protected AbstractResource.ResourceResponse	newResourceResponse(IResource.Attributes attributes)	Override this method to return a AbstractResource.ResourceResponse for the request.
ResourceStreamResource	setCacheDuration(Duration cacheDuration)
ResourceStreamResource	setContentDisposition(ContentDisposition contentDisposition)
ResourceStreamResource	setFileName(String fileName)
ResourceStreamResource	setTextEncoding(String textEncoding)

Methods inherited from class org.apache.wicket.request.resource.AbstractResource

configureCache, getCachingStrategy, respond, setRequestMetaData, setRequestRangeMetaData, setResponseContentRangeHeaderFields, setResponseHeaders

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceStreamResource

public ResourceStreamResource()

Constructor.

ResourceStreamResource

public ResourceStreamResource(IResourceStream stream)

Constructor.

Parameters:

stream - the resource stream to read from

Method Details

setFileName

public ResourceStreamResource setFileName(String fileName)

Parameters:

fileName -

Returns:

this object, for chaining

setContentDisposition

public ResourceStreamResource setContentDisposition(ContentDisposition contentDisposition)

Parameters:

contentDisposition -

Returns:

this object, for chaining

setTextEncoding

public ResourceStreamResource setTextEncoding(String textEncoding)

Parameters:

textEncoding -

Returns:

this object, for chaining

getCacheDuration

public Duration getCacheDuration()

Returns:

the duration for which the resource will be cached by the browser

setCacheDuration

public ResourceStreamResource setCacheDuration(Duration cacheDuration)

Parameters:

cacheDuration - the duration for which the resource will be cached by the browser

Returns:

this object, for chaining

getResourceStream

protected IResourceStream getResourceStream(IResource.Attributes attributes)

Lazy or dynamic initialization of the wrapped IResourceStream(Writer)

Parameters:

attributes - The request attributes

Returns:

the underlying IResourceStream. May be null.

newResourceResponse

protected AbstractResource.ResourceResponse newResourceResponse(IResource.Attributes attributes)

Description copied from class: AbstractResource

Override this method to return a AbstractResource.ResourceResponse for the request.

Specified by:

newResourceResponse in class AbstractResource

Parameters:

attributes - request attributes

Returns:

resource data instance