com.sun.grizzly.config.dom.Http Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.grizzly.config.dom;
import com.sun.grizzly.util.http.MimeHeaders;
import com.sun.grizzly.util.http.Parameters;
import org.jvnet.hk2.component.Injectable;
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;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
/**
* Created Jan 8, 2009
*
* @author Justin Lee
*/
@Configured
public interface Http extends ConfigBeanProxy, Injectable, 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 = false;
boolean XPOWERED_BY = true;
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 = 2097152;
long MAX_SWALLOWING_INPUT_BYTES = -1;
int REQUEST_TIMEOUT = 900;
int SEND_BUFFER_LENGTH = 8192;
int TIMEOUT = 30;
int MAX_REQUEST_PARAMETERS = Parameters.DEFAULT_MAX_PARAMETERS;
int MAX_HEADERS = MimeHeaders.MAX_NUM_HEADERS_DEFAULT;
boolean PREALLOCATE_PROCESSOR_TASKS = false;
String COMPRESSABLE_MIME_TYPE = "text/html,text/xml,text/plain";
String COMPRESSION = "off";
String COMPRESSION_PATTERN = "on|off|force|\\d+";
String DEFAULT_ADAPTER = "com.sun.grizzly.tcp.StaticResourcesAdapter";
String URI_ENCODING = "UTF-8";
String VERSION = "HTTP/1.1";
String SCHEME_PATTERN = "http|https";
boolean BUFFER_RESPONSE_ENABLED = 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 bool);
@Attribute(defaultValue = "" + CHUNKING_ENABLED, dataType = Boolean.class)
String getChunkingEnabled();
void setChunkingEnabled(String enabled);
/**
* Enable comet support for this http instance. The default for this is 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 enable);
@Attribute(defaultValue = COMPRESSABLE_MIME_TYPE)
String getCompressableMimeType();
void setCompressableMimeType(String type);
@Attribute(defaultValue = COMPRESSION, dataType = String.class)
@Pattern(regexp = COMPRESSION_PATTERN)
String getCompression();
void setCompression(String compression);
@Attribute(defaultValue = "" + COMPRESSION_MIN_SIZE, dataType = Integer.class)
String getCompressionMinSizeBytes();
void setCompressionMinSizeBytes(String size);
@Attribute(defaultValue = "" + CONNECTION_UPLOAD_TIMEOUT, dataType = Integer.class)
String getConnectionUploadTimeoutMillis();
void setConnectionUploadTimeoutMillis(String timeout);
/**
* Setting the default response-type. Specified as a semi-colon delimited string consisting of content-type,
* encoding, language, charset
*/
@Deprecated
@Attribute
String getDefaultResponseType();
@Deprecated
void setDefaultResponseType(final String defaultResponseType);
/**
* The id attribute of the default virtual server for this particular connection group.
*/
@Attribute(required = true)
String getDefaultVirtualServer();
void setDefaultVirtualServer(final String defaultVirtualServer);
@Attribute(defaultValue = "" + DNS_LOOKUP_ENABLED, dataType = Boolean.class)
String getDnsLookupEnabled();
void setDnsLookupEnabled(String enable);
@Attribute(defaultValue = "" + ENCODED_SLASH_ENABLED, dataType = Boolean.class)
String getEncodedSlashEnabled();
void setEncodedSlashEnabled(String enabled);
/**
* Gets the value of the fileCache property.
*/
@Element
@NotNull
FileCache getFileCache();
void setFileCache(FileCache value);
/**
* The response type to be forced if the content served cannot be matched by any of the MIME mappings for
* extensions. Specified as a semi-colon delimited string consisting of content-type, encoding, language, charset
*/
@Deprecated
@Attribute()
String getForcedResponseType();
@Deprecated
void setForcedResponseType(final 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 length);
/**
* Max number of connection in the Keep Alive mode
*/
@Attribute(defaultValue = "" + MAX_CONNECTIONS, dataType = Integer.class)
String getMaxConnections();
void setMaxConnections(String max);
@Attribute(defaultValue = "" + MAX_POST_SIZE, dataType = Integer.class)
String getMaxPostSizeBytes();
void setMaxPostSizeBytes(String max);
@Attribute(defaultValue = "" + MAX_SWALLOWING_INPUT_BYTES, dataType = Integer.class)
String getMaxSwallowingInputBytes();
void setMaxSwallowingInputBytes(String max);
@Attribute(dataType = Integer.class)
String getNoCompressionUserAgents();
void setNoCompressionUserAgents(String agents);
@Attribute(defaultValue = "" + RCM_SUPPORT_ENABLED, dataType = Boolean.class)
String getRcmSupportEnabled();
void setRcmSupportEnabled(String enable);
/**
* if the connector is supporting non-SSL requests and a request is received for which a matching
* security-constraint requires SSL transport catalina will automatically redirect the request to the port number
* specified here
*/
@Attribute(dataType = Integer.class)
String getRedirectPort();
void setRedirectPort(final String redirectPort);
/**
* Time after which the request times out in seconds
*/
@Attribute(defaultValue = "" + REQUEST_TIMEOUT, dataType = Integer.class)
String getRequestTimeoutSeconds();
void setRequestTimeoutSeconds(String timeout);
@Attribute
String getRestrictedUserAgents();
void setRestrictedUserAgents(String agents);
/**
* Size of the buffer for response bodies in bytes
*/
@Attribute(defaultValue = "" + SEND_BUFFER_LENGTH, dataType = Integer.class)
String getSendBufferSizeBytes();
void setSendBufferSizeBytes(String size);
/**
* 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(final 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);
@Attribute(defaultValue = "" + TRACE_ENABLED, dataType = Boolean.class)
String getTraceEnabled();
void setTraceEnabled(String enabled);
@Attribute(defaultValue = "" + UPLOAD_TIMEOUT_ENABLED, dataType = Boolean.class)
String getUploadTimeoutEnabled();
void setUploadTimeoutEnabled(String disable);
@Attribute(defaultValue = URI_ENCODING)
String getUriEncoding();
void setUriEncoding(String encoding);
/**
* The version of the HTTP protocol used by the HTTP Service
*/
@Attribute(defaultValue = VERSION)
String getVersion();
void setVersion(final 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.
*
* @see com.sun.grizzly.tcp.Request#getRemoteUser()
*/
@Attribute
String getRemoteUserMapping();
void setRemoteUserMapping(final String remoteUserMapping);
@Attribute(defaultValue = "" + WEBSOCKET_SUPPORT_ENABLED, dataType = Boolean.class)
String getWebsocketsSupportEnabled();
void setWebsocketsSupportEnabled(String enabled);
/**
* Returns the maximum number of headers allowed for a request.
*/
@Attribute(defaultValue = "" + MAX_HEADERS, dataType = Integer.class)
String getMaxRequestHeaders();
void setMaxRequestHeaders(String maxRequestHeaders);
/**
* Returns the maximum number of headers allowed for a response.
*/
@Attribute(defaultValue = "" + MAX_HEADERS, dataType = Integer.class)
String getMaxResponseHeaders();
void setMaxResponseHeaders(String maxRequestHeaders);
/**
* The Servlet 2.4 spec defines a special 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 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 true, these headers will be
* added.
*/
@Attribute(defaultValue = "" + XPOWERED_BY, dataType = Boolean.class)
String getXpoweredBy();
void setXpoweredBy(final String xpoweredBy);
@Attribute(defaultValue = "" + PREALLOCATE_PROCESSOR_TASKS, dataType = Boolean.class)
String getPreallocateProcessorTasks();
void setPreallocateProcessorTasks(final String preallocate);
/**
* 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 1.9.54
*/
@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 1.9.54
*/
void setMaxRequestParameters();
/**
* @since 1.9.57
*/
@Attribute(defaultValue = "" + BUFFER_RESPONSE_ENABLED, dataType = Boolean.class)
String getBufferResponseEnabled();
/**
* @since 1.9.57
*/
void setBufferResponseEnabled();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy