java.lang.Object
- net.officefloor.server.http.AbstractHttpServerImplementationTestCase

Direct Known Subclasses:

AbstractServletHttpServerImplementationTest
```
@ExtendWith(TestSupportExtension.class)
public abstract class AbstractHttpServerImplementationTestCase
extends java.lang.Object
```
Abstract TestCase for testing a HttpServerImplementation.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractHttpServerImplementationTestCase.AsyncServicer`
`static class`	`AbstractHttpServerImplementationTestCase.BufferServicer`
`static class`	`AbstractHttpServerImplementationTestCase.BytesServicer`
`static class`	`AbstractHttpServerImplementationTestCase.CancelConnectionManagedObjectSource`
`static class`	`AbstractHttpServerImplementationTestCase.CancelConnectionServicer`
`static class`	`AbstractHttpServerImplementationTestCase.CloseFileServicer`
`protected static class`	`AbstractHttpServerImplementationTestCase.CompareResult`	Compares results of `OfficeFloor` servicing against Raw servicing.
`static class`	`AbstractHttpServerImplementationTestCase.EncodedUrlServicer`
`static class`	`AbstractHttpServerImplementationTestCase.FailServicer`
`static class`	`AbstractHttpServerImplementationTestCase.FileServicer`
`static class`	`AbstractHttpServerImplementationTestCase.FunctionalityServicer`
`protected static class`	`AbstractHttpServerImplementationTestCase.PipelineResult`	Result of a pipeline execution.
`static class`	`AbstractHttpServerImplementationTestCase.PressureOverloadServicer`	Servicer that is slow causing significant back pressure.
`static class`	`AbstractHttpServerImplementationTestCase.Servicer`
`static class`	`AbstractHttpServerImplementationTestCase.TeamMarker`	Marker `ManagedObject` for identifying `Team`.
`static class`	`AbstractHttpServerImplementationTestCase.TeamTwoMarker`	Marker `ManagedObject` for identifying `Team`.
`static class`	`AbstractHttpServerImplementationTestCase.ThreadedManagedObject`
`static class`	`AbstractHttpServerImplementationTestCase.ThreadedServicer`

Constructor Summary

Constructors
Constructor Description

AbstractHttpServerImplementationTestCase()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`async()`	Ensure able to service asynchronous servicing.
`void`	`bufferHeavyLoad()`	Ensure can service multiple requests pipelined.
`void`	`bufferOverLoad()`	Ensure can service overload requests pipelined.
`void`	`bufferPipelineVerify()`	Verify pipeline HTTP requests.
`void`	`bufferPipelining()`	Ensure can pipeline HTTP requests.
`void`	`bufferThreadedHandler()`	Ensure can handle HTTP requests with threaded handler.
`void`	`bytesHeavyLoad()`	Ensure can service multiple requests pipelined.
`void`	`bytesOverLoad()`	Ensure can service overload requests pipelined.
`void`	`bytesPipelineVerify()`	Verify pipeline HTTP requests.
`void`	`bytesPipelining()`	Ensure can pipeline HTTP requests.
`void`	`bytesThreadedHandler()`	Ensure can handle HTTP requests with threaded handler.
`void`	`cancelConnection()`	Ensure `ProcessState` instances for connection are cancelled on loss of connection.
`void`	`doMultiClientLoadTest(java.lang.Class<?> servicerClass, int clientCount, int requestCount, java.lang.String resultName)`	Undertakes the multi-client pipelining test.
`void`	`doPipelineVerifyTest(java.lang.Class<?> servicerClass)`	Undertakes verifying the pipeline tests.
`void`	`fileHeavyLoad()`	Ensure can service multiple requests pipelined.
`void`	`fileOverLoad()`	Ensure can service overload requests pipelined.
`void`	`filePipelineVerify()`	Verify pipeline HTTP requests.
`void`	`filePipelining()`	Ensure can pipeline HTTP requests.
`void`	`fileThreadedHandler()`	Ensure can handle HTTP requests with threaded handler.
`void`	`functionality()`	Ensure able to send all details and receive all details.
`protected abstract java.lang.Class<? extends HttpServerImplementation>`	`getHttpServerImplementationClass()`	Obtains the expected `HttpServerImplementation` `Class` being tested.
`protected int`	`getRequestCount()`	Obtains the request count.
`protected java.lang.String`	`getServerName()`	Obtains the server name.
`protected abstract java.lang.String`	`getServerNameSuffix()`	Obtains the `Server` `HttpHeaderValue` suffix.
`protected abstract HttpHeader[]`	`getServerResponseHeaderValues()`	Obtains the server response `HttpHeader` instances in the order they are sent from the server.
`void`	`handleError()`	Ensure can handle `Escalation`.
`protected boolean`	`isHandleCancel()`	Indicates if handle cancel.
`void`	`multipleIndividualRequests()`	Ensure can send multiple HTTP requests.
`void`	`multipleIndividualSecureRequests()`	Ensure can send multiple HTTPS requests.
`protected static HttpHeader`	`newHttpHeader(java.lang.String name, java.lang.String value)`	Creates a new `HttpHeader`.
`void`	`notDecodeRequestUrl()`	Ensure does not decode characters (allows for routing to work correctly and not find query string / fragment incorrectly).
`void`	`rawHeavyLoad()`	Ensure can service multiple requests pipelined.
`void`	`rawOverLoad()`	Ensure can service over requests pipelined.
`void`	`rawPipelineVerify()`	Verify pipeline HTTP requests.
`void`	`rawPipelining()`	Ensure can pipeline HTTP requests.
`void`	`rawSingleRequest()`	Ensure can handle raw single HTTP request.
`void`	`rawThreadedHandler()`	Ensure can handle HTTP requests with threaded handler.
`void`	`secureCancelConnection()`	Ensure `ProcessState` instances for connection are cancelled on loss of secure connection.
`void`	`secureSingleThreadedHandlerRequest()`	Ensure can handle request with `AbstractHttpServerImplementationTestCase.ThreadedServicer` for a secure connection.
`void`	`secureSocket()`	Ensure raw secure request.
`void`	`serverDateHeaders()`	Ensure send Server and Date `HttpHeader` values.
`void`	`setUp(org.junit.jupiter.api.TestInfo testInfo)`
`void`	`singleBufferRequest()`	Ensure can send a single HTTP `ByteBuffer` response.
`void`	`singleCloseFileRequest()`	Ensure closes the `FileChannel` on write.
`void`	`singleFileRequest()`	Ensure can send a single HTTP `StreamBuffer.FileBuffer` response.
`void`	`singleRequest()`	Ensure can send a single HTTP request.
`void`	`singleSecureBufferRequest()`	Ensure can send a single HTTPS `ByteBuffer` response.
`void`	`singleSecureCloseFileRequest()`	Ensure closes the `FileChannel` on write.
`void`	`singleSecureFileRequest()`	Ensure can send a single HTTPS `StreamBuffer.FileBuffer` response.
`void`	`singleSecureRequest()`	Ensure can send a single HTTPS request.
`void`	`singleThreadedHandlerRequest()`	Ensure can handle request with `AbstractHttpServerImplementationTestCase.ThreadedServicer`.
`void`	`socket()`	Ensure raw request.
`protected void`	`startHttpServer(java.lang.Class<?> sectionServicer)`	Starts the `HttpServer`.
`protected void`	`startHttpServer(java.lang.Class<?> sectionServicer, OfficeFloorExtensionService extension)`	Starts the `HttpServer`.
`protected java.lang.AutoCloseable`	`startHttpServer(OfficeFloorExtensionService officeFloorExtension, OfficeExtensionService officeExtension)`	Starts the `HttpServer`.
`protected abstract java.lang.AutoCloseable`	`startRawHttpServer(HttpServerLocation serverLocation)`	Starts a raw implementation of the underlying HTTP server.
`void`	`teamPressureOverload()`	Ensure can handle pressure overloading the server.
`void`	`tearDown()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractHttpServerImplementationTestCase
```
public AbstractHttpServerImplementationTestCase()
```
- Method Detail
  - getRequestCount
```
protected int getRequestCount()
```
    Obtains the request count.
    Allows changing the number for server implementations that have higher overheads.
    
    Returns:
    
    Request count.
  - newHttpHeader
```
protected static HttpHeader newHttpHeader(java.lang.String name,
                                          java.lang.String value)
```
    Creates a new HttpHeader.
    
    Parameters:
    
    name - HttpHeader name.
    
    value - HttpHeader value.
    
    Returns:
    
    New HttpHeader.
  - getHttpServerImplementationClass
```
protected abstract java.lang.Class<? extends HttpServerImplementation> getHttpServerImplementationClass()
```
    Obtains the expected HttpServerImplementation Class being tested.
    
    Returns:
    
    Expected HttpServerImplementation Class.
  - startRawHttpServer
```
protected abstract java.lang.AutoCloseable startRawHttpServer(HttpServerLocation serverLocation)
                                                       throws java.lang.Exception
```
    Starts a raw implementation of the underlying HTTP server. This allows performance comparisons of adding in OfficeFloor servicing overheads.
    The raw implementation is to return "hello world" in UTF-8 encoding for the response entity.
    
    Parameters:
    
    serverLocation - HttpServerLocation.
    
    Returns:
    
    AutoCloseable To stop the server.
    
    Throws:
    
    java.lang.Exception - If fails to start the raw HTTP server.
  - getServerResponseHeaderValues
