Tomcat 10.1.19 · org.apache.catalina.connector.Connector

Field Summary

Modifier and Type	Field and Description
protected Adapter	adapter Coyote adapter.
protected boolean	allowBackslash If this is `true` the '\' character will be permitted as a path delimiter.
protected boolean	allowTrace Do we allow TRACE ?
protected long	asyncTimeout Default timeout for asynchronous requests (ms).
protected final String	configuredProtocol Name of the protocol that was configured.
protected boolean	discardFacades The flag that controls recycling of the facades of the request processing objects.
protected boolean	enableLookups The "enable DNS lookups" flag for this Connector.
private EncodedSolidusHandling	encodedSolidusHandling The behavior when an encoded solidus (slash) is submitted.
protected boolean	enforceEncodingInGetWriter If this is `true` then a call to `Response.getWriter()` if no character encoding has been specified will result in subsequent calls to `Response.getCharacterEncoding()` returning `ISO-8859-1` and the `Content-Type` response header will include a `charset=ISO-8859-1` component.
public static final String	INTERNAL_EXECUTOR_NAME
private static final Log	log Hides org.apache.catalina.util.LifecycleMBeanBase.log.
private int	maxCookieCount The maximum number of cookies permitted for a request.
protected int	maxParameterCount The maximum number of parameters (GET plus POST) which will be automatically parsed by the container.
protected int	maxPostSize Maximum size of a POST which will be automatically parsed by the container.
protected int	maxSavePostSize Maximum size of a POST which will be saved by the container during authentication.
protected String	parseBodyMethods Comma-separated list of HTTP methods that will be parsed according to POST-style rules for application/x-www-form-urlencoded request bodies.
protected HashSet<String>	parseBodyMethodsSet A Set of methods determined by `parseBodyMethods`.
protected final ProtocolHandler	protocolHandler Coyote protocol handler.
protected final String	protocolHandlerClassName Coyote Protocol handler class name.
protected String	proxyName The server name to which we should pretend requests to this Connector were directed.
protected int	proxyPort The server port to which we should pretend requests to this Connector were directed.
protected int	redirectPort The redirect port for non-SSL to SSL redirects.
private boolean	rejectSuspiciousURIs
protected String	scheme The request scheme that will be set on all requests received through this connector.
protected boolean	secure The secure connection flag that will be set on all requests received through this connector.
protected Service	service The `Service` we are associated with (if any).
protected static final StringManager	sm Hides org.apache.catalina.util.LifecycleMBeanBase.sm. The string manager for this package.
private Charset	uriCharset The URI encoding in use.
protected boolean	useBodyEncodingForURI URI encoding as body.
protected boolean	useIPVHosts Flag to use IP-based virtual hosting.
protected boolean	xpoweredBy Is generation of X-Powered-By response header enabled/disabled?

Constructor Summary

Access	Constructor and Description
public	Connector() Defaults to using HTTP/1.1 NIO implementation.
public	Connector(String protocol)
public	Connector(ProtocolHandler protocolHandler)

Method Summary

