org.xwiki.resource.servlet

Class AbstractServletResourceReferenceHandler<R extends org.xwiki.resource.ResourceReference>

java.lang.Object

org.xwiki.resource.AbstractResourceReferenceHandler<org.xwiki.resource.ResourceType>

org.xwiki.resource.servlet.AbstractServletResourceReferenceHandler<R>

Type Parameters:

R - the resource type

All Implemented Interfaces:

Comparable<org.xwiki.resource.ResourceReferenceHandler>, org.xwiki.resource.ResourceReferenceHandler<org.xwiki.resource.ResourceType>

public abstract class AbstractServletResourceReferenceHandler<R extends org.xwiki.resource.ResourceReference>
extends org.xwiki.resource.AbstractResourceReferenceHandler<org.xwiki.resource.ResourceType>

Base class for ResourceReferenceHandlers that can handle servlet resource requests.

Since:

7.4.6, 8.2.2, 8.3

Version:

$Id: f4733f9a32884c15d4c1921c7b9073196d2b8188 $

Constructor Summary

Constructors

Constructor and Description
AbstractServletResourceReferenceHandler()

Method Summary

Modifier and Type	Method and Description
protected InputStream	filterResource(R resourceReference, InputStream resourceStream) Filter the resource before sending it to the client.
protected String	getContentType(InputStream resourceStream, R resourceReference) Computes the content type of the resource.
protected abstract String	getResourceName(R resourceReference)
protected abstract InputStream	getResourceStream(R resourceReference)
void	handle(org.xwiki.resource.ResourceReference resourceReference, org.xwiki.resource.ResourceReferenceHandlerChain chain)
protected boolean	isResourceAccessible(R resourceReference)
protected boolean	isResourceCacheable(R resourceReference)

Methods inherited from class org.xwiki.resource.AbstractResourceReferenceHandler

compareTo, getPriority, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.resource.ResourceReferenceHandler

getSupportedResourceReferences

Constructor Detail

AbstractServletResourceReferenceHandler

public AbstractServletResourceReferenceHandler()

Method Detail

handle

public void handle(org.xwiki.resource.ResourceReference resourceReference,
                   org.xwiki.resource.ResourceReferenceHandlerChain chain)
            throws org.xwiki.resource.ResourceReferenceHandlerException

Throws:

org.xwiki.resource.ResourceReferenceHandlerException

isResourceAccessible

protected boolean isResourceAccessible(R resourceReference)

Parameters:

resourceReference - the reference of the requested resource

Returns:

true if the specified resource is accessible, false otherwise

isResourceCacheable

protected boolean isResourceCacheable(R resourceReference)

Parameters:

resourceReference - a resource reference

Returns:

true if the specified resource can be cached, false otherwise

getResourceStream

protected abstract InputStream getResourceStream(R resourceReference)

Parameters:

resourceReference - the reference of the requested resource

Returns:

the stream that can be used to read the resource

getResourceName

protected abstract String getResourceName(R resourceReference)

Parameters:

resourceReference - the reference of the requested resource

Returns:

the name of the specified resource

getContentType

@Unstable
protected String getContentType(InputStream resourceStream,
                                          R resourceReference)
                                   throws IOException

Computes the content type of the resource. By default the content type is inferred by TikaUtils.detect(InputStream, String) based on the resource content and name.

Parameters:

resourceStream - the stream of the requested resource

resourceReference - the reference of the request resource

Returns:

the content type of the resource

Throws:

IOException - in case of error during the content type analysis

Since:

13.3RC1

filterResource

protected InputStream filterResource(R resourceReference,
                                     InputStream resourceStream)
                              throws org.xwiki.resource.ResourceReferenceHandlerException

Filter the resource before sending it to the client.

Parameters:

resourceReference - the resource to filter

resourceStream - the resource content

Returns:

the filtered resource content

Throws:

org.xwiki.resource.ResourceReferenceHandlerException