Interface PaxWebConfig
-
public interface PaxWebConfig
Dedicated interface with constants related to configuration. Other constants reside in
PaxWebConstants
.Constants names use the following prefixes:
PID_CFG_
- for property names found inorg.ops4j.pax.web
PID
When adding new properties, remember to add them in more places:
- Constant name in this interface
- Relevant method (if needed) in
org.ops4j.pax.web.service.spi.config.Configuration
- Metatype information for default values (if needed) in
pax-web-runtime/src/main/resources/OSGI-INF/metatype/metatype.xml
-
-
Field Summary
Fields Modifier and Type Field Description static String
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SCAN
Context property listing symbolic names of the bundles or jar names (in/WEB-INF/lib
) patterns to skan when searching for TLDs, web fragments and annotated classes.static String
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SKIP
Context property listing symbolic names of the bundles or jar names (in/WEB-INF/lib
) patterns to skip when searching for TLDs, web fragments and annotated classes.static String
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_THREADS
BundleContext
property to configure thread count for WAR extender.static String
PID_CFG_CIPHERSUITES_EXCLUDED
Comma separated list of excluded cipher suite names.static String
PID_CFG_CIPHERSUITES_INCLUDED
Comma separated list of included cipher suite names, as inSSLEngine.setEnabledCipherSuites(String[])
.static String
PID_CFG_CONNECTOR_IDLE_TIMEOUT
Jetty:org.eclipse.jetty.server.AbstractConnector#setIdleTimeout(long)
static String
PID_CFG_CONNECTOR_LIST
Comma-separated list of connector names to set on every deployed context if the context itself doesn't specify such configuration.static String
PID_CFG_CONTEXT_CONFIGURATION_FILE
Option to specify single global context configuration file (only Jetty and Tomcat).static String
PID_CFG_CRL_PATH
Location of CRL file to use withCertificateFactory.generateCRLs(java.io.InputStream)
for X.509 factorystatic String
PID_CFG_DEFAULT_SERVLET_ACCEPT_RANGES
Boolean property to specify whether default servlet should reply withAccept-Ranges: bytes
header.static String
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRIES
Integer property to specify maximum number of cache entries (per single resource manager).static String
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRY_SIZE
Integer property to specify maximum size (kB) of single cache entry (file) (per single resource manager).static String
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_TOTAL_SIZE
Integer property to specify maximum total size (kB) of the cache (per single resource manager).static String
PID_CFG_DEFAULT_SERVLET_CACHE_TTL
Integer property to specify TTL for cache entries (ms)static String
PID_CFG_DEFAULT_SERVLET_DIR_LISTING
Boolean property to specify whether dir index should be present when accessing dir resource.static String
PID_CFG_DEFAULT_SERVLET_REDIRECT_WELCOME
Boolean property to specify whether welcome file should be served immediately, or by redirect.static String
PID_CFG_DIGESTAUTH_MAX_NONCE_AGE
Return max nonce age for DIGEST authentication (in ms), defaults to 60s (60000ms)static String
PID_CFG_DIGESTAUTH_MAX_NONCE_COUNT
Return max nonce count for DIGEST authentication, defaults to 1024static String
PID_CFG_ENABLE_CRLDP
Should Certificate Revocation List Distribution Points support (CRLDP) be enabled?static String
PID_CFG_ENABLE_OCSP
Should On-Line Certificate Status Protocol (OCSP) be enabled?static String
PID_CFG_ENC_ALGORITHM
Algorithm name to use for PBE encryption - seeSecretKeyFactory.getInstance(java.lang.String)
defaults toPBEWithHmacSHA256AndAES_128
static String
PID_CFG_ENC_ENABLED
Boolean property that tells pax-web-runtime that the configuration may contain encrypted values.static String
PID_CFG_ENC_ITERATION_COUNT
IC parameter for PBE encryption - defaults to 1000static String
PID_CFG_ENC_MASTERPASSWORD
Plain text encryption passwordstatic String
PID_CFG_ENC_MASTERPASSWORD_ENV
Environment variable to use for encryption passwordstatic String
PID_CFG_ENC_MASTERPASSWORD_SYS
System property to use for encryption passwordstatic String
PID_CFG_ENC_OSGI_DECRYPTOR
Similarly to Pax JDBC/JMS, we can reference an OSGi service withobjectClass=org.jasypt.encryption.StringEncryptor
anddecryptor
properties.static String
PID_CFG_ENC_PREFIX
String property for the prefix for encrypted values.static String
PID_CFG_ENC_PROPERTY_PREFIX
static String
PID_CFG_ENC_PROVIDER
Provider name to use for PBE encryption - defaults toSunJCE
on Oracle/OpenJDKstatic String
PID_CFG_ENC_SUFFIX
String property for the suffix for encrypted values.static String
PID_CFG_EVENT_DISPATCHER_THREAD_COUNT
Option to specify number of threads for internal web element/context (un)registration event dispatching.static String
PID_CFG_FORMAUTH_REDIRECT
Returns whether to forward (false, default) to form-login error page or use redirect (true)static String
PID_CFG_HTTP_CHECK_FORWARDED_HEADERS
Jetty: addsorg.eclipse.jetty.server.ForwardedRequestCustomizer
toHttpConfiguration
static String
PID_CFG_HTTP_CONNECTOR_NAME
Name to use as default (non-secure) connector, defaults todefault
.static String
PID_CFG_HTTP_ENABLED
Should the default non-secure port be enabled?static String
PID_CFG_HTTP_PORT
This property specifies the port used for servlets and resources accessible via HTTP.static String
PID_CFG_HTTP_PORT_SECURE
This property specifies the port used for servlets and resources accessible via HTTPS.static String
PID_CFG_HTTP_SECURE_CONNECTOR_NAME
Name to use as secure connector, defaults tosecureDefault
.static String
PID_CFG_HTTP_SECURE_ENABLED
Should the default secure port be enabled?static String
PID_CFG_JSP_SCRATCH_DIR
Global Scratch directory for JSPs - by default it is relative to global tmp dir and depends on the contextstatic String
PID_CFG_LISTENING_ADDRESSES
Comma-separated list of addresses to bind listeners/connectors to.static String
PID_CFG_LOG_NCSA_APPEND
Whether to append to log filestatic String
PID_CFG_LOG_NCSA_BUFFERED
Whether NCSA log file access should be buffered.static String
PID_CFG_LOG_NCSA_ENABLED
Should we enable "NCSA Logger"?static String
PID_CFG_LOG_NCSA_EXTENDED
Jetty whether to use CustomRequestLog#EXTENDED_NCSA_FORMAT or CustomRequestLog#NCSA_FORMATstatic String
PID_CFG_LOG_NCSA_LOGDIR
Directory to store request log filesstatic String
PID_CFG_LOG_NCSA_LOGFILE
Jetty: defaults to "yyyy_mm_dd.request.log", should containyyyy_mm_dd
.static String
PID_CFG_LOG_NCSA_LOGFILE_DATE_FORMAT
Date format to use when current file is renamed during rollover Jetty: org.eclipse.jetty.util.RolloverFileOutputStream._fileDateFormat = ROLLOVER_FILE_DATE_FORMATstatic String
PID_CFG_LOG_NCSA_LOGTIMEZONE
Timezone to use in logs Jetty: org.eclipse.jetty.server.RequestLogWriter#_timeZonestatic String
PID_CFG_LOG_NCSA_RETAINDAYS
Number of days to retain request files Jetty: org.eclipse.jetty.server.RequestLogWriter._retainDaysstatic String
PID_CFG_MAX_CERT_PATH_LENGTH
Return max length of cert path to use during certificate validationstatic String
PID_CFG_OCSP_RESPONDER_URL
OCSP responder URL, though it doesn't seem to be used by Jetty.static String
PID_CFG_PROTOCOLS_EXCLUDED
Comma separated list of excluded protocol names.static String
PID_CFG_PROTOCOLS_INCLUDED
Comma separated list of included protocol names, as inSSLEngine.setEnabledProtocols(String[])
.static String
PID_CFG_SERVER_CONFIGURATION_FILE
Option to specify single external configuration file.static String
PID_CFG_SERVER_CONFIGURATION_FILES
Specify comma-separated list of external, server-specific config locations.static String
PID_CFG_SERVER_IDLE_TIMEOUT
Jetty:org.eclipse.jetty.util.thread.QueuedThreadPool#setIdleTimeout(int)
static String
PID_CFG_SERVER_MAX_THREADS
Gets maximum number of threads to use in server runtime.static String
PID_CFG_SERVER_MIN_THREADS
Gets minimum number of threads to use in server runtime.static String
PID_CFG_SERVER_THREAD_NAME_PREFIX
Prefix to use for server thread names.static String
PID_CFG_SESSION_COOKIE_COMMENT
String property that specifies session cookie commentstatic String
PID_CFG_SESSION_COOKIE_DOMAIN
String property that specifies session cookie domainstatic String
PID_CFG_SESSION_COOKIE_HTTP_ONLY
Boolean property that specifies http only flag for session cookie.static String
PID_CFG_SESSION_COOKIE_MAX_AGE
Integer property that specifies max age of session cookiestatic String
PID_CFG_SESSION_COOKIE_NAME
String property that specifies session cookie name (defaults toJSESSIONID
)static String
PID_CFG_SESSION_COOKIE_PATH
String property that specifies session cookie path (defaults to context path)static String
PID_CFG_SESSION_COOKIE_SAME_SITE
String property that specifiesSameSite
attribute of session cookiestatic String
PID_CFG_SESSION_COOKIE_SECURE
Boolean property that specifies secure flag for session cookie.static String
PID_CFG_SESSION_STORE_DIRECTORY
When specified and is a valid directory location, file session persistence will be enabledstatic String
PID_CFG_SESSION_TIMEOUT
Integer property that specifies timeout of sessions in minutes (defaults to 30)static String
PID_CFG_SESSION_URL
For Jetty, we can specify the URL path parameter for session URL rewriting.static String
PID_CFG_SESSION_WORKER_NAME
Allows configuration of Jetty's SessionHandler.SessionIdManager.workerNamestatic String
PID_CFG_SHOW_STACKS
Boolean property to configure the container to show or hide stack traces in error handler.static String
PID_CFG_SSL_CLIENT_AUTH_NEEDED
Flag forSSLEngine.setNeedClientAuth(boolean)
static String
PID_CFG_SSL_CLIENT_AUTH_WANTED
Flag forSSLEngine.setWantClientAuth(boolean)
static String
PID_CFG_SSL_KEY_ALIAS
Alias of private key entry in server keystore to use of no SNI is enabledstatic String
PID_CFG_SSL_KEY_MANAGER_FACTORY_ALGORITHM
Algorithm to use forKeyManagerFactory.getInstance(String)
static String
PID_CFG_SSL_KEY_PASSWORD
Password for private key entry inside server keystorestatic String
PID_CFG_SSL_KEYSTORE
File or URL to location of Keystore with server certificate and private key.static String
PID_CFG_SSL_KEYSTORE_PASSWORD
Password for entire server keystorestatic String
PID_CFG_SSL_KEYSTORE_PROVIDER
Provider of server keystore as specified byKeyStore.getInstance(String, String)
static String
PID_CFG_SSL_KEYSTORE_TYPE
Type of server keystore to use as specified byKeyStore.getInstance(String, String)
static String
PID_CFG_SSL_PROTOCOL
Protocol to use withSSLContext.getInstance(String)
.static String
PID_CFG_SSL_PROVIDER
Property to specify SSL provider to use for secure connector.static String
PID_CFG_SSL_RENEGOTIATION_ALLOWED
Allow SSL renegotiationstatic String
PID_CFG_SSL_RENEGOTIATION_LIMIT
SSL renegotiation limitstatic String
PID_CFG_SSL_SECURE_RANDOM_ALGORITHM
Algorithm to use withSecureRandom.getInstance(String)
.static String
PID_CFG_SSL_SESSION_CACHE_SIZE
SSL Session cache size.static String
PID_CFG_SSL_SESSION_ENABLED
Are SSL Sessions enabled? Iftrue
(which is default), such hint is passed toSSLContext.createSSLEngine(String, int)
.static String
PID_CFG_SSL_SESSION_TIMEOUT
SSL Session timeout.static String
PID_CFG_SSL_TRUST_MANAGER_FACTORY_ALGORITHM
Algorithm to use forTrustManagerFactory.getInstance(String)
static String
PID_CFG_SSL_TRUSTSTORE
File or URL to location of server truststore.static String
PID_CFG_SSL_TRUSTSTORE_PASSWORD
Password for entire server truststorestatic String
PID_CFG_SSL_TRUSTSTORE_PROVIDER
Provider of server truststore as specified byKeyStore.getInstance(String, String)
static String
PID_CFG_SSL_TRUSTSTORE_TYPE
Type of server truststore to use as specified byKeyStore.getInstance(String, String)
static String
PID_CFG_TCCL_TYPE
Defines the type of TCCL that should be set for service methods (likeServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
).static String
PID_CFG_TEMP_DIR
Servlet API 4, 4.8.1 "Temporary Working Directories".static String
PID_CFG_VALIDATE_CERTS
Whether certificates in server keystore should be validated on loadstatic String
PID_CFG_VALIDATE_PEER_CERTS
Whether certificates in server truststore should be validated on loadstatic String
PID_CFG_VIRTUAL_HOST_LIST
Comma-separated list of virtual hosts to set on every deployed context if the context itself doesn't specify such configuration.
-
-
-
Field Detail
-
PID_CFG_TEMP_DIR
static final String PID_CFG_TEMP_DIR
Servlet API 4, 4.8.1 "Temporary Working Directories". According to specification, it should be different for eachServletContext
, but we also need single global temporary directory.- See Also:
- Constant Field Values
-
PID_CFG_SERVER_CONFIGURATION_FILE
static final String PID_CFG_SERVER_CONFIGURATION_FILE
Option to specify single external configuration file.- See Also:
- Constant Field Values
-
PID_CFG_SERVER_CONFIGURATION_FILES
static final String PID_CFG_SERVER_CONFIGURATION_FILES
Specify comma-separated list of external, server-specific config locations.- Since:
- Pax Web 8
- See Also:
- Constant Field Values
-
PID_CFG_CONTEXT_CONFIGURATION_FILE
static final String PID_CFG_CONTEXT_CONFIGURATION_FILE
Option to specify single global context configuration file (only Jetty and Tomcat).- See Also:
- Constant Field Values
-
PID_CFG_HTTP_PORT
static final String PID_CFG_HTTP_PORT
This property specifies the port used for servlets and resources accessible via HTTP. The default value for this property is80
according to specification, but we'll use8080
.- See Also:
- Constant Field Values
-
PID_CFG_HTTP_PORT_SECURE
static final String PID_CFG_HTTP_PORT_SECURE
This property specifies the port used for servlets and resources accessible via HTTPS. The default value for this property is443
according to specificaton, but we'll use8443
.- See Also:
- Constant Field Values
-
PID_CFG_HTTP_ENABLED
static final String PID_CFG_HTTP_ENABLED
Should the default non-secure port be enabled?- See Also:
- Constant Field Values
-
PID_CFG_HTTP_SECURE_ENABLED
static final String PID_CFG_HTTP_SECURE_ENABLED
Should the default secure port be enabled?- See Also:
- Constant Field Values
-
PID_CFG_LISTENING_ADDRESSES
static final String PID_CFG_LISTENING_ADDRESSES
Comma-separated list of addresses to bind listeners/connectors to. Defaults to0.0.0.0
- See Also:
- Constant Field Values
-
PID_CFG_HTTP_CONNECTOR_NAME
static final String PID_CFG_HTTP_CONNECTOR_NAME
Name to use as default (non-secure) connector, defaults todefault
.- See Also:
- Constant Field Values
-
PID_CFG_HTTP_SECURE_CONNECTOR_NAME
static final String PID_CFG_HTTP_SECURE_CONNECTOR_NAME
Name to use as secure connector, defaults tosecureDefault
.- See Also:
- Constant Field Values
-
PID_CFG_CONNECTOR_IDLE_TIMEOUT
static final String PID_CFG_CONNECTOR_IDLE_TIMEOUT
Jetty:org.eclipse.jetty.server.AbstractConnector#setIdleTimeout(long)
- See Also:
- Constant Field Values
-
PID_CFG_SERVER_IDLE_TIMEOUT
static final String PID_CFG_SERVER_IDLE_TIMEOUT
Jetty:org.eclipse.jetty.util.thread.QueuedThreadPool#setIdleTimeout(int)
- See Also:
- Constant Field Values
-
PID_CFG_SERVER_MAX_THREADS
static final String PID_CFG_SERVER_MAX_THREADS
Gets maximum number of threads to use in server runtime. Jetty:org.eclipse.jetty.util.thread.QueuedThreadPool#setMaxThreads(int)
- See Also:
- Constant Field Values
-
PID_CFG_SERVER_MIN_THREADS
static final String PID_CFG_SERVER_MIN_THREADS
Gets minimum number of threads to use in server runtime. Jetty:org.eclipse.jetty.util.thread.QueuedThreadPool#setMinThreads(int)
- See Also:
- Constant Field Values
-
PID_CFG_SERVER_THREAD_NAME_PREFIX
static final String PID_CFG_SERVER_THREAD_NAME_PREFIX
Prefix to use for server thread names. Jetty:org.eclipse.jetty.util.thread.QueuedThreadPool#setName(java.lang.String)
- See Also:
- Constant Field Values
-
PID_CFG_HTTP_CHECK_FORWARDED_HEADERS
static final String PID_CFG_HTTP_CHECK_FORWARDED_HEADERS
Jetty: addsorg.eclipse.jetty.server.ForwardedRequestCustomizer
toHttpConfiguration
- See Also:
- Constant Field Values
-
PID_CFG_VIRTUAL_HOST_LIST
static final String PID_CFG_VIRTUAL_HOST_LIST
Comma-separated list of virtual hosts to set on every deployed context if the context itself doesn't specify such configuration. Defaults to empty list.- See Also:
- Constant Field Values
-
PID_CFG_CONNECTOR_LIST
static final String PID_CFG_CONNECTOR_LIST
Comma-separated list of connector names to set on every deployed context if the context itself doesn't specify such configuration. Defaults to empty list.- See Also:
- Constant Field Values
-
PID_CFG_EVENT_DISPATCHER_THREAD_COUNT
static final String PID_CFG_EVENT_DISPATCHER_THREAD_COUNT
Option to specify number of threads for internal web element/context (un)registration event dispatching. Defaults to1
("3" was hardcoded before Pax Web 8).- See Also:
- Constant Field Values
-
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_THREADS
static final String BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_THREADS
BundleContext
property to configure thread count for WAR extender. Before Pax Web 8 it was hardcoded to 3 (which is still the default value).- See Also:
- Constant Field Values
-
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SKIP
static final String BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SKIP
Context property listing symbolic names of the bundles or jar names (in/WEB-INF/lib
) patterns to skip when searching for TLDs, web fragments and annotated classes. This property can have special value of"default"
(no quotes) which roughly matches Tomcat'stomcat.util.scan.StandardJarScanFilter.jarsToSkip
property- See Also:
- Constant Field Values
-
BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SCAN
static final String BUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SCAN
Context property listing symbolic names of the bundles or jar names (in/WEB-INF/lib
) patterns to skan when searching for TLDs, web fragments and annotated classes. Normally all the reachable jars are scanned, but if something is matched byBUNDLE_CONTEXT_PROPERTY_WAR_EXTENDER_JARS_TO_SKIP
, we can skan it by adding the pattern to this property (by default this property has empty value, which means that all non-skipped libraries are scanned).- See Also:
- Constant Field Values
-
PID_CFG_TCCL_TYPE
static final String PID_CFG_TCCL_TYPE
Defines the type of TCCL that should be set for service methods (like
Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
). It can take two values:servlet
(the default, assumed value) -ServletContext.getClassLoader()
returns only the bundle's class loader for given servlet/filter, but TCCL is set to servlet context's classloaderwhiteboard
-ServletContext.getClassLoader()
and TCCL are set to the same classloader, the classloader of a bundle which was used to register given web element.
According to Whiteboard specification,
ServletContext.getClassLoader()
should return a classloader for a bundle which was used to register given Whiteboard service (like servlet or a filter). This is ensured by Pax Web 8. However, Whiteboard specification doesn't say anything aboutThread Context ClassLoader
, so by the principle of least surprise, the TCCL is set to a "servlet context class loader", which in Pax Web is a delegating class loader, which can reach to multiple bundles, including the bundle of the runtime (like pax-web-jetty), JSP bundle, whiteboard bundle and definitely - all the bundles for all the web elements which are registered into the given servlet context - this is the default behavior, because it matches the expected behavior for web applications (WARs/WABs).- See Also:
- Constant Field Values
-
PID_CFG_SSL_PROVIDER
static final String PID_CFG_SSL_PROVIDER
Property to specify SSL provider to use for secure connector.
Jetty:
org.eclipse.jetty.util.ssl.SslContextFactory#setProvider()
. Used in:CertificateFactory.getInstance(String, String)
- defaultSUN
CertStore.getInstance(String, CertStoreParameters, String)
- defaultSUN
KeyManagerFactory.getInstance(String, String)
- defaultSunJSSE
SecureRandom.getInstance(String, String)
- defaultSUN
SSLContext.getInstance(String, String)
- defaultSunJSSE
TrustManagerFactory.getInstance(String, String)
- defaultSunJSSE
- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEYSTORE
static final String PID_CFG_SSL_KEYSTORE
File or URL to location of Keystore with server certificate and private key.- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEYSTORE_PASSWORD
static final String PID_CFG_SSL_KEYSTORE_PASSWORD
Password for entire server keystore- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEYSTORE_TYPE
static final String PID_CFG_SSL_KEYSTORE_TYPE
Type of server keystore to use as specified byKeyStore.getInstance(String, String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEYSTORE_PROVIDER
static final String PID_CFG_SSL_KEYSTORE_PROVIDER
Provider of server keystore as specified byKeyStore.getInstance(String, String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEY_PASSWORD
static final String PID_CFG_SSL_KEY_PASSWORD
Password for private key entry inside server keystore- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEY_MANAGER_FACTORY_ALGORITHM
static final String PID_CFG_SSL_KEY_MANAGER_FACTORY_ALGORITHM
Algorithm to use forKeyManagerFactory.getInstance(String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_KEY_ALIAS
static final String PID_CFG_SSL_KEY_ALIAS
Alias of private key entry in server keystore to use of no SNI is enabled- See Also:
- Constant Field Values
-
PID_CFG_SSL_TRUSTSTORE
static final String PID_CFG_SSL_TRUSTSTORE
File or URL to location of server truststore.- See Also:
- Constant Field Values
-
PID_CFG_SSL_TRUSTSTORE_PASSWORD
static final String PID_CFG_SSL_TRUSTSTORE_PASSWORD
Password for entire server truststore- See Also:
- Constant Field Values
-
PID_CFG_SSL_TRUSTSTORE_TYPE
static final String PID_CFG_SSL_TRUSTSTORE_TYPE
Type of server truststore to use as specified byKeyStore.getInstance(String, String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_TRUSTSTORE_PROVIDER
static final String PID_CFG_SSL_TRUSTSTORE_PROVIDER
Provider of server truststore as specified byKeyStore.getInstance(String, String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_TRUST_MANAGER_FACTORY_ALGORITHM
static final String PID_CFG_SSL_TRUST_MANAGER_FACTORY_ALGORITHM
Algorithm to use forTrustManagerFactory.getInstance(String)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_CLIENT_AUTH_WANTED
static final String PID_CFG_SSL_CLIENT_AUTH_WANTED
Flag forSSLEngine.setWantClientAuth(boolean)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_CLIENT_AUTH_NEEDED
static final String PID_CFG_SSL_CLIENT_AUTH_NEEDED
Flag forSSLEngine.setNeedClientAuth(boolean)
- See Also:
- Constant Field Values
-
PID_CFG_SSL_PROTOCOL
static final String PID_CFG_SSL_PROTOCOL
Protocol to use withSSLContext.getInstance(String)
. Defaults toTLSv1.2
- See Also:
- Constant Field Values
-
PID_CFG_SSL_SECURE_RANDOM_ALGORITHM
static final String PID_CFG_SSL_SECURE_RANDOM_ALGORITHM
Algorithm to use withSecureRandom.getInstance(String)
.- See Also:
- Constant Field Values
-
PID_CFG_PROTOCOLS_INCLUDED
static final String PID_CFG_PROTOCOLS_INCLUDED
Comma separated list of included protocol names, as inSSLEngine.setEnabledProtocols(String[])
. Protocol names are taken fromsun.security.ssl.ProtocolVersion
- See Also:
- Constant Field Values
-
PID_CFG_PROTOCOLS_EXCLUDED
static final String PID_CFG_PROTOCOLS_EXCLUDED
Comma separated list of excluded protocol names. All supported without excluded will be used inSSLEngine.setEnabledProtocols(String[])
- See Also:
- Constant Field Values
-
PID_CFG_CIPHERSUITES_INCLUDED
static final String PID_CFG_CIPHERSUITES_INCLUDED
Comma separated list of included cipher suite names, as inSSLEngine.setEnabledCipherSuites(String[])
. Cipher suite names are taken fromsun.security.ssl.CipherSuite
- See Also:
- Constant Field Values
-
PID_CFG_CIPHERSUITES_EXCLUDED
static final String PID_CFG_CIPHERSUITES_EXCLUDED
Comma separated list of excluded cipher suite names. All supported without excluded will be used inSSLEngine.setEnabledCipherSuites(String[])
- See Also:
- Constant Field Values
-
PID_CFG_SSL_RENEGOTIATION_ALLOWED
static final String PID_CFG_SSL_RENEGOTIATION_ALLOWED
Allow SSL renegotiation- See Also:
- Constant Field Values
-
PID_CFG_SSL_RENEGOTIATION_LIMIT
static final String PID_CFG_SSL_RENEGOTIATION_LIMIT
SSL renegotiation limit- See Also:
- Constant Field Values
-
PID_CFG_SSL_SESSION_ENABLED
static final String PID_CFG_SSL_SESSION_ENABLED
Are SSL Sessions enabled? Iftrue
(which is default), such hint is passed toSSLContext.createSSLEngine(String, int)
.- See Also:
- Constant Field Values
-
PID_CFG_SSL_SESSION_CACHE_SIZE
static final String PID_CFG_SSL_SESSION_CACHE_SIZE
SSL Session cache size. Defaults to-1
- See Also:
- Constant Field Values
-
PID_CFG_SSL_SESSION_TIMEOUT
static final String PID_CFG_SSL_SESSION_TIMEOUT
SSL Session timeout. Defaults to-1
- See Also:
- Constant Field Values
-
PID_CFG_VALIDATE_CERTS
static final String PID_CFG_VALIDATE_CERTS
Whether certificates in server keystore should be validated on load- See Also:
- Constant Field Values
-
PID_CFG_VALIDATE_PEER_CERTS
static final String PID_CFG_VALIDATE_PEER_CERTS
Whether certificates in server truststore should be validated on load- See Also:
- Constant Field Values
-
PID_CFG_ENABLE_OCSP
static final String PID_CFG_ENABLE_OCSP
Should On-Line Certificate Status Protocol (OCSP) be enabled?- See Also:
- Constant Field Values
-
PID_CFG_ENABLE_CRLDP
static final String PID_CFG_ENABLE_CRLDP
Should Certificate Revocation List Distribution Points support (CRLDP) be enabled?- See Also:
- Constant Field Values
-
PID_CFG_CRL_PATH
static final String PID_CFG_CRL_PATH
Location of CRL file to use withCertificateFactory.generateCRLs(java.io.InputStream)
for X.509 factory- See Also:
- Constant Field Values
-
PID_CFG_OCSP_RESPONDER_URL
static final String PID_CFG_OCSP_RESPONDER_URL
OCSP responder URL, though it doesn't seem to be used by Jetty.- See Also:
- Constant Field Values
-
PID_CFG_MAX_CERT_PATH_LENGTH
static final String PID_CFG_MAX_CERT_PATH_LENGTH
Return max length of cert path to use during certificate validation- See Also:
- Constant Field Values
-
PID_CFG_DIGESTAUTH_MAX_NONCE_AGE
static final String PID_CFG_DIGESTAUTH_MAX_NONCE_AGE
Return max nonce age for DIGEST authentication (in ms), defaults to 60s (60000ms)- See Also:
- Constant Field Values
-
PID_CFG_DIGESTAUTH_MAX_NONCE_COUNT
static final String PID_CFG_DIGESTAUTH_MAX_NONCE_COUNT
Return max nonce count for DIGEST authentication, defaults to 1024- See Also:
- Constant Field Values
-
PID_CFG_FORMAUTH_REDIRECT
static final String PID_CFG_FORMAUTH_REDIRECT
Returns whether to forward (false, default) to form-login error page or use redirect (true)- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_ENABLED
static final String PID_CFG_LOG_NCSA_ENABLED
Should we enable "NCSA Logger"?- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_LOGDIR
static final String PID_CFG_LOG_NCSA_LOGDIR
Directory to store request log files- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_LOGFILE
static final String PID_CFG_LOG_NCSA_LOGFILE
Jetty: defaults to "yyyy_mm_dd.request.log", should containyyyy_mm_dd
. Tomcat: it should NOT containyyyy_mm_dd
, so please specify your own name. Undertow: will be appended with "log" or "yyyy-MM-dd.log"- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_LOGFILE_DATE_FORMAT
static final String PID_CFG_LOG_NCSA_LOGFILE_DATE_FORMAT
Date format to use when current file is renamed during rollover Jetty: org.eclipse.jetty.util.RolloverFileOutputStream._fileDateFormat = ROLLOVER_FILE_DATE_FORMAT- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_APPEND
static final String PID_CFG_LOG_NCSA_APPEND
Whether to append to log file- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_RETAINDAYS
static final String PID_CFG_LOG_NCSA_RETAINDAYS
Number of days to retain request files Jetty: org.eclipse.jetty.server.RequestLogWriter._retainDays- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_EXTENDED
static final String PID_CFG_LOG_NCSA_EXTENDED
Jetty whether to use CustomRequestLog#EXTENDED_NCSA_FORMAT or CustomRequestLog#NCSA_FORMAT- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_LOGTIMEZONE
static final String PID_CFG_LOG_NCSA_LOGTIMEZONE
Timezone to use in logs Jetty: org.eclipse.jetty.server.RequestLogWriter#_timeZone- See Also:
- Constant Field Values
-
PID_CFG_LOG_NCSA_BUFFERED
static final String PID_CFG_LOG_NCSA_BUFFERED
Whether NCSA log file access should be buffered. Defaults totrue
.- See Also:
- Constant Field Values
-
PID_CFG_DEFAULT_SERVLET_ACCEPT_RANGES
static final String PID_CFG_DEFAULT_SERVLET_ACCEPT_RANGES
Boolean property to specify whether default servlet should reply with
Accept-Ranges: bytes
header.- Jetty:
acceptRanges
boolean init parameter - Tomcat:
useAcceptRanges
boolean init parameter
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_REDIRECT_WELCOME
static final String PID_CFG_DEFAULT_SERVLET_REDIRECT_WELCOME
Boolean property to specify whether welcome file should be served immediately, or by redirect.
- Jetty:
redirectWelcome
boolean init parameter
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_DIR_LISTING
static final String PID_CFG_DEFAULT_SERVLET_DIR_LISTING
Boolean property to specify whether dir index should be present when accessing dir resource.
- Jetty:
dirAllowed
boolean init parameter - Tomcat:
listings
boolean init parameter - Undertow:
directory-listing
boolean init parameter
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRIES
static final String PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRIES
Integer property to specify maximum number of cache entries (per single resource manager).
- Jetty:
maxCachedFiles
integer init parameter - Tomcat: no such option (but there's default 5s TTL)
- Undertow: separate
io.undertow.server.handlers.cache.LRUCache#maxEntries
for metadata and "regions" + "slices" parameters inLimitedBufferSlicePool
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRY_SIZE
static final String PID_CFG_DEFAULT_SERVLET_CACHE_MAX_ENTRY_SIZE
Integer property to specify maximum size (kB) of single cache entry (file) (per single resource manager).
- Jetty:
maxCachedFileSize
integer init parameter - Tomcat:
org.apache.catalina.webresources.StandardRoot#setCacheObjectMaxSize()
(kB) - Undertow:
io.undertow.server.handlers.resource.CachingResourceManager#maxFileSize()
(B)
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_CACHE_MAX_TOTAL_SIZE
static final String PID_CFG_DEFAULT_SERVLET_CACHE_MAX_TOTAL_SIZE
Integer property to specify maximum total size (kB) of the cache (per single resource manager).
- Jetty:
maxCacheSize
boolean init parameter - Tomcat:
org.apache.catalina.webresources.StandardRoot#setCacheMaxSize()
(kB) - Undertow:
new LimitedBufferSlicePool(bufferAllocator, sliceSize, sliceSize * slicesPerPage, maxMemory / (sliceSize * slicesPerPage))
- See Also:
- Constant Field Values
- Jetty:
-
PID_CFG_DEFAULT_SERVLET_CACHE_TTL
static final String PID_CFG_DEFAULT_SERVLET_CACHE_TTL
Integer property to specify TTL for cache entries (ms)
- Jetty: no such option, entries are evicted by last access time
- Tomcat:
org.apache.catalina.webresources.StandardRoot#setCacheTtl(long)
(ms) - Undertow:
io.undertow.server.handlers.resource.CachingResourceManager#maxAge
andio.undertow.server.handlers.cache.LRUCache#maxAge
- See Also:
- Constant Field Values
-
PID_CFG_SHOW_STACKS
static final String PID_CFG_SHOW_STACKS
Boolean property to configure the container to show or hide stack traces in error handler.- See Also:
- Constant Field Values
-
PID_CFG_SESSION_TIMEOUT
static final String PID_CFG_SESSION_TIMEOUT
Integer property that specifies timeout of sessions in minutes (defaults to 30)- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_NAME
static final String PID_CFG_SESSION_COOKIE_NAME
String property that specifies session cookie name (defaults toJSESSIONID
)- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_DOMAIN
static final String PID_CFG_SESSION_COOKIE_DOMAIN
String property that specifies session cookie domain- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_PATH
static final String PID_CFG_SESSION_COOKIE_PATH
String property that specifies session cookie path (defaults to context path)- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_COMMENT
static final String PID_CFG_SESSION_COOKIE_COMMENT
String property that specifies session cookie comment- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_HTTP_ONLY
static final String PID_CFG_SESSION_COOKIE_HTTP_ONLY
Boolean property that specifies http only flag for session cookie. Defaults totrue
- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_SECURE
static final String PID_CFG_SESSION_COOKIE_SECURE
Boolean property that specifies secure flag for session cookie. Defaults tofalse
- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_MAX_AGE
static final String PID_CFG_SESSION_COOKIE_MAX_AGE
Integer property that specifies max age of session cookie- See Also:
- Constant Field Values
-
PID_CFG_SESSION_COOKIE_SAME_SITE
static final String PID_CFG_SESSION_COOKIE_SAME_SITE
String property that specifiesSameSite
attribute of session cookie- See Also:
- Constant Field Values
-
PID_CFG_SESSION_URL
static final String PID_CFG_SESSION_URL
For Jetty, we can specify the URL path parameter for session URL rewriting. Defauts tojsessionid
.- See Also:
- Constant Field Values
-
PID_CFG_SESSION_WORKER_NAME
static final String PID_CFG_SESSION_WORKER_NAME
Allows configuration of Jetty's SessionHandler.SessionIdManager.workerName- See Also:
- Constant Field Values
-
PID_CFG_SESSION_STORE_DIRECTORY
static final String PID_CFG_SESSION_STORE_DIRECTORY
When specified and is a valid directory location, file session persistence will be enabled- See Also:
- Constant Field Values
-
PID_CFG_JSP_SCRATCH_DIR
static final String PID_CFG_JSP_SCRATCH_DIR
Global Scratch directory for JSPs - by default it is relative to global tmp dir and depends on the context- See Also:
- Constant Field Values
-
PID_CFG_ENC_PROPERTY_PREFIX
static final String PID_CFG_ENC_PROPERTY_PREFIX
- See Also:
- Constant Field Values
-
PID_CFG_ENC_ENABLED
static final String PID_CFG_ENC_ENABLED
Boolean property that tells pax-web-runtime that the configuration may contain encrypted values. Defaults tofalse
.- See Also:
- Constant Field Values
-
PID_CFG_ENC_PREFIX
static final String PID_CFG_ENC_PREFIX
String property for the prefix for encrypted values. Defaults toENC(
- See Also:
- Constant Field Values
-
PID_CFG_ENC_SUFFIX
static final String PID_CFG_ENC_SUFFIX
String property for the suffix for encrypted values. Defaults to)
- See Also:
- Constant Field Values
-
PID_CFG_ENC_PROVIDER
static final String PID_CFG_ENC_PROVIDER
Provider name to use for PBE encryption - defaults toSunJCE
on Oracle/OpenJDK- See Also:
- Constant Field Values
-
PID_CFG_ENC_ALGORITHM
static final String PID_CFG_ENC_ALGORITHM
Algorithm name to use for PBE encryption - seeSecretKeyFactory.getInstance(java.lang.String)
defaults toPBEWithHmacSHA256AndAES_128
- See Also:
- Constant Field Values
-
PID_CFG_ENC_MASTERPASSWORD
static final String PID_CFG_ENC_MASTERPASSWORD
Plain text encryption password- See Also:
- Constant Field Values
-
PID_CFG_ENC_MASTERPASSWORD_ENV
static final String PID_CFG_ENC_MASTERPASSWORD_ENV
Environment variable to use for encryption password- See Also:
- Constant Field Values
-
PID_CFG_ENC_MASTERPASSWORD_SYS
static final String PID_CFG_ENC_MASTERPASSWORD_SYS
System property to use for encryption password- See Also:
- Constant Field Values
-
PID_CFG_ENC_ITERATION_COUNT
static final String PID_CFG_ENC_ITERATION_COUNT
IC parameter for PBE encryption - defaults to 1000- See Also:
- Constant Field Values
-
PID_CFG_ENC_OSGI_DECRYPTOR
static final String PID_CFG_ENC_OSGI_DECRYPTOR
Similarly to Pax JDBC/JMS, we can reference an OSGi service withobjectClass=org.jasypt.encryption.StringEncryptor
anddecryptor
properties. A filter is created to track the OSGi service used to decrypt configuration values.- See Also:
- Constant Field Values
-
-