Modifier and Type	Method and Description
public void	addSslHostConfig(SSLHostConfig sslHostConfig)
public void	addUpgradeProtocol(UpgradeProtocol upgradeProtocol)
protected String	createObjectNameKeyProperties(String type)
public Request	Returns: a new Servlet request object createRequest() Create (or allocate) and return a Request object suitable for specifying the contents of a Request to the responsible Container.
public Response	Returns: a new Servlet response object createResponse() Create (or allocate) and return a Response object suitable for receiving the contents of a Response from the responsible Container.
protected void	destroyInternal() Overrides org.apache.catalina.util.LifecycleMBeanBase.destroyInternal. Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
public SSLHostConfig[]	findSslHostConfigs()
public UpgradeProtocol[]	findUpgradeProtocols()
public boolean	Returns: `true` if backslash characters are allowed in URLs. Default value is `false`. getAllowBackslash()
public boolean	Returns: `true` if the TRACE method is allowed. Default value is `false`. getAllowTrace()
public long	Returns: the default timeout for async requests in ms. getAsyncTimeout()
public boolean	Returns: `true` if the object facades are discarded, either when the discardFacades value is `true` or when the security manager is enabled. getDiscardFacades()
protected String	getDomainInternal() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getDomainInternal. Method implemented by sub-classes to identify the domain in which MBeans should be registered.
public boolean	Returns: the "enable DNS lookups" flag. getEnableLookups()
public String	getEncodedSolidusHandling()
public EncodedSolidusHandling	getEncodedSolidusHandlingInternal()
public boolean	Returns: `true` if a default character encoding will be set when calling Response.getWriter() getEnforceEncodingInGetWriter()
public String	getExecutorName()
public int	Returns: the port number on which this connector is listening to requests. If the special value for `getPort` of zero is used then this method will report the actual port bound. getLocalPort()
public int	getMaxCookieCount()
public int	Returns: the maximum number of parameters (GET plus POST) that will be automatically parsed by the container. A value of less than 0 means no limit. getMaxParameterCount()
public int	Returns: the maximum size of a POST which will be automatically parsed by the container. getMaxPostSize()
public int	Returns: the maximum size of a POST which will be saved by the container during authentication. getMaxSavePostSize()
protected String	getObjectNameKeyProperties() Implements abstract org.apache.catalina.util.LifecycleMBeanBase.getObjectNameKeyProperties. Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
public String	Returns: the HTTP methods which will support body parameters parsing getParseBodyMethods()
public int	Returns: the port number on which this connector is configured to listen for requests. The special value of 0 means select a random free port when the socket is bound. getPort()
public int	getPortOffset()
public int	getPortWithOffset()
public Object	Returns: the property value getProperty(String the property name name) Return a property from the protocol handler.
public String	Returns: the Coyote protocol handler in use. getProtocol()
public ProtocolHandler	Returns: the protocol handler associated with the connector. getProtocolHandler()
public String	Returns: the class name of the Coyote protocol handler in use. getProtocolHandlerClassName()
public String	Returns: the proxy server name for this Connector. getProxyName()
public int	Returns: the proxy server port for this Connector. getProxyPort()
public int	Returns: the port number to which a request should be redirected if it comes in on a non-SSL port and is subject to a security constraint with a transport guarantee that requires SSL. getRedirectPort()
public int	getRedirectPortWithOffset()
public boolean	getRejectSuspiciousURIs()
public String	Returns: the scheme that will be assigned to requests received through this connector. Default value is "http". getScheme()
public boolean	Returns: the secure connection flag that will be assigned to requests received through this connector. Default value is "false". getSecure()
public Service	Returns: the `Service` with which we are associated (if any). getService()
public Charset	Returns: The Charset to use to convert raw URI bytes (after %nn decoding) to characters. This will never be null getURICharset()
public String	Returns: the name of character encoding to be used for the URI using the original case. getURIEncoding()
public boolean	Returns: the true if the entity body encoding should be used for the URI. getUseBodyEncodingForURI()
public boolean	Returns: `true` if IP vhosts are enabled getUseIPVHosts() Test if IP-based virtual hosting is enabled.
public boolean	Returns: `true` if generation of X-Powered-By response header is enabled, false otherwise getXpoweredBy() Indicates whether the generation of an X-Powered-By response header for Servlet-generated responses is enabled or disabled for this Connector.
protected void	initInternal() Overrides org.apache.catalina.util.LifecycleMBeanBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
protected boolean	isParseBodyMethod(String method)
public void	pause() Pause the connector.
public void	resume() Resume the connector.
public void	setAllowBackslash(boolean the new flag value allowBackslash) Set the allowBackslash flag.
public void	setAllowTrace(boolean The new allowTrace flag allowTrace) Set the allowTrace flag, to disable or enable the TRACE HTTP method.
public void	setAsyncTimeout(long The new timeout in ms. asyncTimeout) Set the default timeout for async requests.
public void	setDiscardFacades(boolean the new value of the flag discardFacades) Set the recycling strategy for the object facades.
public void	setEnableLookups(boolean The new "enable DNS lookups" flag value enableLookups) Set the "enable DNS lookups" flag.
public void	setEncodedSolidusHandling(String encodedSolidusHandling)
public void	setEnforceEncodingInGetWriter(boolean the new flag value enforceEncodingInGetWriter) Set the enforceEncodingInGetWriter flag.
public void	setMaxCookieCount(int maxCookieCount)
public void	setMaxParameterCount(int The new setting maxParameterCount) Set the maximum number of parameters (GET plus POST) that will be automatically parsed by the container.
public void	setMaxPostSize(int The new maximum size in bytes of a POST which will be automatically parsed by the container maxPostSize) Set the maximum size of a POST which will be automatically parsed by the container.
public void	setMaxSavePostSize(int The new maximum size in bytes of a POST which will be saved by the container during authentication. maxSavePostSize) Set the maximum size of a POST which will be saved by the container during authentication.
public void	setParseBodyMethods(String Comma separated list of HTTP method names methods) Set list of HTTP methods which should allow body parameter parsing.
public void	setPort(int The new port number port) Set the port number on which we listen for requests.
public void	setPortOffset(int portOffset)
public boolean	Returns: `true` if the property was successfully set setProperty(String the property name name, String the property value value) Set a property on the protocol handler.
public void	setProxyName(String The new proxy server name proxyName) Set the proxy server name for this Connector.
public void	setProxyPort(int The new proxy server port proxyPort) Set the proxy server port for this Connector.
public void	setRedirectPort(int The redirect port number (non-SSL to SSL) redirectPort) Set the redirect port number.
public void	setRejectSuspiciousURIs(boolean rejectSuspiciousURIs)
public void	setScheme(String The new scheme scheme) Set the scheme that will be assigned to requests received through this connector.
public void	setSecure(boolean The new secure connection flag secure) Set the secure connection flag that will be assigned to requests received through this connector.
public void	setService(Service The service that owns this Engine service) Set the `Service` with which we are associated (if any).
public void	setURIEncoding(String The new URI character encoding. URIEncoding) Set the URI encoding to be used for the URI.
public void	setUseBodyEncodingForURI(boolean The new value for the flag. useBodyEncodingForURI) Set if the entity body encoding should be used for the URI.
public void	setUseIPVHosts(boolean `true` if Hosts are identified by IP, `false` if Hosts are identified by name. useIPVHosts) Enable the use of IP-based virtual hosting.
public void	setXpoweredBy(boolean true if generation of X-Powered-By response header is to be enabled, false otherwise xpoweredBy) Enables or disables the generation of an X-Powered-By header (with value Servlet/2.5) for all servlet-generated responses returned by this Connector.
protected void	startInternal() Implements abstract org.apache.catalina.util.LifecycleBase.startInternal. Begin processing requests via this Connector.
protected void	stopInternal() Implements abstract org.apache.catalina.util.LifecycleBase.stopInternal. Terminate processing requests via this Connector.
public String	toString() Overrides java.lang.Object.toString. Provide a useful toString() implementation as it may be used when logging Lifecycle errors to identify the component.

