HttpServerPort 3.1.0 API

All Implemented Interfaces:


public interface HttpServerPort

Server instance of one kind.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Integer`	`runtimePort()`	Get the runtime port if started, throw an exception otherwise.
`abstract Boolean`	`started()`	Check whether the server has been started or not.
`abstract Unit`	`startUp(HttpServer server)`	Build a server of a certain engine from a server definition and runs it.
`abstract Unit`	`shutDown()`	Stop the instance of the engine.
`abstract Set<HttpProtocol>`	`supportedProtocols()`	Return the server adapter's supported protocols.
`abstract Set<HttpServerFeature>`	`supportedFeatures()`	Return the server adapter's supported features.
`abstract Map<String, ?>`	`options()`	Return the adapter's allowed configuration options with its values.

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

- Constructor Detail
- Method Detail
  - runtimePort
```
 abstract Integer runtimePort()
```
    Get the runtime port if started, throw an exception otherwise.
    
    Returns:
    
    Runtime port if started or an exception otherwise.
  - started
```
 abstract Boolean started()
```
    Check whether the server has been started or not.
    
    Returns:
    
    True if the server has started, else false.
  - startUp
```
 abstract Unit startUp(HttpServer server)
```
    Build a server of a certain engine from a server definition and runs it.
    
    Parameters:
    
    server - The server instance to be run by this adapter.
  - shutDown
```
 abstract Unit shutDown()
```
    Stop the instance of the engine.
  - supportedProtocols
```
 abstract Set<HttpProtocol> supportedProtocols()
```
    Return the server adapter's supported protocols.
    
    Returns:
    
    Set of supported protocols.
  - supportedFeatures
```
 abstract Set<HttpServerFeature> supportedFeatures()
```
    Return the server adapter's supported features.
    
    Returns:
    
    Set of supported features.
  - options
```
 abstract Map<String, ?> options()
```
    Return the adapter's allowed configuration options with its values.
    
    Returns:
    
    Map of supported options with their values for this instance.