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

Modifier and Type	Class and Description
private static class	CoyoteAdapter.RecycleRequiredException

Modifier and Type	Field and Description
public static final int	ADAPTER_NOTES
private final Connector	connector The CoyoteConnector with which this processor is associated.
private static final Log	log
private static final String	POWERED_BY
protected static final StringManager	sm The string manager for this package.
private static final EnumSet<SessionTrackingMode>	SSL_ONLY

Access	Constructor and Description
public	CoyoteAdapter(Connector CoyoteConnector that owns this processor connector) Construct a new CoyoteProcessor associated with the specified connector.

Method Summary

Modifier and Type	Method and Description
public boolean	asyncDispatch(Request req, Response res, SocketEvent status) Implements org.apache.coyote.Adapter.asyncDispatch.
public void	checkRecycled(Request Request req, Response Response res) Implements org.apache.coyote.Adapter.checkRecycled. Assert that request and response have been recycled.
private static boolean	checkSuspiciousURIs(ByteChunk undecodedURI)
protected void	convertMB(MessageBytes The MessageBytes instance containing the bytes that should be converted to chars mb) Character conversion of the a US-ASCII MessageBytes.
protected void	convertURI(MessageBytes MessageBytes object containing the URI uri, Request The Servlet request object request) Character conversion of the URI.
protected static void	copyBytes(byte[] The bytes that should be copied b, int Destination offset dest, int Source offset src, int Length len) Copy an array of bytes to a different position.
private void	doConnectorAuthenticationAuthorization(Request req, Request request)
public String	getDomain() Implements org.apache.coyote.Adapter.getDomain. Provide the name of the domain to use to register MBeans for components associated with the connector.
public void	log(Request req, Response res, long time) Implements org.apache.coyote.Adapter.log.
public static boolean	Returns: `false` if normalizing this URI would require going above the root, or if the URI contains a null byte, otherwise `true` normalize(MessageBytes URI to be normalized uriMB, boolean `true` if backslash characters are allowed in URLs allowBackslash) This method normalizes "\", "//", "/./" and "/../".
protected void	parsePathParameters(Request The Coyote request object req, Request The Servlet request object request) Extract the path parameters from the request.
protected void	parseSessionCookiesId(Request The Servlet request object request) Parse session id in Cookie.
protected void	parseSessionSslId(Request The Servlet request object request) Look for SSL session ID if required.
protected boolean	Returns: `true` if the request should be passed on to the start of the container pipeline, otherwise `false` postParseRequest(Request The coyote request object req, Request The catalina request object request, Response The coyote response object res, Response The catalina response object response) Perform the necessary processing after the HTTP headers have been parsed to enable the request/response pair to be passed to the start of the container pipeline for processing.
public boolean	prepare(Request The request object req, Response The response object res) Implements org.apache.coyote.Adapter.prepare. Prepare the given request/response for processing.
public void	service(Request The request object req, Response The response object res) Implements org.apache.coyote.Adapter.service. Call the service method, and notify all listeners
private void	updateWrapperErrorCount(Request request, Response response)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ADAPTER_NOTES	back to summary
public static final int ADAPTER_NOTES

connector	back to summary
private final Connector connector The CoyoteConnector with which this processor is associated.

log	back to summary
private static final Log log

POWERED_BY	back to summary
private static final String POWERED_BY

sm	back to summary
protected static final StringManager sm The string manager for this package.

SSL_ONLY	back to summary
private static final EnumSet<SessionTrackingMode> SSL_ONLY

CoyoteAdapter	back to summary
public CoyoteAdapter(Connector connector) Construct a new CoyoteProcessor associated with the specified connector. Parameters connector:Connector CoyoteConnector that owns this processor

Method Detail

asyncDispatch	back to summary
public boolean asyncDispatch(Request req, Response res, SocketEvent status) throws Exception Implements org.apache.coyote.Adapter.asyncDispatch. Annotations @Override

asyncDispatch

back to summary

public boolean asyncDispatch(Request req, Response res, SocketEvent status) throws Exception

Implements org.apache.coyote.Adapter.asyncDispatch.

Annotations

@Override

checkRecycled	back to summary
public void checkRecycled(Request req, Response res) Implements org.apache.coyote.Adapter.checkRecycled. Doc from org.apache.coyote.Adapter.checkRecycled. Assert that request and response have been recycled. If they have not then log a warning and force a recycle. This method is called as a safety check when a processor is being recycled and may be returned to a pool for reuse. Parameters req:Request Request res:Response Response Annotations @Override