```
protected abstract HttpHeader[] getServerResponseHeaderValues()
```
    Obtains the server response HttpHeader instances in the order they are sent from the server.
    
    Returns:
    
    Server response HttpHeader instances in the order they are sent from the server.
  - getServerNameSuffix
```
protected abstract java.lang.String getServerNameSuffix()
```
    Obtains the Server HttpHeaderValue suffix.
    
    Returns:
    
    Server HttpHeaderValue suffix. May be null if no suffix.
  - setUp
```
@BeforeEach
public void setUp(org.junit.jupiter.api.TestInfo testInfo)
           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - tearDown
```
@AfterEach
public void tearDown()
              throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - startHttpServer
```
protected void startHttpServer(java.lang.Class<?> sectionServicer)
                        throws java.lang.Exception
```
    Starts the HttpServer.
    
    Parameters:
    
    sectionServicer - Class of the ClassSectionSource to service the HttpRequest.
    
    Throws:
    
    java.lang.Exception - If fails to start the HttpServer.
  - startHttpServer
```
protected void startHttpServer(java.lang.Class<?> sectionServicer,
                               OfficeFloorExtensionService extension)
                        throws java.lang.Exception
```
    Starts the HttpServer.
    
    Parameters:
    
    sectionServicer - Class of the ClassSectionSource to service the HttpRequest.
    
    extension - Additional OfficeFloorExtensionService. May be null.
    
    Throws:
    
    java.lang.Exception - If fails to start the HttpServer.
  - startHttpServer
```
protected java.lang.AutoCloseable startHttpServer(OfficeFloorExtensionService officeFloorExtension,
                                                  OfficeExtensionService officeExtension)
                                           throws java.lang.Exception
```
    Starts the HttpServer.
    
    Parameters:
    
    officeFloorExtension - OfficeFloorExtensionService to configure the OfficeFloor.
    
    officeExtension - OfficeExtensionService to configure the OfficeFloor.
    
    Returns:
    
    AutoCloseable to stop the server.
    
    Throws:
    
    java.lang.Exception - If fails to start the HttpServer.
  - async
```
@Test
public void async()
           throws java.lang.Exception
```
    Ensure able to service asynchronous servicing.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - functionality
```
@Test
public void functionality()
                   throws java.lang.Exception
```
    Ensure able to send all details and receive all details.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - rawSingleRequest
```
@Test
public void rawSingleRequest()
                      throws java.lang.Exception
```
    Ensure can handle raw single HTTP request.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleRequest
```
@Test
public void singleRequest()
                   throws java.lang.Exception
```
    Ensure can send a single HTTP request.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleSecureRequest
```
@Test
public void singleSecureRequest()
                         throws java.lang.Exception
```
    Ensure can send a single HTTPS request.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleBufferRequest
```
@Test
public void singleBufferRequest()
                         throws java.lang.Exception
```
    Ensure can send a single HTTP ByteBuffer response.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleSecureBufferRequest
