Package net.officefloor.server.http

Class HttpServer

java.lang.Object

net.officefloor.server.http.HttpServer

public class HttpServer
extends Object

HTTP Server.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_HTTP_SERVER_IMPLEMENTATION_CLASS_NAME	Class name of the default HttpServerImplementation.
static final String	PROPERTY_HTTP_DATE_HEADER	Name of Property specifying whether to send the Date HttpHeader.
static final String	PROPERTY_HTTP_SERVER_NAME	Name of Property specifying the name for the Server HttpHeader.
static final String	PROPERTY_INCLUDE_STACK_TRACE	Name of Property to include the stack trace.
static final String	PROPERTY_SSL_CONTEXT_SOURCE	Name of Property for the SslContextSource.
static final String	SSL_REVERSE_PROXIED	Value for PROPERTY_SSL_CONTEXT_SOURCE to indicate that this server is behind a reverse proxy.

Constructor Summary

Constructors

Constructor	Description
HttpServer(DeployedOfficeInput serviceInput, String typeQualifier, OfficeFloorDeployer officeFloorDeployer, OfficeFloorSourceContext context)	Instantiates the HttpServer from configuration.
HttpServer(DeployedOfficeInput serviceInput, OfficeFloorDeployer officeFloorDeployer, OfficeFloorSourceContext context)	Instantiates the HttpServer from configuration.
HttpServer(HttpServerImplementation implementation, String typeQualifier, HttpServerLocation serverLocation, String serverName, DateHttpHeaderClock dateHttpHeaderClock, boolean isIncludeEscalationStackTrace, SSLContext sslContext, DeployedOfficeInput serviceInput, OfficeFloorDeployer officeFloorDeployer, OfficeFloorSourceContext context)	Instantiates the HttpServer from direct configuration.

Method Summary

Modifier and Type	Method	Description
HttpServerImplementation	getHttpServerImplementation()	Obtains the HttpServerImplementation.
HttpServerLocation	getHttpServerLocation()	Obtains the HttpServerLocation.
static int	getPropertyInteger(String propertyName, SourceContext context, Supplier<Integer> defaultValue)	Obtains the Property value.
static String	getPropertyString(String propertyName, SourceContext context, Supplier<String> defaultValue)	Obtains the Property value.
static HttpHeaderValue	getServerHttpHeaderValue(HttpServerImplementationContext context, String suffix)	Convenience method to obtain the Server HttpHeaderValue.
SSLContext	getSslContext()	Obtains the SSLContext.
static SSLContext	getSslContext(SourceContext context)	Obtains the SSLContext from configuration.

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_HTTP_SERVER_NAME

public static final String PROPERTY_HTTP_SERVER_NAME

Name of Property specifying the name for the Server HttpHeader.

See Also:

• Constant Field Values

PROPERTY_HTTP_DATE_HEADER

public static final String PROPERTY_HTTP_DATE_HEADER

Name of Property specifying whether to send the Date HttpHeader. Value is true/false.

See Also:

• Constant Field Values

PROPERTY_INCLUDE_STACK_TRACE

public static final String PROPERTY_INCLUDE_STACK_TRACE

Name of Property to include the stack trace.

See Also:

• Constant Field Values

PROPERTY_SSL_CONTEXT_SOURCE

public static final String PROPERTY_SSL_CONTEXT_SOURCE

Name of Property for the SslContextSource.

See Also:

• Constant Field Values

SSL_REVERSE_PROXIED

public static final String SSL_REVERSE_PROXIED

Value for PROPERTY_SSL_CONTEXT_SOURCE to indicate that this server is behind a reverse proxy. This enables the reverse proxy to handle SSL and communicate with this server via insecure Socket (but stll appear as a secure ServerHttpConnection).

See Also:

• Constant Field Values

DEFAULT_HTTP_SERVER_IMPLEMENTATION_CLASS_NAME

public static String DEFAULT_HTTP_SERVER_IMPLEMENTATION_CLASS_NAME

