Package net.officefloor.server.http

Interface HttpServerImplementationContext

public interface HttpServerImplementationContext

Context for the HttpServerImplementation.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
DateHttpHeaderClock	getDateHttpHeaderClock()	Obtains the DateHttpHeaderClock for the Date HttpHeader.
<M extends ManagedObject> ExternalServiceInput<ServerHttpConnection,M>	getExternalServiceInput(java.lang.Class<M> managedObjectType, ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)	Obtains the ExternalServiceInput.
HttpServerLocation	getHttpServerLocation()	Obtains the HttpServerLocation.
DeployedOfficeInput	getInternalServiceInput()	Obtains the DeployedOfficeInput for internal invoked servicing.
OfficeFloorDeployer	getOfficeFloorDeployer()	Obtains the OfficeFloorDeployer to configure the HttpServer.
OfficeFloorSourceContext	getOfficeFloorSourceContext()	Obtains the OfficeFloorSourceContext to obtain details to configure the HttpServerImplementation.
java.lang.String	getServerName()	Obtains the Server HttpHeader name.
javax.net.ssl.SSLContext	getSslContext()	Obtains the SSLContext to use for HTTPS.
boolean	isIncludeEscalationStackTrace()	Indicates whether the HttpServerImplementation should include the stack trace in Escalation responses.

Method Detail

getHttpServerLocation

HttpServerLocation getHttpServerLocation()

Obtains the HttpServerLocation.

Returns:

HttpServerLocation.

getServerName

java.lang.String getServerName()

Obtains the Server HttpHeader name.

HttpServerImplementation implementations may append to this name to indicate their use.

Returns:

Server HttpHeader name. May be null to not send HttpHeader.

getDateHttpHeaderClock

DateHttpHeaderClock getDateHttpHeaderClock()

Obtains the DateHttpHeaderClock for the Date HttpHeader.

Returns:

DateHttpHeaderClock. May be null to not send HttpHeader.

isIncludeEscalationStackTrace

boolean isIncludeEscalationStackTrace()

Indicates whether the HttpServerImplementation should include the stack trace in Escalation responses.

For development, stack traces should be enabled for easier debugging of issues. However, in production, they should be hidden.

Returns:

true to include the stack traces. false should hide stack traces.

getSslContext

javax.net.ssl.SSLContext getSslContext()
                                throws java.lang.Exception

Obtains the SSLContext to use for HTTPS.

Should the HttpServer be behind a Reverse Proxy providing SSL, then this may be null if the Reverse Proxy is communicating via non-secure HTTP.

Returns:

SSLContext to use for HTTPS. May be null if behind Reverse Proxy handling SSL (with communication from Reverse Proxy over non-secure HTTP).

Throws:

java.lang.Exception - If fails to create the SSLContext.

getInternalServiceInput

DeployedOfficeInput getInternalServiceInput()

Obtains the DeployedOfficeInput for internal invoked servicing.

Returns:

DeployedOfficeInput for internal invoked servicing.

getExternalServiceInput

<M extends ManagedObject> ExternalServiceInput<ServerHttpConnection,M> getExternalServiceInput(java.lang.Class<M> managedObjectType,
                                                                                                     ExternalServiceCleanupEscalationHandler<? super M> cleanupEscalationHandler)

Obtains the ExternalServiceInput.

Type Parameters:

M - ManagedObject type.

Parameters:

managedObjectType - Type of the ManagedObject.

cleanupEscalationHandler - ExternalServiceCleanupEscalationHandler.

Returns:

ExternalServiceInput.

getOfficeFloorDeployer

OfficeFloorDeployer getOfficeFloorDeployer()

Obtains the OfficeFloorDeployer to configure the HttpServer.

Returns:

OfficeFloorDeployer to configure the HttpServer.

getOfficeFloorSourceContext

OfficeFloorSourceContext getOfficeFloorSourceContext()

Obtains the OfficeFloorSourceContext to obtain details to configure the HttpServerImplementation.

Returns:

OfficeFloorSourceContext to obtain details to configure the HttpServerImplementation.