```
@Test
public void singleSecureBufferRequest()
                               throws java.lang.Exception
```
    Ensure can send a single HTTPS ByteBuffer response.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleFileRequest
```
@Test
public void singleFileRequest()
                       throws java.lang.Exception
```
    Ensure can send a single HTTP StreamBuffer.FileBuffer response.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleSecureFileRequest
```
@Test
public void singleSecureFileRequest()
                             throws java.lang.Exception
```
    Ensure can send a single HTTPS StreamBuffer.FileBuffer response.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - serverDateHeaders
```
@Test
public void serverDateHeaders()
                       throws java.lang.Exception
```
    Ensure send Server and Date HttpHeader values.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - getServerName
```
protected java.lang.String getServerName()
```
    Obtains the server name.
    
    Returns:
    
    Server name.
  - singleCloseFileRequest
```
@Test
public void singleCloseFileRequest()
                            throws java.lang.Exception
```
    Ensure closes the FileChannel on write.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleSecureCloseFileRequest
```
@Test
public void singleSecureCloseFileRequest()
                                  throws java.lang.Exception
```
    Ensure closes the FileChannel on write.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - multipleIndividualRequests
```
public void multipleIndividualRequests()
                                throws java.lang.Exception
```
    Ensure can send multiple HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - multipleIndividualSecureRequests
```
public void multipleIndividualSecureRequests()
                                      throws java.lang.Exception
```
    Ensure can send multiple HTTPS requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - notDecodeRequestUrl
```
@Test
public void notDecodeRequestUrl()
                         throws java.lang.Exception
```
    Ensure does not decode characters (allows for routing to work correctly and not find query string / fragment incorrectly).
    
    Throws:
    
    java.lang.Exception - If test failure.
  - singleThreadedHandlerRequest
```
@Test
public void singleThreadedHandlerRequest()
                                  throws java.lang.Exception
```
    Ensure can handle request with AbstractHttpServerImplementationTestCase.ThreadedServicer.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - secureSingleThreadedHandlerRequest
```
@Test
public void secureSingleThreadedHandlerRequest()
                                        throws java.lang.Exception
```
    Ensure can handle request with AbstractHttpServerImplementationTestCase.ThreadedServicer for a secure connection.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - socket
```
@Test
public void socket()
            throws java.lang.Exception
```
    Ensure raw request.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - secureSocket
```
@Test
public void secureSocket()
                  throws java.lang.Exception
```
    Ensure raw secure request.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - handleError
```
@Test
public void handleError()
                 throws java.lang.Exception
```
    Ensure can handle Escalation.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - teamPressureOverload
```
@Test
public void teamPressureOverload()
                          throws java.lang.Exception
```
    Ensure can handle pressure overloading the server.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - cancelConnection
```
@Test
public void cancelConnection()
                      throws java.lang.Exception
```
    Ensure ProcessState instances for connection are cancelled on loss of connection.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - secureCancelConnection
```
@Test
public void secureCancelConnection()
                            throws java.lang.Exception
```
    Ensure ProcessState instances for connection are cancelled on loss of secure connection.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - isHandleCancel
```
protected boolean isHandleCancel()
```
    Indicates if handle cancel.
    
    Returns:
    
    true if handle cancel.
  - rawPipelineVerify
```
@Test
public void rawPipelineVerify()
                       throws java.lang.Exception
```
    Verify pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bytesPipelineVerify
```
@Test
public void bytesPipelineVerify()
                         throws java.lang.Exception
```
    Verify pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bufferPipelineVerify
```
@Test
public void bufferPipelineVerify()
                          throws java.lang.Exception
```
    Verify pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - filePipelineVerify
```
@Test
public void filePipelineVerify()
                        throws java.lang.Exception
```
    Verify pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - doPipelineVerifyTest
```
public void doPipelineVerifyTest(java.lang.Class<?> servicerClass)
                          throws java.lang.Exception
```
    Undertakes verifying the pipeline tests.
    
    Parameters:
    
    servicerClass - Servicer Class.
    
    Throws:
    
    java.lang.Exception - If fails test.
  - rawPipelining