Inherited from org.apache.catalina.util.LifecycleMBeanBase:: getDomain getObjectName postDeregister postRegister preDeregister preRegister register setDomain unregister unregister

Field Detail

adapter	back to summary
protected Adapter adapter Coyote adapter.

allowBackslash	back to summary
protected boolean allowBackslash If this is `true` the '\' character will be permitted as a path delimiter. If not specified, the default value of `false` will be used.

allowTrace	back to summary
protected boolean allowTrace Do we allow TRACE ?

asyncTimeout	back to summary
protected long asyncTimeout Default timeout for asynchronous requests (ms).

configuredProtocol	back to summary
protected final String configuredProtocol Name of the protocol that was configured.

discardFacades	back to summary
protected boolean discardFacades The flag that controls recycling of the facades of the request processing objects. If set to `true` the object facades will be discarded when the request is recycled. If the security manager is enabled, this setting is ignored and object facades are always discarded.

enableLookups	back to summary
protected boolean enableLookups The "enable DNS lookups" flag for this Connector.

encodedSolidusHandling	back to summary
private EncodedSolidusHandling encodedSolidusHandling The behavior when an encoded solidus (slash) is submitted.

enforceEncodingInGetWriter back to summary

enforceEncodingInGetWriter	back to summary
protected boolean enforceEncodingInGetWriter If this is `true` then a call to `Response.getWriter()` if no character encoding has been specified will result in subsequent calls to `Response.getCharacterEncoding()` returning `ISO-8859-1` and the `Content-Type` response header will include a `charset=ISO-8859-1` component. (SRV.15.2.22.1) If not specified, the default specification compliant value of `true` will be used.