Class name of the default HttpServerImplementation.

Constructor Details

HttpServer

public HttpServer(DeployedOfficeInput serviceInput,
 OfficeFloorDeployer officeFloorDeployer,
 OfficeFloorSourceContext context)
           throws Exception

Instantiates the HttpServer from configuration.

Parameters:

serviceInput - DeployedOfficeInput servicing the ServerHttpConnection.

officeFloorDeployer - OfficeFloorDeployer.

context - OfficeFloorSourceContext.

Throws:

Exception - If fails to create the HttpServer from configuration.

HttpServer

public HttpServer(DeployedOfficeInput serviceInput,
 String typeQualifier,
 OfficeFloorDeployer officeFloorDeployer,
 OfficeFloorSourceContext context)
           throws Exception

Instantiates the HttpServer from configuration.

Parameters:

serviceInput - DeployedOfficeInput servicing the ServerHttpConnection.

typeQualifier - Type qualifier for the ExternalServiceInput.

officeFloorDeployer - OfficeFloorDeployer.

context - OfficeFloorSourceContext.

Throws:

Exception - If fails to create the HttpServer from configuration.

HttpServer

public HttpServer(HttpServerImplementation implementation,
 String typeQualifier,
 HttpServerLocation serverLocation,
 String serverName,
 DateHttpHeaderClock dateHttpHeaderClock,
 boolean isIncludeEscalationStackTrace,
 SSLContext sslContext,
 DeployedOfficeInput serviceInput,
 OfficeFloorDeployer officeFloorDeployer,
 OfficeFloorSourceContext context)
           throws Exception

Instantiates the HttpServer from direct configuration.

Parameters:

implementation - HttpServerImplementation.

typeQualifier - Type qualifier for the ExternalServiceInput.

serverLocation - HttpServerLocation.

serverName - Server name. May be null.

dateHttpHeaderClock - DateHttpHeaderClock. May be null.

isIncludeEscalationStackTrace - Indicates whether to include Escalation stack trace in HttpResponse.

sslContext - SSLContext.

serviceInput - DeployedOfficeInput servicing the ServerHttpConnection.

officeFloorDeployer - OfficeFloorDeployer.

context - OfficeFloorSourceContext.

Throws:

Exception - If fails to configure the HttpServerImplementation.

Method Details

getPropertyString

public static String getPropertyString(String propertyName,
 SourceContext context,
 Supplier<String> defaultValue)

Obtains the Property value.

Parameters:

propertyName - Name of Property.

context - SourceContext.

defaultValue - Supplier of the default value.

Returns:

Value for the Property.

getPropertyInteger

public static int getPropertyInteger(String propertyName,
 SourceContext context,
 Supplier<Integer> defaultValue)

Obtains the Property value.

Parameters:

propertyName - Name of Property.

context - SourceContext.

defaultValue - Supplier of the default value.

Returns:

Value for the Property.

getSslContext

public static SSLContext getSslContext(SourceContext context)
                                throws Exception

Obtains the SSLContext from configuration.

Parameters:

context - SourceContext.

Returns:

SSLContext.

Throws:

Exception - If fails to load the SSLContext from configuration.

getServerHttpHeaderValue

public static HttpHeaderValue getServerHttpHeaderValue(HttpServerImplementationContext context,
 String suffix)

Convenience method to obtain the Server HttpHeaderValue.

Parameters:

context - HttpServerImplementationContext.

suffix - Optional suffix. May be null.

Returns:

Server HttpHeaderValue or null if not configured.

getHttpServerLocation

public HttpServerLocation getHttpServerLocation()

Obtains the HttpServerLocation.

Returns:

HttpServerLocation.

getHttpServerImplementation

public HttpServerImplementation getHttpServerImplementation()

Obtains the HttpServerImplementation.

Returns:

HttpServerImplementation.

getSslContext

public SSLContext getSslContext()

Obtains the SSLContext.

Returns:

SSLContext.