```
public void rawPipelining()
                   throws java.lang.Exception
```
    Ensure can pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bytesPipelining
```
public void bytesPipelining()
                     throws java.lang.Exception
```
    Ensure can pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bufferPipelining
```
public void bufferPipelining()
                      throws java.lang.Exception
```
    Ensure can pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - filePipelining
```
public void filePipelining()
                    throws java.lang.Exception
```
    Ensure can pipeline HTTP requests.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - rawThreadedHandler
```
public void rawThreadedHandler()
                        throws java.lang.Exception
```
    Ensure can handle HTTP requests with threaded handler.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bytesThreadedHandler
```
public void bytesThreadedHandler()
                          throws java.lang.Exception
```
    Ensure can handle HTTP requests with threaded handler.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bufferThreadedHandler
```
public void bufferThreadedHandler()
                           throws java.lang.Exception
```
    Ensure can handle HTTP requests with threaded handler.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - fileThreadedHandler
```
public void fileThreadedHandler()
                         throws java.lang.Exception
```
    Ensure can handle HTTP requests with threaded handler.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - rawHeavyLoad
```
public void rawHeavyLoad()
                  throws java.lang.Exception
```
    Ensure can service multiple requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bytesHeavyLoad
```
public void bytesHeavyLoad()
                    throws java.lang.Exception
```
    Ensure can service multiple requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bufferHeavyLoad
```
public void bufferHeavyLoad()
                     throws java.lang.Exception
```
    Ensure can service multiple requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - fileHeavyLoad
```
public void fileHeavyLoad()
                   throws java.lang.Exception
```
    Ensure can service multiple requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - rawOverLoad
```
public void rawOverLoad()
                 throws java.lang.Exception
```
    Ensure can service over requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bytesOverLoad
```
public void bytesOverLoad()
                   throws java.lang.Exception
```
    Ensure can service overload requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - bufferOverLoad
```
public void bufferOverLoad()
                    throws java.lang.Exception
```
    Ensure can service overload requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - fileOverLoad
```
public void fileOverLoad()
                  throws java.lang.Exception
```
    Ensure can service overload requests pipelined.
    
    Throws:
    
    java.lang.Exception - If test failure.
  - doMultiClientLoadTest
```
public void doMultiClientLoadTest(java.lang.Class<?> servicerClass,
                                  int clientCount,
                                  int requestCount,
                                  java.lang.String resultName)
                           throws java.lang.Exception
```
    Undertakes the multi-client pipelining test.
    
    Parameters:
    
    servicerClass - Servicer Class.
    
    clientCount - Number of simultaneous clients.
    
    requestCount - Number of requests per client.
    
    resultName - Name of result for comparison.
    
    Throws:
    
    java.lang.Exception - If test failure.

Class AbstractHttpServerImplementationTestCase

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractHttpServerImplementationTestCase

Method Detail

getRequestCount

newHttpHeader

getHttpServerImplementationClass

startRawHttpServer

getServerResponseHeaderValues

getServerNameSuffix

setUp

tearDown

startHttpServer

startHttpServer

startHttpServer

async

functionality

rawSingleRequest

singleRequest

singleSecureRequest

singleBufferRequest

singleSecureBufferRequest

singleFileRequest

singleSecureFileRequest

serverDateHeaders

getServerName

singleCloseFileRequest

singleSecureCloseFileRequest

multipleIndividualRequests

multipleIndividualSecureRequests

notDecodeRequestUrl

singleThreadedHandlerRequest

secureSingleThreadedHandlerRequest

socket

secureSocket

handleError

teamPressureOverload

cancelConnection

secureCancelConnection

isHandleCancel

rawPipelineVerify

bytesPipelineVerify

bufferPipelineVerify

filePipelineVerify

doPipelineVerifyTest

rawPipelining

bytesPipelining

bufferPipelining

filePipelining

rawThreadedHandler

bytesThreadedHandler

bufferThreadedHandler

fileThreadedHandler

rawHeavyLoad

bytesHeavyLoad

bufferHeavyLoad

fileHeavyLoad

rawOverLoad

bytesOverLoad

bufferOverLoad

fileOverLoad

doMultiClientLoadTest