Package org.apache.cxf.jaxrs.provider

Class AbstractResponseViewProvider

java.lang.Object

org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

org.apache.cxf.jaxrs.provider.AbstractResponseViewProvider

All Implemented Interfaces:

jakarta.ws.rs.ext.MessageBodyWriter<Object>

Direct Known Subclasses:

RequestDispatcherProvider, SpringViewResolverProvider

@Produces("text/html")
@Provider
public abstract class AbstractResponseViewProvider
extends AbstractConfigurableProvider
implements jakarta.ws.rs.ext.MessageBodyWriter<Object>

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

BUNDLE, LOG

Constructor Summary

Constructors

Constructor	Description
AbstractResponseViewProvider()

Method Summary

Modifier and Type	Method	Description
protected boolean	classResourceSupported(Class<?> type)
protected String	doGetClassResourceName(Class<?> type)
protected String	getBeanName(Object bean)
protected String	getClassResourceName(Class<?> type)
protected String	getDefaultLocationPrefix()
protected String	getDefaultResourceExtension()
MessageContext	getMessageContext()
protected String	getPathFromMessageContext()
protected String	getRequestPath()
protected String	getResourcePath(Class<?> cls, Object o)
long	getSize(Object t, Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mt)
protected void	handleInternalViewRenderingException(Throwable exception)
protected void	handleViewRenderingException(String viewName, Throwable exception)	By default we'll try to forward to the error handler.
boolean	isLogRedirects()
boolean	isUseClassNames()
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mt)
protected abstract boolean	resourceAvailable(String resourceName)
void	setBeanName(String beanName)
void	setBeanNames(Map<String,String> beanNames)
void	setClassResources(Map<String,String> resources)
void	setEnumResources(Map<? extends Enum<?>,String> enumResources)
void	setErrorView(String errorView)
void	setLocationPrefix(String locationPrefix)
void	setLogRedirects(boolean logRedirects)
void	setMessageContext(MessageContext context)
void	setResourceExtension(String resourceExtension)
void	setResourcePath(String resourcePath)
void	setResourcePaths(Map<String,String> resourcePaths)
void	setStrictPathCheck(boolean use)
void	setUseClassNames(boolean use)

Methods inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

getBus, getConsumeMediaTypes, getEnableBuffering, getEnableStreaming, getProduceMediaTypes, init, isPayloadEmpty, isPayloadEmpty, reportEmptyContentLength, setBus, setConsumeMediaTypes, setEnableBuffering, setEnableStreaming, setProduceMediaTypes

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.ext.MessageBodyWriter

writeTo

Constructor Details

AbstractResponseViewProvider

public AbstractResponseViewProvider()

Method Details

setMessageContext

@Context
public void setMessageContext(MessageContext context)

getMessageContext

public MessageContext getMessageContext()

setUseClassNames

public void setUseClassNames(boolean use)

isUseClassNames

public boolean isUseClassNames()

setStrictPathCheck

public void setStrictPathCheck(boolean use)

setBeanNames

public void setBeanNames(Map<String,String> beanNames)

setBeanName

public void setBeanName(String beanName)

setResourcePath

public void setResourcePath(String resourcePath)

setResourcePaths

public void setResourcePaths(Map<String,String> resourcePaths)

getSize

public long getSize(Object t,
 Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mt)

Specified by:

getSize in interface jakarta.ws.rs.ext.MessageBodyWriter<Object>

setClassResources

public void setClassResources(Map<String,String> resources)

setEnumResources

public void setEnumResources(Map<? extends Enum<?>,String> enumResources)

setLocationPrefix

public void setLocationPrefix(String locationPrefix)

setResourceExtension

public void setResourceExtension(String resourceExtension)

setErrorView

public void setErrorView(String errorView)

isWriteable

public boolean isWriteable(Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mt)

Specified by:

isWriteable in interface jakarta.ws.rs.ext.MessageBodyWriter<Object>

classResourceSupported

protected boolean classResourceSupported(Class<?> type)

getPathFromMessageContext

protected String getPathFromMessageContext()

getBeanName

protected String getBeanName(Object bean)

getResourcePath

protected String getResourcePath(Class<?> cls,
 Object o)

getRequestPath

protected String getRequestPath()

getClassResourceName

protected String getClassResourceName(Class<?> type)

doGetClassResourceName

protected String doGetClassResourceName(Class<?> type)

handleViewRenderingException

protected void handleViewRenderingException(String viewName,
 Throwable exception)

By default we'll try to forward to the error handler. If no such handler has been set, or if there is an error during error handling, we throw an error and let CXF handle the internal error.

Parameters:

viewName - name of the view that produced the rendering error

exception - rendering error

handleInternalViewRenderingException

protected void handleInternalViewRenderingException(Throwable exception)

getDefaultLocationPrefix

protected String getDefaultLocationPrefix()

getDefaultResourceExtension

protected String getDefaultResourceExtension()

resourceAvailable

protected abstract boolean resourceAvailable(String resourceName)

isLogRedirects

public boolean isLogRedirects()

setLogRedirects

public void setLogRedirects(boolean logRedirects)