checkRecycled

back to summary

public void checkRecycled(Request req, Response res)

Implements org.apache.coyote.Adapter.checkRecycled.

Doc from org.apache.coyote.Adapter.checkRecycled.

Assert that request and response have been recycled. If they have not then log a warning and force a recycle. This method is called as a safety check when a processor is being recycled and may be returned to a pool for reuse.

Parameters

req:Request: Request
res:Response: Response

Annotations

@Override

checkSuspiciousURIs	back to summary
private static boolean checkSuspiciousURIs(ByteChunk undecodedURI)

convertMB	back to summary
protected void convertMB(MessageBytes mb) Character conversion of the a US-ASCII MessageBytes. Parameters mb:MessageBytes The MessageBytes instance containing the bytes that should be converted to chars

convertMB

back to summary

protected void convertMB(MessageBytes mb)

Character conversion of the a US-ASCII MessageBytes.

Parameters

mb:MessageBytes: The MessageBytes instance containing the bytes that should be converted to chars

convertURI	back to summary
protected void convertURI(MessageBytes uri, Request request) throws IOException Character conversion of the URI. Parameters uri:MessageBytes MessageBytes object containing the URI request:Request The Servlet request object Exceptions IOException: if a IO exception occurs sending an error to the client

convertURI

back to summary

protected void convertURI(MessageBytes uri, Request request) throws IOException

Character conversion of the URI.

Parameters

uri:MessageBytes: MessageBytes object containing the URI
request:Request: The Servlet request object

Exceptions

IOException:: if a IO exception occurs sending an error to the client

copyBytes	back to summary
protected static void copyBytes(byte[] b, int dest, int src, int len) Copy an array of bytes to a different position. Used during normalization. Parameters b:byte[] The bytes that should be copied dest:int Destination offset src:int Source offset len:int Length

copyBytes

back to summary

protected static void copyBytes(byte[] b, int dest, int src, int len)

Copy an array of bytes to a different position. Used during normalization.

Parameters

b:byte[]: The bytes that should be copied
dest:int: Destination offset
src:int: Source offset
len:int: Length

doConnectorAuthenticationAuthorization	back to summary
private void doConnectorAuthenticationAuthorization(Request req, Request request)

getDomain	back to summary
public String getDomain() Implements org.apache.coyote.Adapter.getDomain. Doc from org.apache.coyote.Adapter.getDomain. Provide the name of the domain to use to register MBeans for components associated with the connector. Returns:String The MBean domain name Annotations @Override

getDomain

back to summary

public String getDomain()

Implements org.apache.coyote.Adapter.getDomain.

Doc from org.apache.coyote.Adapter.getDomain.

Provide the name of the domain to use to register MBeans for components associated with the connector.

Returns:String

The MBean domain name

Annotations

@Override

log	back to summary
public void log(Request req, Response res, long time) Implements org.apache.coyote.Adapter.log. Annotations @Override

log

back to summary

public void log(Request req, Response res, long time)

Implements org.apache.coyote.Adapter.log.

Annotations

@Override

normalize back to summary

normalize	back to summary
public static boolean normalize(MessageBytes uriMB, boolean allowBackslash) This method normalizes "\", "//", "/./" and "/../". Parameters uriMB:MessageBytes URI to be normalized allowBackslash:boolean `true` if backslash characters are allowed in URLs Returns:boolean `false` if normalizing this URI would require going above the root, or if the URI contains a null byte, otherwise `true`

public static boolean normalize(MessageBytes uriMB, boolean allowBackslash)

This method normalizes "\", "//", "/./" and "/../".

Parameters

uriMB:MessageBytes: URI to be normalized
allowBackslash:boolean: true if backslash characters are allowed in URLs

Returns:boolean

false if normalizing this URI would require going above the root, or if the URI contains a null byte, otherwise true

parsePathParameters	back to summary
protected void parsePathParameters(Request req, Request request) Extract the path parameters from the request. This assumes parameters are of the form /path;name=value;name2=value2/ etc. Currently only really interested in the session ID that will be in this form. Other parameters can safely be ignored. Parameters req:Request The Coyote request object request:Request The Servlet request object

parsePathParameters

back to summary

protected void parsePathParameters(Request req, Request request)

Extract the path parameters from the request. This assumes parameters are of the form /path;name=value;name2=value2/ etc. Currently only really interested in the session ID that will be in this form. Other parameters can safely be ignored.