protected boolean enforceEncodingInGetWriter

If this is true then a call to Response.getWriter() if no character encoding has been specified will result in subsequent calls to Response.getCharacterEncoding() returning ISO-8859-1 and the Content-Type response header will include a charset=ISO-8859-1 component. (SRV.15.2.22.1) If not specified, the default specification compliant value of true will be used.

INTERNAL_EXECUTOR_NAME	back to summary
public static final String INTERNAL_EXECUTOR_NAME

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleMBeanBase.log.

maxCookieCount	back to summary
private int maxCookieCount The maximum number of cookies permitted for a request. Use a value less than zero for no limit. Defaults to 200.

maxParameterCount	back to summary
protected int maxParameterCount The maximum number of parameters (GET plus POST) which will be automatically parsed by the container. 10000 by default. The default Tomcat server.xml configures a lower default of 1000. A value of less than 0 means no limit.

maxPostSize	back to summary
protected int maxPostSize Maximum size of a POST which will be automatically parsed by the container. 2 MiB by default.

maxSavePostSize	back to summary
protected int maxSavePostSize Maximum size of a POST which will be saved by the container during authentication. 4 KiB by default

parseBodyMethods	back to summary
protected String parseBodyMethods Comma-separated list of HTTP methods that will be parsed according to POST-style rules for application/x-www-form-urlencoded request bodies.

parseBodyMethodsSet	back to summary
protected HashSet<String> parseBodyMethodsSet A Set of methods determined by `parseBodyMethods`.

protocolHandler	back to summary
protected final ProtocolHandler protocolHandler Coyote protocol handler.

protocolHandlerClassName	back to summary
protected final String protocolHandlerClassName Coyote Protocol handler class name. See `Connector()` for current default.

proxyName	back to summary
protected String proxyName The server name to which we should pretend requests to this Connector were directed. This is useful when operating Tomcat behind a proxy server, so that redirects get constructed accurately. If not specified, the server name included in the `Host` header is used.

proxyPort	back to summary
protected int proxyPort The server port to which we should pretend requests to this Connector were directed. This is useful when operating Tomcat behind a proxy server, so that redirects get constructed accurately. If not specified, the port number specified by the `port` property is used.

redirectPort	back to summary
protected int redirectPort The redirect port for non-SSL to SSL redirects.

rejectSuspiciousURIs	back to summary
private boolean rejectSuspiciousURIs

scheme	back to summary
protected String scheme The request scheme that will be set on all requests received through this connector.

secure	back to summary
protected boolean secure The secure connection flag that will be set on all requests received through this connector.

service	back to summary
protected Service service The `Service` we are associated with (if any).

sm	back to summary
protected static final StringManager sm Hides org.apache.catalina.util.LifecycleMBeanBase.sm. The string manager for this package.

public Class Connector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail