Package net.officefloor.spring.starter.rest

Class SpringServerHttpConnection

java.lang.Object

net.officefloor.server.http.impl.ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>

net.officefloor.spring.starter.rest.SpringServerHttpConnection

All Implemented Interfaces:

FlowCallback, ContextAwareManagedObject, InputManagedObject, ManagedObject, ServerHttpConnection

public class SpringServerHttpConnection
extends ProcessAwareServerHttpConnectionManagedObject<ByteBuffer>

ProcessAwareServerHttpConnectionManagedObject for Spring MVC.

Field Summary

Fields inherited from interface net.officefloor.frame.api.function.FlowCallback

ESCALATE

Fields inherited from interface net.officefloor.server.http.ServerHttpConnection

DEFAULT_HTTP_ENTITY_CHARSET, HTTP_CHARSET, URI_CHARSET

Constructor Summary

Constructors

Constructor

Description

SpringServerHttpConnection(HttpServerLocation serverLocation, boolean isSecure, Supplier<HttpMethod> methodSupplier, Supplier<String> requestUriSupplier, HttpVersion version, NonMaterialisedHttpHeaders requestHeaders, ByteSequence requestEntity, HttpHeaderValue serverName, DateHttpHeaderClock dateHttpHeaderClock, boolean isIncludeStackTraceOnEscalation, HttpResponseWriter<ByteBuffer> writer, StreamBufferPool<ByteBuffer> bufferPool, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter handlerAdapter, org.springframework.web.servlet.DispatcherServlet dispatcherServlet, org.springframework.context.ApplicationContext applicationContext, List<SpringExceptionHandler> exceptionHandlers)

Instantiate.

Method Summary

Modifier and Type	Method	Description
void	flagManuallyHandle()	Flags manually handling HttpServletResponse.
org.springframework.context.ApplicationContext	getApplicationContext()	Obtains the ApplicationContext.
org.springframework.web.servlet.DispatcherServlet	getDispatcherServlet()	Obtains the DispatcherServlet.
jakarta.servlet.http.HttpServletRequest	getHttpServletRequest()	Obtains the HttpServletRequest.
jakarta.servlet.http.HttpServletResponse	getHttpServletResponse()	Obtains the HttpServletResponse.
ModelAndViewBridge	getModelAndViewBridge(Method method)	Obtains the ModelAndViewBridge for the Method.
org.springframework.web.method.support.ModelAndViewContainer	getModelAndViewContainer()	Obtains the ModelAndViewContainer.
org.springframework.web.context.request.NativeWebRequest	getNativeWebRequest()	Obtains the NativeWebRequest.
ModelAndViewBridge	getRenderModelAndViewBridge()	Obtains the ModelAndViewBridge to render result.
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter	getRequestMappingHandlerAdapter()	Obtains the RequestMappingHandlerAdapter.
Object	getSpringHandler()	Obtains the Spring handler.
static void	methodParameter(ObjectResponse<Object> response)	Method to use if no MethodParameterAnnotation.
void	setResponse(Object responseObject, ManagedFunctionObjectType<?> managedFunctionObjectType, String responseView, Throwable responseFailure)	Specifies the response.
void	writeResponse()	Write the response.

Methods inherited from class net.officefloor.server.http.impl.ProcessAwareServerHttpConnectionManagedObject

clean, exportState, getClientRequest, getObject, getRequest, getResponse, getServerLocation, getServiceFlowCallback, importState, isSecure, run, setManagedObjectContext

Methods inherited from class java.lang.Object

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

Constructor Details

SpringServerHttpConnection

public SpringServerHttpConnection(HttpServerLocation serverLocation,
 boolean isSecure,
 Supplier<HttpMethod> methodSupplier,
 Supplier<String> requestUriSupplier,
 HttpVersion version,
 NonMaterialisedHttpHeaders requestHeaders,
 ByteSequence requestEntity,
 HttpHeaderValue serverName,
 DateHttpHeaderClock dateHttpHeaderClock,
 boolean isIncludeStackTraceOnEscalation,
 HttpResponseWriter<ByteBuffer> writer,
 StreamBufferPool<ByteBuffer> bufferPool,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter handlerAdapter,
 org.springframework.web.servlet.DispatcherServlet dispatcherServlet,
 org.springframework.context.ApplicationContext applicationContext,
 List<SpringExceptionHandler> exceptionHandlers)

Instantiate.

Parameters:

serverLocation - HttpServerLocation.

isSecure - Indicates if secure.

methodSupplier - Supplier for the HttpRequest HttpMethod.

requestUriSupplier - Supplier for the HttpRequest URI.

version - HttpVersion for the HttpRequest.

requestHeaders - NonMaterialisedHttpHeaders for the HttpRequest.

requestEntity - ByteSequence for the HttpRequest entity.

serverName - Name of the server. May be null if not sending Server HttpHeader.

dateHttpHeaderClock - DateHttpHeaderClock. May be null to not send Date HttpHeader.

isIncludeStackTraceOnEscalation - true to include the Escalation stack trace in the HttpResponse.

writer - HttpResponseWriter.

bufferPool - StreamBufferPool.

request - HttpServletRequest.

response - HttpServletResponse.

handler - Handler object.

handlerAdapter - RequestMappingHandlerAdapter.

dispatcherServlet - DispatcherServlet.

applicationContext - ApplicationContext.

exceptionHandlers - SpringExceptionHandler instances.

Method Details

methodParameter

public static void methodParameter(ObjectResponse<Object> response)

Method to use if no MethodParameterAnnotation.

Parameters:

response - ObjectResponse.

setResponse

public void setResponse(Object responseObject,
 ManagedFunctionObjectType<?> managedFunctionObjectType,
 String responseView,
 Throwable responseFailure)

Specifies the response.

Parameters:

responseObject - Response object.

managedFunctionObjectType - ManagedFunctionObjectType.

responseView - Response view.

responseFailure - Response Throwable.

flagManuallyHandle

public void flagManuallyHandle()

Flags manually handling HttpServletResponse.

getHttpServletRequest

public jakarta.servlet.http.HttpServletRequest getHttpServletRequest()

Obtains the HttpServletRequest.

Returns:

HttpServletRequest.

getHttpServletResponse

public jakarta.servlet.http.HttpServletResponse getHttpServletResponse()

Obtains the HttpServletResponse.

Returns:

HttpServletResponse.

getSpringHandler

public Object getSpringHandler()

Obtains the Spring handler.

Returns:

Spring handler.

getRequestMappingHandlerAdapter

public org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter getRequestMappingHandlerAdapter()

Obtains the RequestMappingHandlerAdapter.

Returns:

RequestMappingHandlerAdapter.

getDispatcherServlet

public org.springframework.web.servlet.DispatcherServlet getDispatcherServlet()

Obtains the DispatcherServlet.

Returns:

DispatcherServlet.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Obtains the ApplicationContext.

Returns:

ApplicationContext.

getModelAndViewContainer

public org.springframework.web.method.support.ModelAndViewContainer getModelAndViewContainer()

Obtains the ModelAndViewContainer.

Returns:

ModelAndViewContainer.

getNativeWebRequest

public org.springframework.web.context.request.NativeWebRequest getNativeWebRequest()

Obtains the NativeWebRequest.

Returns:

NativeWebRequest.

getModelAndViewBridge

public ModelAndViewBridge getModelAndViewBridge(Method method)
                                         throws Exception

Obtains the ModelAndViewBridge for the Method.

Parameters:

method - Method.

Returns:

ModelAndViewBridge for the Method.

Throws:

Exception - If fails to construct ModelAndViewBridge to the Method.

getRenderModelAndViewBridge

public ModelAndViewBridge getRenderModelAndViewBridge()
                                               throws Exception

Obtains the ModelAndViewBridge to render result.

Returns:

ModelAndViewBridge to render result.

Throws:

Exception - If fails to obtain.

writeResponse

public void writeResponse()
                   throws Throwable

Write the response.

Throws:

Throwable - If fails to write response.