Parameters

req:Request: The Coyote request object
request:Request: The Servlet request object

parseSessionCookiesId

back to summary

protected void parseSessionCookiesId(Request request)

Parse session id in Cookie.

Parameters

request:Request: The Servlet request object

parseSessionSslId	back to summary
protected void parseSessionSslId(Request request) Look for SSL session ID if required. Only look for SSL Session ID if it is the only tracking method enabled. Parameters request:Request The Servlet request object

parseSessionSslId

back to summary

protected void parseSessionSslId(Request request)

Look for SSL session ID if required. Only look for SSL Session ID if it is the only tracking method enabled.

Parameters

request:Request: The Servlet request object

postParseRequest back to summary

postParseRequest	back to summary
protected boolean postParseRequest(Request req, Request request, Response res, Response response) throws IOException, ServletException Perform the necessary processing after the HTTP headers have been parsed to enable the request/response pair to be passed to the start of the container pipeline for processing. Parameters req:Request The coyote request object request:Request The catalina request object res:Response The coyote response object response:Response The catalina response object Returns:boolean `true` if the request should be passed on to the start of the container pipeline, otherwise `false` Annotations @SuppressWarnings:deprecation Exceptions IOException: If there is insufficient space in a buffer while processing headers ServletException: If the supported methods of the target servlet cannot be determined

protected boolean postParseRequest(Request req, Request request, Response res, Response response) throws IOException, ServletException

Perform the necessary processing after the HTTP headers have been parsed to enable the request/response pair to be passed to the start of the container pipeline for processing.

Parameters

req:Request: The coyote request object
request:Request: The catalina request object
res:Response: The coyote response object
response:Response: The catalina response object

Returns:boolean

true if the request should be passed on to the start of the container pipeline, otherwise false

Annotations

@SuppressWarnings:deprecation

Exceptions

IOException:: If there is insufficient space in a buffer while processing headers
ServletException:: If the supported methods of the target servlet cannot be determined

prepare back to summary

prepare	back to summary
public boolean prepare(Request req, Response res) throws IOException, ServletException Implements org.apache.coyote.Adapter.prepare. Doc from org.apache.coyote.Adapter.prepare. Prepare the given request/response for processing. This method requires that the request object has been populated with the information available from the HTTP headers. Parameters req:Request The request object res:Response The response object Returns:boolean `true` if processing can continue, otherwise `false` in which case an appropriate error will have been set on the response Annotations @Override

public boolean prepare(Request req, Response res) throws IOException, ServletException

Implements org.apache.coyote.Adapter.prepare.

Doc from org.apache.coyote.Adapter.prepare.

Prepare the given request/response for processing. This method requires that the request object has been populated with the information available from the HTTP headers.

Parameters

req:Request: The request object
res:Response: The response object

Returns:boolean

true if processing can continue, otherwise false in which case an appropriate error will have been set on the response

Annotations

@Override

service	back to summary
public void service(Request req, Response res) throws Exception Implements org.apache.coyote.Adapter.service. Doc from org.apache.coyote.Adapter.service. Call the service method, and notify all listeners Parameters req:Request The request object res:Response The response object Annotations @Override Exceptions Exception: if an error happens during handling of the request. Common errors are: IOException if an input/output error occurs and we are processing an included servlet (otherwise it is swallowed and handled by the top level error handler mechanism) ServletException if a servlet throws an exception and we are processing an included servlet (otherwise it is swallowed and handled by the top level error handler mechanism) Tomcat should be able to handle and log any other exception ( including runtime exceptions )

service

back to summary

public void service(Request req, Response res) throws Exception

Implements org.apache.coyote.Adapter.service.

Doc from org.apache.coyote.Adapter.service.

Call the service method, and notify all listeners

Parameters

req:Request: The request object
res:Response: The response object

Annotations

@Override

Exceptions

Exception:

if an error happens during handling of the request. Common errors are:

IOException if an input/output error occurs and we are processing an included servlet (otherwise it is swallowed and handled by the top level error handler mechanism)
ServletException if a servlet throws an exception and we are processing an included servlet (otherwise it is swallowed and handled by the top level error handler mechanism)

Tomcat should be able to handle and log any other exception ( including runtime exceptions )

updateWrapperErrorCount	back to summary
private void updateWrapperErrorCount(Request request, Response response)

public Class CoyoteAdapter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CoyoteAdapter.RecycleRequiredException

Field Summary

Constructor Summary

Field Detail

Constructor Detail