org.glassfish.grizzly.config.dom.Http Maven / Gradle / Ivy
/*
* Copyright (c) 2022, 2023 Contributors to the Eclipse Foundation
* Copyright (c) 2009, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.grizzly.config.dom;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import org.glassfish.grizzly.http.server.ServerFilterConfiguration;
import org.glassfish.grizzly.http.util.MimeHeaders;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.types.PropertyBag;
/**
* Created Jan 8, 2009
*
* @author Justin Lee
*/
@Configured
public interface Http extends ConfigBeanProxy, PropertyBag {
boolean AUTH_PASS_THROUGH_ENABLED = false;
boolean CHUNKING_ENABLED = true;
boolean COMET_SUPPORT_ENABLED = false;
boolean ENCODED_SLASH_ENABLED = false;
boolean DNS_LOOKUP_ENABLED = false;
boolean RCM_SUPPORT_ENABLED = false;
boolean TIMEOUT_ENABLED = true;
boolean TRACE_ENABLED = false;
boolean UPLOAD_TIMEOUT_ENABLED = true;
boolean WEBSOCKET_SUPPORT_ENABLED = true;
boolean XPOWERED_BY = true;
boolean ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS = false;
int COMPRESSION_MIN_SIZE = 2048;
int CONNECTION_UPLOAD_TIMEOUT = 300000;
int HEADER_BUFFER_LENGTH = 8192;
int KEEP_ALIVE_TIMEOUT = 30;
int MAX_CONNECTIONS = 256;
int MAX_POST_SIZE = -1;
int MAX_FORM_POST_SIZE = 2097152;
int MAX_SAVE_POST_SIZE = 4 * 1024;
long MAX_SWALLOWING_INPUT_BYTES = -1;
int REQUEST_TIMEOUT = 900;
int SEND_BUFFER_LENGTH = 8192;
int TIMEOUT = 30;
int WEBSOCKETS_TIMEOUT = 15 * 60;
int MAX_REQUEST_PARAMETERS = ServerFilterConfiguration.MAX_REQUEST_PARAMETERS;
int MAX_HEADERS = MimeHeaders.MAX_NUM_HEADERS_DEFAULT;
String COMPRESSABLE_MIME_TYPE = "text/html,text/xml,text/plain";
String COMPRESSION = "off";
String COMPRESSION_PATTERN = "on|off|force|\\d+";
String DEFAULT_ADAPTER = "org.glassfish.grizzly.http.server.StaticHttpHandler";
String URI_ENCODING = "UTF-8";
String VERSION = "HTTP/1.1";
String SCHEME_PATTERN = "http|https";
// HTTP2 properties
boolean HTTP2_ENABLED = true;
int MAX_CONCURRENT_STREAMS = 100;
int INITIAL_WINDOW_SIZE_IN_BYTES = 64 * 1024 - 1;
int MAX_FRAME_PAYLOAD_SIZE_IN_BYTES = (1 << 24) - 1;
int MAX_HEADER_LIST_SIZE_IN_BYTES = 4096;
boolean DISABLE_CIPHER_CHECK = false;
@Attribute(defaultValue = DEFAULT_ADAPTER)
String getAdapter();
void setAdapter(String adapter);
/**
* Enable pass through of authentication from any front-end server.
*/
@Attribute(defaultValue = "" + AUTH_PASS_THROUGH_ENABLED, dataType = Boolean.class)
String getAuthPassThroughEnabled();
void setAuthPassThroughEnabled(String authPassThroughEnabled);
@Attribute(defaultValue = "" + CHUNKING_ENABLED, dataType = Boolean.class)
String getChunkingEnabled();
void setChunkingEnabled(String chunkingEnabled);
/**
* Enable comet support for this http instance.
*
* The default for this is {@code false} until enabling comet support but not
* using it can be verified as harmless.
*
*
Currently it is unclear what the performance impact of enabling this feature is.
*/
@Attribute(defaultValue = "" + COMET_SUPPORT_ENABLED, dataType = Boolean.class)
String getCometSupportEnabled();
void setCometSupportEnabled(String cometSupportEnabled);
@Attribute(defaultValue = COMPRESSABLE_MIME_TYPE)
String getCompressableMimeType();
void setCompressableMimeType(String mimeType);
@Attribute(defaultValue = COMPRESSION)
@Pattern(regexp = COMPRESSION_PATTERN, message = "Pattern: " + COMPRESSION_PATTERN)
String getCompression();
void setCompression(String compression);
@Attribute(defaultValue = "" + COMPRESSION_MIN_SIZE, dataType = Integer.class)
String getCompressionMinSizeBytes();
void setCompressionMinSizeBytes(String compressionMinSize);
@Attribute(defaultValue = "" + CONNECTION_UPLOAD_TIMEOUT, dataType = Integer.class)
String getConnectionUploadTimeoutMillis();
void setConnectionUploadTimeoutMillis(String uploadTimeout);
/**
* Setting the default {@code response-type}.
*
*
Specified as a semicolon delimited string consisting of content-type,
* encoding, language, charset
*/
@Attribute
String getDefaultResponseType();
void setDefaultResponseType(String defaultResponseType);
/**
* The id attribute of the default virtual server for this particular connection group.
*/
@Attribute(required = true)
String getDefaultVirtualServer();
void setDefaultVirtualServer(String defaultVirtualServer);
@Attribute(defaultValue = "" + DNS_LOOKUP_ENABLED, dataType = Boolean.class)
String getDnsLookupEnabled();
void setDnsLookupEnabled(String dnsLookupEnabled);
@Attribute(defaultValue = "" + ENCODED_SLASH_ENABLED, dataType = Boolean.class)
String getEncodedSlashEnabled();
void setEncodedSlashEnabled(String encodedSlashEnabled);
/**
* Gets the value of the {@code fileCache} property.
*/
@Element
@NotNull
FileCache getFileCache();
void setFileCache(FileCache fileCache);
/**
* The response type to be forced if the content served cannot be matched by
* any of the MIME mappings for extensions. Specified as a semicolon
* delimited string consisting of content-type, encoding, language, charset.
*/
@Deprecated
@Attribute()
String getForcedResponseType();
@Deprecated
void setForcedResponseType(String forcedResponseType);
/**
* The size of the buffer used by the request processing threads for reading
* the request data.
*/
@Attribute(defaultValue = "" + HEADER_BUFFER_LENGTH, dataType = Integer.class)
String getHeaderBufferLengthBytes();
void setHeaderBufferLengthBytes(String headerBufferLength);
/**
* Max number of connection in the Keep Alive mode.
*/
@Attribute(defaultValue = "" + MAX_CONNECTIONS, dataType = Integer.class)
String getMaxConnections();
void setMaxConnections(String maxConnections);
@Attribute(defaultValue = "" + MAX_FORM_POST_SIZE, dataType = Integer.class)
String getMaxFormPostSizeBytes();
void setMaxFormPostSizeBytes(String maxFormPostSize);
@Attribute(defaultValue = "" + MAX_POST_SIZE, dataType = Integer.class)
String getMaxPostSizeBytes();
void setMaxPostSizeBytes(String maxPostSize);
@Attribute(defaultValue = "" + MAX_SAVE_POST_SIZE, dataType = Integer.class)
String getMaxSavePostSizeBytes();
void setMaxSavePostSizeBytes(String maxSavePostSize);
@Attribute(defaultValue = "" + MAX_SWALLOWING_INPUT_BYTES, dataType = Integer.class)
String getMaxSwallowingInputBytes();
void setMaxSwallowingInputBytes(String maxSwallowingInput);
@Attribute(dataType = Integer.class)
String getNoCompressionUserAgents();
void setNoCompressionUserAgents(String noCompressionUserAgents);
@Attribute(defaultValue = "" + RCM_SUPPORT_ENABLED, dataType = Boolean.class)
@Deprecated
String getRcmSupportEnabled();
void setRcmSupportEnabled(String rcmSupportEnabled);
/**
* If the connector is supporting non-SSL requests and a request is received
* for which a matching security-constraint requires SSL transport {@code catalina}
* will automatically redirect the request to the port number specified here.
*/
@Attribute(dataType = Integer.class)
@Range(max = 65535)
String getRedirectPort();
void setRedirectPort(String redirectPort);
/**
* Time after which the request times out in seconds.
*/
@Attribute(defaultValue = "" + REQUEST_TIMEOUT, dataType = Integer.class)
String getRequestTimeoutSeconds();
void setRequestTimeoutSeconds(String requestTimeout);
@Attribute
String getRestrictedUserAgents();
void setRestrictedUserAgents(String restrictedUserAgents);
/**
* Size of the buffer for response bodies in bytes.
*/
@Attribute(defaultValue = "" + SEND_BUFFER_LENGTH, dataType = Integer.class)
String getSendBufferSizeBytes();
void setSendBufferSizeBytes(String sendBufferSize);
/**
* Tells the server what to put in the host name section of any URLs it sends
* to the client. This affects URLs the server automatically generates; it doesn't
* affect the URLs for directories and files stored in the server. This name
* should be the alias name if your server uses an alias. If you append a colon
* and port number, that port will be used in URLs the server sends to the client.
*/
@Attribute
String getServerName();
void setServerName(String serverName);
/**
* Keep Alive timeout.
*
*
Max time a connection can be deemed as idle and kept in the keep-alive state.
*/
@Attribute(defaultValue = "" + TIMEOUT, dataType = Integer.class)
String getTimeoutSeconds();
void setTimeoutSeconds(String timeout);
/**
* Max time a connection may be idle before being closed.
*
* @since 2.1.5
*/
@Attribute(defaultValue = "" + WEBSOCKETS_TIMEOUT, dataType = Integer.class)
String getWebsocketsTimeoutSeconds();
void setWebsocketsTimeoutSeconds(String websocketsTimeout);
@Attribute(defaultValue = "" + TRACE_ENABLED, dataType = Boolean.class)
String getTraceEnabled();
void setTraceEnabled(String traceEnabled);
@Attribute(defaultValue = "" + UPLOAD_TIMEOUT_ENABLED, dataType = Boolean.class)
String getUploadTimeoutEnabled();
void setUploadTimeoutEnabled(String uploadTimeoutEnabled);
@Attribute(defaultValue = URI_ENCODING)
String getUriEncoding();
void setUriEncoding(String uriEncoding);
/**
* The {@code version} of the HTTP protocol used by the HTTP Service.
*/
@Attribute(defaultValue = VERSION)
String getVersion();
void setVersion(String version);
/**
* The HTTP scheme (http or https) to override HTTP request scheme picked up
* by Grizzly or web-container during HTTP request processing.
*/
@Attribute
@Pattern(regexp = SCHEME_PATTERN)
String getScheme();
void setScheme(final String scheme);
/**
* Returns the HTTP request header name, whose value (if non-null) would be used
* to override default protocol scheme picked up by framework during
* request processing.
*/
@Attribute
String getSchemeMapping();
void setSchemeMapping(final String schemeMapping);
/**
* Returns the HTTP request header name, whose value (if non-null) would be used
* to set the name of the remote user that has been authenticated for HTTP Request.
*/
@Attribute
String getRemoteUserMapping();
void setRemoteUserMapping(final String remoteUserMapping);
@Attribute(defaultValue = "" + WEBSOCKET_SUPPORT_ENABLED, dataType = Boolean.class)
String getWebsocketsSupportEnabled();
void setWebsocketsSupportEnabled(String websocketsSupportEnabled);
@Attribute(defaultValue = NetworkListener.DEFAULT_CONFIGURATION_FILE)
String getJkConfigurationFile();
void setJkConfigurationFile(String configFile);
/**
* If {@code true}, a jk listener is enabled.
*/
@Attribute(dataType = Boolean.class)
String getJkEnabled();
void setJkEnabled(String jkEnabled);
/**
* Returns the maximum number of parameters allowed per request.
*
*
If the value less than zero, then there will be no limit on parameters.
*
*
If not explicitly configured, this returns {@value #MAX_REQUEST_PARAMETERS}.
*
* @return the maximum number of parameters or {@value #MAX_REQUEST_PARAMETERS}
* if not explicitly configured.
*
* @since 2.2.8
*/
@Attribute(defaultValue = "" + MAX_REQUEST_PARAMETERS, dataType = Integer.class)
String getMaxRequestParameters();
/**
* Sets the maximum number of parameters allowed for a request.
*
*
If the value is zero or less, then there will be no limit on parameters.
*
* @since 2.2.8
*/
void setMaxRequestParameters();
/**
* Returns the maximum number of headers allowed for a request.
*
* @since 2.2.11
*/
@Attribute(defaultValue = "" + MAX_HEADERS, dataType = Integer.class)
String getMaxRequestHeaders();
void setMaxRequestHeaders(String maxRequestHeaders);
/**
* Returns the maximum number of headers allowed for a response.
*
* @since 2.2.11
*/
@Attribute(defaultValue = "" + MAX_HEADERS, dataType = Integer.class)
String getMaxResponseHeaders();
void setMaxResponseHeaders(String maxRequestHeaders);
/**
* The Servlet 2.4 spec defines a special {@code X-Powered-By: Servlet/2.4} header,
* which containers may add to servlet-generated responses. This is complemented
* by the JSP 2.0 spec, which defines a {@code X-Powered-By: JSP/2.0} header
* to be added (on an optional basis) to responses utilizing JSP technology. The goal
* of these headers is to aid in gathering statistical data about the use of Servlet
* and JSP technology. If {@code true}, these headers will be added.
*/
@Attribute(defaultValue = "" + XPOWERED_BY, dataType = Boolean.class)
String getXpoweredBy();
void setXpoweredBy(String xpoweredBy);
/**
* @return {@code true}, if payload will be allowed for HTTP methods, for
* which spec doesn't state explicitly if payload allowed or not.
*
* @since 4.2
*/
@Attribute(defaultValue = "" + ALLOW_PAYLOAD_FOR_UNDEFINED_HTTP_METHODS, dataType = Boolean.class)
String getAllowPayloadForUndefinedHttpMethods();
void setAllowPayloadForUndefinedHttpMethods(String allowPayload);
// ---------------------------------------------------- HTTP2 CONFIGURATION
/**
* Configures the number of concurrent streams allowed per HTTP2 connection.
* The default is {@code 100}.
*/
@Attribute(defaultValue = "" + MAX_CONCURRENT_STREAMS, dataType = Integer.class)
int getHttp2MaxConcurrentStreams();
void setHttp2MaxConcurrentStreams(int maxConcurrentStreams);
/**
* Configures the initial window size in bytes. The default is {@code 64K - 1}.
*/
@Attribute(defaultValue = "" + INITIAL_WINDOW_SIZE_IN_BYTES, dataType = Integer.class)
int getHttp2InitialWindowSizeInBytes();
void setHttp2InitialWindowSizeInBytes(int initialWindowSize);
/**
* Configures the maximum size of the HTTP2 frame payload to be accepted.
* The default is {@code 2^24 - 1}.
*/
@Attribute(defaultValue = "" + MAX_FRAME_PAYLOAD_SIZE_IN_BYTES, dataType = Integer.class)
int getHttp2MaxFramePayloadSizeInBytes();
void setHttp2MaxFramePayloadSizeInBytes(int maxFramePayloadSize);
/**
* Configures the maximum size, in bytes, of the header list.
*/
@Attribute(defaultValue = "" + MAX_HEADER_LIST_SIZE_IN_BYTES, dataType = Integer.class)
int getHttp2MaxHeaderListSizeInBytes();
void setHttp2MaxHeaderListSizeInBytes(int maxHeaderListSize);
/**
* Controls whether or not insecure cipher suites are allowed to establish TLS connections.
*/
@Attribute(defaultValue = "" + DISABLE_CIPHER_CHECK, dataType = Boolean.class)
boolean isHttp2DisableCipherCheck();
void setHttp2DisableCipherCheck(boolean disableCipherCheck);
/**
* Controls whether or not HTTP/2 is enabled.
*/
@Attribute(defaultValue = "" + HTTP2_ENABLED, dataType = Boolean.class)
boolean isHttp2Enabled();
void setHttp2Enabled(boolean http2Enabled);
@Override
default Protocol getParent() {
return getParent(Protocol.class);
}
}