com.vmware.vapi.protocol.server.rpc.http.impl

Class HttpStreamingServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.vmware.vapi.internal.protocol.server.TraceDecoratedServlet

com.vmware.vapi.protocol.server.rpc.http.impl.HttpStreamingServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class HttpStreamingServlet
extends com.vmware.vapi.internal.protocol.server.TraceDecoratedServlet

Servlet which enables its RequestReceiver handlers to send multiple response frames for a single request. It relies on the async features introduced in Servlet 3.0.

If there is a single response frame for a given request, the HTTP response will contain a normal Content-Type derived from the payload, e.g. HttpConstants.CONTENT_TYPE_JSON. If there are multiple response frames, the Content-Type would be prefixed with HttpConstants.CONTENT_TYPE_FRAMED.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vmware.vapi.internal.protocol.server.TraceDecoratedServlet

ATTR_TRACING_SPAN

Constructor Summary

Constructors

Constructor and Description
HttpStreamingServlet(MediaTypeResolver mediaTypeResolver) Calls HttpStreamingServlet(MediaTypeResolver, long) with timeout -1 (means no timeout).
HttpStreamingServlet(MediaTypeResolver mediaTypeResolver, long asyncTimeout) Calls HttpStreamingServlet(MediaTypeResolver, long, Tracer) with tracer Tracer.NO_OP meaning there is no tracing.
HttpStreamingServlet(MediaTypeResolver mediaTypeResolver, long asyncTimeout, Tracer tracer) Creates a servlet.
HttpStreamingServlet(MediaTypeResolver mediaTypeResolver, Tracer tracer)

Method Summary

Modifier and Type	Method and Description
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method to handle HTTP POST request.

Methods inherited from class com.vmware.vapi.internal.protocol.server.TraceDecoratedServlet

doService, getTracingSpan, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpStreamingServlet

public HttpStreamingServlet(MediaTypeResolver mediaTypeResolver)

Calls HttpStreamingServlet(MediaTypeResolver, long) with timeout -1 (means no timeout).

Parameters:

mediaTypeResolver - resolves a media type to a content handler

HttpStreamingServlet

public HttpStreamingServlet(MediaTypeResolver mediaTypeResolver,
                            Tracer tracer)

HttpStreamingServlet

public HttpStreamingServlet(MediaTypeResolver mediaTypeResolver,
                            long asyncTimeout)

Calls HttpStreamingServlet(MediaTypeResolver, long, Tracer) with tracer Tracer.NO_OP meaning there is no tracing.

Parameters:

mediaTypeResolver - resolves a media type to a content handler

asyncTimeout - time limit in milliseconds for handling a request; zero or less indicates no timeout; see AsyncContext.setTimeout(long)

HttpStreamingServlet

public HttpStreamingServlet(MediaTypeResolver mediaTypeResolver,
                            long asyncTimeout,
                            Tracer tracer)

Creates a servlet.

Parameters:

mediaTypeResolver - resolves a media type to a content handler

asyncTimeout - time limit in milliseconds for handling a request; zero or less indicates no timeout; see AsyncContext.setTimeout(long)

tracer - the tracer used by the vapi stack for distributed tracing

Method Detail

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   IOException

Method to handle HTTP POST request.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException