Package org.apache.cxf.jaxrs.springmvc

Class SpringViewResolverProvider

java.lang.Object

org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

org.apache.cxf.jaxrs.provider.AbstractResponseViewProvider

org.apache.cxf.jaxrs.springmvc.SpringViewResolverProvider

All Implemented Interfaces:

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

public class SpringViewResolverProvider
extends AbstractResponseViewProvider

CXF view provider that delegates view rendering to Spring MVC Views. Sample usage in a spring application:

  @Bean
  public SpringViewResolverProvider springViewProvider(ViewResolver viewResolver) {
      SpringViewResolverProvider viewProvider = new SpringViewResolverProvider(viewResolver,
             new AcceptHeaderLocaleResolver());
      viewProvider.setUseClassNames(true);
      viewProvider.setBeanName("model");
      viewProvider.setResourcePaths(Collections.singletonMap("/remove", "registeredClients"));
      return viewProvider;
  }
 

Constructor Summary

Constructors

Constructor	Description
SpringViewResolverProvider(org.springframework.web.servlet.ViewResolver viewResolver, org.springframework.web.servlet.LocaleResolver localeResolver)

Method Summary

Modifier and Type	Method	Description
protected boolean	resourceAvailable(String resourceName)
void	writeTo(Object o, Class<?> clazz, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType type, jakarta.ws.rs.core.MultivaluedMap<String,Object> headers, OutputStream os)

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

classResourceSupported, doGetClassResourceName, getBeanName, getClassResourceName, getDefaultLocationPrefix, getDefaultResourceExtension, getMessageContext, getPathFromMessageContext, getRequestPath, getResourcePath, getSize, handleInternalViewRenderingException, handleViewRenderingException, isLogRedirects, isUseClassNames, isWriteable, setBeanName, setBeanNames, setClassResources, setEnumResources, setErrorView, setLocationPrefix, setLogRedirects, setMessageContext, setResourceExtension, setResourcePath, setResourcePaths, setStrictPathCheck, setUseClassNames

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

Constructor Details

SpringViewResolverProvider

public SpringViewResolverProvider(org.springframework.web.servlet.ViewResolver viewResolver,
 org.springframework.web.servlet.LocaleResolver localeResolver)

Method Details

writeTo

public void writeTo(Object o,
 Class<?> clazz,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType type,
 jakarta.ws.rs.core.MultivaluedMap<String,Object> headers,
 OutputStream os)
             throws IOException

Throws:

IOException

resourceAvailable

protected boolean resourceAvailable(String resourceName)

Specified by:

resourceAvailable in class AbstractResponseViewProvider