org.ops4j.pax.web.service.spi.config

Interface ServerConfiguration

public interface ServerConfiguration

Method Summary

Modifier and Type	Method and Description
Boolean	checkForwardedHeaders() Should the connector handle X-Forwarded-* / X-Proxied-* headers? Jetty: org.eclipse.jetty.server.ForwardedRequestCustomizer Undertow: io.undertow.server.handlers.ProxyPeerAddressHandler
File[]	getConfigurationFiles() Returns the files to read external server configuration from.
Integer	getConnectorIdleTimeout() Gets the idle timeout (in milliseconds) to be used with server connectors.
String[]	getConnectors() Returns a list of connector names to be used by default (if a context doesn't specify own configuration).
File	getContextConfigurationFile() Returns the file to read external server context configuration from.
Integer	getEventDispatcherThreadCount() Internal Pax Web configuration option to specify number of threads to dispatch WebElementEvent events.
String	getHttpConnectorName() Gets the name to use for default connector/listener.
Integer	getHttpPort() Get a TCP port to use for HTTP protocol.
String	getHttpSecureConnectorName() Gets the name to use for secure connector/listener.
Integer	getHttpSecurePort() Get a TCP port to use for HTTPS protocol.
String[]	getListeningAddresses() Returns the addresses to bind connector/listener to.
Integer	getServerIdleTimeout() Gets the server thread idle timeout in milliseconds.
Integer	getServerMaxThreads() Gets maximum number of threads to use in server runtime.
Integer	getServerMinThreads() Gets minimum number of threads to use in server runtime.
String	getServerThreadNamePrefix() If target container allows, this method specifies a prefix for thread names to use. Jetty: org.eclipse.jetty.util.thread.QueuedThreadPool#setName(java.lang.String) (defaults to "qtp" + hashcode). Tomcat: org.apache.catalina.core.StandardThreadExecutor#setNamePrefix(java.lang.String)
String	getTCCLType() Returns the type of TCCL that should be set for service methods (servlet (default) or whiteboard).
File	getTemporaryDirectory() Returns the temporary directory, directory that will be set as ServletContext.TEMPDIR.
String[]	getVirtualHosts() Returns a list of virtual hosts to be used by default (if a context doesn't specify own configuration).
Boolean	isHttpEnabled() Is default http connector/listener enabled? Uses PaxWebConfig.PID_CFG_HTTP_ENABLED
Boolean	isHttpSecureEnabled() Is default https connector/listener enabled? Uses PaxWebConfig.PID_CFG_HTTP_SECURE_ENABLED
Boolean	isShowStacks() Flag that specifies whether stack traces should be visible in error pages.

Method Detail

getTemporaryDirectory

File getTemporaryDirectory()

Returns the temporary directory, directory that will be set as ServletContext.TEMPDIR.

Returns:

the temporary directory

getConfigurationFiles

File[] getConfigurationFiles()

Returns the files to read external server configuration from. It's super useful for Jetty, where we can easily simulate JETTY_HOME/etc directory. Files must be in correct order (as enforced by given runtime). It can also be single file location or even null to let the runtime be configured using only PID configuration.

Returns:

configuration directories/files

Since:

Pax Web 8

getContextConfigurationFile

File getContextConfigurationFile()

Returns the file to read external server context configuration from. It's handled only for Jetty (etc/jetty-web.xml) and Tomcat (etc/tomcat-context.xml). This configuration applies to all contexts. For example Tomcat reads such configuration from $CATALINA_HOME/conf/context.xml

Returns:

global context configuration file

Since:

Pax Web 8

getHttpPort

Integer getHttpPort()

Get a TCP port to use for HTTP protocol. Uses PaxWebConfig.PID_CFG_HTTP_PORT property.

Returns:

getHttpSecurePort

Integer getHttpSecurePort()

Get a TCP port to use for HTTPS protocol. Uses PaxWebConfig.PID_CFG_HTTP_PORT_SECURE property.

Returns:

isHttpEnabled

Boolean isHttpEnabled()

Is default http connector/listener enabled? Uses PaxWebConfig.PID_CFG_HTTP_ENABLED

Returns:

isHttpSecureEnabled

Boolean isHttpSecureEnabled()

Is default https connector/listener enabled? Uses PaxWebConfig.PID_CFG_HTTP_SECURE_ENABLED

Returns:

getListeningAddresses

String[] getListeningAddresses()

Returns the addresses to bind connector/listener to. Defaults to one element array with 0.0.0.0.

Returns:

getHttpConnectorName

String getHttpConnectorName()

Gets the name to use for default connector/listener.

Returns:

getHttpSecureConnectorName

String getHttpSecureConnectorName()

Gets the name to use for secure connector/listener.

Returns:

getConnectorIdleTimeout

Integer getConnectorIdleTimeout()

Gets the idle timeout (in milliseconds) to be used with server connectors. Idle timeout is like socket read timeout, but on server side.

• Jetty: org.eclipse.jetty.server.AbstractConnector#setIdleTimeout(long)
• Tomcat: org.apache.coyote.AbstractProtocol#setConnectionTimeout(int)

Returns:

getServerIdleTimeout

Integer getServerIdleTimeout()

Gets the server thread idle timeout in milliseconds.

• Jetty: org.eclipse.jetty.util.thread.QueuedThreadPool#setIdleTimeout(int)
• Tomcat: org.apache.catalina.core.StandardThreadExecutor#setMaxIdleTime(int)

Returns:

getServerMaxThreads

Integer getServerMaxThreads()

Gets maximum number of threads to use in server runtime. This value MAY mean something different in different runtimes.

• Jetty: org.eclipse.jetty.util.thread.QueuedThreadPool#setMaxThreads(int)
• Tomcat: org.apache.catalina.core.StandardThreadExecutor#setMaxThreads(int)

Returns:

getServerMinThreads

Integer getServerMinThreads()

Gets minimum number of threads to use in server runtime. This value MAY mean something different in different runtimes.

• Jetty: org.eclipse.jetty.util.thread.QueuedThreadPool#setMinThreads(int)
• Tomcat: org.apache.catalina.core.StandardThreadExecutor#setMinSpareThreads(int)

Returns:

getServerThreadNamePrefix

String getServerThreadNamePrefix()

If target container allows, this method specifies a prefix for thread names to use.

• Jetty: org.eclipse.jetty.util.thread.QueuedThreadPool#setName(java.lang.String) (defaults to "qtp" + hashcode).
• Tomcat: org.apache.catalina.core.StandardThreadExecutor#setNamePrefix(java.lang.String)

Returns:

checkForwardedHeaders

Boolean checkForwardedHeaders()

Should the connector handle X-Forwarded-* / X-Proxied-* headers?

• Jetty: org.eclipse.jetty.server.ForwardedRequestCustomizer
• Undertow: io.undertow.server.handlers.ProxyPeerAddressHandler

Returns:

getEventDispatcherThreadCount

Integer getEventDispatcherThreadCount()

Internal Pax Web configuration option to specify number of threads to dispatch WebElementEvent events.

Returns:

isShowStacks

Boolean isShowStacks()

Flag that specifies whether stack traces should be visible in error pages.

Returns:

getVirtualHosts

String[] getVirtualHosts()

Returns a list of virtual hosts to be used by default (if a context doesn't specify own configuration). Defaults to empty list.

Returns:

getConnectors

String[] getConnectors()

Returns a list of connector names to be used by default (if a context doesn't specify own configuration). Defaults to empty list.

Returns:

getTCCLType

String getTCCLType()

Returns the type of TCCL that should be set for service methods (servlet (default) or whiteboard).

Returns: