Tomcat 10.1.19 · org.apache.coyote.Request · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final AtomicBoolean	allDataReadEventSent
private final HashMap<String, Object>	attributes
private final MessageBytes	authType
private int	available
private long	bytesRead
private String	characterEncoding
private Charset	charset
private long	contentLength HTTP specific fields.
private MessageBytes	contentTypeMB
private final MessageBytes	decodedUriMB
private Exception	errorException Holds request body reading error exception.
private boolean	expectation Is there an expectation ?
private boolean	fireListener
private final MimeHeaders	headers
private volatile ActionHook	hook
private static final int	INITIAL_COOKIE_SIZE
private InputBuffer	inputBuffer Associated input buffer.
pack-priv volatile ReadListener	listener
private final MessageBytes	localAddrMB
private final MessageBytes	localNameMB
private int	localPort
private final MessageBytes	methodMB
private final Object	nonBlockingStateLock
private final Object[]	notes Notes.
private final Parameters	parameters
private final Map<String, String>	pathParameters Path parameters
private final MessageBytes	peerAddrMB
private final MessageBytes	protoMB
private final MessageBytes	queryMB
private boolean	registeredForRead
private final MessageBytes	remoteAddrMB
private final MessageBytes	remoteHostMB
private int	remotePort
private final MessageBytes	remoteUser
private boolean	remoteUserNeedsAuthorization
private final RequestInfo	reqProcessorMX
private volatile String	requestId
private static final AtomicLong	requestIdGenerator
private Response	response
private final MessageBytes	schemeMB
private boolean	sendfile
private final ServerCookies	serverCookies
private final MessageBytes	serverNameMB
private int	serverPort
private static final StringManager	sm
private long	startTimeNanos
private long	threadId
private final Map<String, String>	trailerFields
private final MessageBytes	uriMB
private final UDecoder	urlDecoder URL decoder.

Constructor Summary

Access	Constructor and Description
public	Request()

Method Summary

Modifier and Type	Method and Description
public void	action(ActionCode actionCode, Object param)
public void	addPathParameter(String name, String value)
private boolean	checkRegisterForRead()
public void	clearRequestThread()
public MessageBytes	contentType()
public MessageBytes	decodedURI()
public int	Returns: The number of bytes copied doRead(ApplicationBufferHandler The destination to which to copy the data handler) Read data from the input buffer and put it into ApplicationBufferHandler.
public Object	getAttribute(String name)
public HashMap<String, Object>	getAttributes()
public MessageBytes	getAuthType()
public int	getAvailable()
public long	getBytesRead()
public String	Returns: The value set via `setCharset(Charset)` or if no call has been made to that method try to obtain if from the content type. getCharacterEncoding() Get the character encoding used for this request.
public Charset	Returns: The value set via `setCharset(Charset)` or if no call has been made to that method try to obtain if from the content type. getCharset() Get the character encoding used for this request.
private static String	getCharsetFromContentType(String a content type header contentType) Parse the character encoding from the specified content type header.
public int	getContentLength()
public long	getContentLengthLong()
public String	getContentType()
public ServerCookies	getCookies()
public Exception	Returns: The exception that occurred getErrorException() Get the Exception that occurred during the writing of the response.
public String	getHeader(String name)
public InputBuffer	getInputBuffer()
public int	getLocalPort()
public MimeHeaders	getMimeHeaders()
public Object	getNote(int pos)
public Parameters	getParameters()
public String	getPathParameter(String name)
public String	getProtocolRequestId()
public ReadListener	getReadListener()
public int	getRemotePort()
public MessageBytes	getRemoteUser()
public boolean	getRemoteUserNeedsAuthorization()
public String	getRequestId()
public RequestInfo	getRequestProcessor()
public Response	getResponse()
public boolean	getSendfile()
public int	getServerPort()
public ServletConnection	getServletConnection()
public long	getStartTime()
public long	getStartTimeNanos()
public boolean	getSupportsRelativeRedirects()
public long	getThreadId()
public Map<String, String>	getTrailerFields()
public UDecoder	getURLDecoder()
public boolean	hasExpectation()
public boolean	isExceptionPresent()
public boolean	isFinished()
public boolean	isProcessing()
public boolean	isReady()
public boolean	isRequestThread()
public boolean	isTrailerFieldsReady()
public MessageBytes	localAddr()
public MessageBytes	localName()
public MessageBytes	method()
public void	onDataAvailable()
public MessageBytes	peerAddr()
public MessageBytes	protocol()
public MessageBytes	queryString()
public void	recycle()
public MessageBytes	remoteAddr()
public MessageBytes	remoteHost()
public MessageBytes	requestURI()
public MessageBytes	scheme()
public boolean	sendAllDataReadEvent()
public MessageBytes	Returns: The buffer holding the server name, if any. Use isNull() to check if there is no value set. serverName() Get the "virtual host", derived from the Host: header associated with this request.
public void	setAttribute(String name, Object o)
public void	setAvailable(int available)
public void	setCharset(Charset charset)
public void	setContentLength(long len)
public void	setContentType(String type)
public void	setContentType(MessageBytes mb)
public void	setErrorException(Exception The exception that occurred ex) Set the error Exception that occurred during the writing of the response processing.
public void	setExpectation(boolean expectation)
protected void	setHook(ActionHook hook)
public void	setInputBuffer(InputBuffer inputBuffer)
public void	setLocalPort(int port)
public void	setNote(int Index to use to store the note pos, Object The value to store at that index value) Used to store private data.
public void	setReadListener(ReadListener listener)
public void	setRemotePort(int port)
public void	setRemoteUserNeedsAuthorization(boolean remoteUserNeedsAuthorization)
public void	setRequestThread()
public void	setResponse(Response response)
public void	setSendfile(boolean sendfile)
public void	setServerPort(int serverPort)
public void	setStartTime(long time startTime) Deprecated This setter will be removed in Tomcat 11
public void	setStartTimeNanos(long startTimeNanos)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateCounters()

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

Field Detail

allDataReadEventSent	back to summary
private final AtomicBoolean allDataReadEventSent

attributes	back to summary
private final HashMap<String, Object> attributes

authType	back to summary
private final MessageBytes authType

available	back to summary
private int available

bytesRead	back to summary
private long bytesRead

characterEncoding	back to summary
private String characterEncoding

charset	back to summary
private Charset charset

contentLength	back to summary
private long contentLength HTTP specific fields. (remove them ?)

contentTypeMB	back to summary
private MessageBytes contentTypeMB

decodedUriMB	back to summary
private final MessageBytes decodedUriMB

errorException	back to summary
private Exception errorException Holds request body reading error exception.

expectation	back to summary
private boolean expectation Is there an expectation ?

fireListener	back to summary
private boolean fireListener

headers	back to summary
private final MimeHeaders headers

hook	back to summary
private volatile ActionHook hook

INITIAL_COOKIE_SIZE	back to summary
private static final int INITIAL_COOKIE_SIZE

inputBuffer	back to summary
private InputBuffer inputBuffer Associated input buffer.

listener	back to summary
pack-priv volatile ReadListener listener

localAddrMB	back to summary
private final MessageBytes localAddrMB

localNameMB	back to summary
private final MessageBytes localNameMB

localPort	back to summary
private int localPort

methodMB	back to summary
private final MessageBytes methodMB

nonBlockingStateLock	back to summary
private final Object nonBlockingStateLock

notes	back to summary
private final Object[] notes Notes.

parameters	back to summary
private final Parameters parameters

pathParameters	back to summary
private final Map<String, String> pathParameters Path parameters

peerAddrMB	back to summary
private final MessageBytes peerAddrMB

protoMB	back to summary
private final MessageBytes protoMB

queryMB	back to summary
private final MessageBytes queryMB

registeredForRead	back to summary
private boolean registeredForRead

remoteAddrMB	back to summary
private final MessageBytes remoteAddrMB

remoteHostMB	back to summary
private final MessageBytes remoteHostMB

remotePort	back to summary
private int remotePort

remoteUser	back to summary
private final MessageBytes remoteUser

remoteUserNeedsAuthorization	back to summary
private boolean remoteUserNeedsAuthorization

reqProcessorMX	back to summary
private final RequestInfo reqProcessorMX

requestId	back to summary
private volatile String requestId

requestIdGenerator	back to summary
private static final AtomicLong requestIdGenerator

response	back to summary
private Response response

schemeMB	back to summary
private final MessageBytes schemeMB

sendfile	back to summary
private boolean sendfile

serverCookies	back to summary
private final ServerCookies serverCookies

serverNameMB	back to summary
private final MessageBytes serverNameMB

serverPort	back to summary
private int serverPort

sm	back to summary
private static final StringManager sm

startTimeNanos	back to summary
private long startTimeNanos

threadId	back to summary
private long threadId

trailerFields	back to summary
private final Map<String, String> trailerFields

uriMB	back to summary
private final MessageBytes uriMB

urlDecoder	back to summary
private final UDecoder urlDecoder URL decoder.

Constructor Detail

Request	back to summary
public Request()

Method Detail

action	back to summary
public void action(ActionCode actionCode, Object param)

addPathParameter	back to summary
public void addPathParameter(String name, String value)

checkRegisterForRead	back to summary
private boolean checkRegisterForRead()

clearRequestThread	back to summary
public void clearRequestThread()

contentType	back to summary
public MessageBytes contentType()

decodedURI	back to summary
public MessageBytes decodedURI()

doRead

back to summary

public int doRead(ApplicationBufferHandler handler) throws IOException

Read data from the input buffer and put it into ApplicationBufferHandler. The buffer is owned by the protocol implementation - it will be reused on the next read. The Adapter must either process the data in place or copy it to a separate buffer if it needs to hold it. In most cases this is done during byte->char conversions or via InputStream. Unlike InputStream, this interface allows the app to process data in place, without copy.

Parameters

handler:ApplicationBufferHandler: The destination to which to copy the data

Returns:int

The number of bytes copied

Exceptions

IOException:: If an I/O error occurs during the copy

getAttribute	back to summary
public Object getAttribute(String name)

getAttributes	back to summary
public HashMap<String, Object> getAttributes()

getAuthType	back to summary
public MessageBytes getAuthType()

getAvailable	back to summary
public int getAvailable()

getBytesRead	back to summary
public long getBytesRead()

getCharacterEncoding back to summary

public String getCharacterEncoding()

Get the character encoding used for this request.

Returns:String: The value set via setCharset(Charset) or if no call has been made to that method try to obtain if from the content type.

getCharset back to summary

public Charset getCharset() throws UnsupportedEncodingException

Get the character encoding used for this request.

Returns:Charset

The value set via setCharset(Charset) or if no call has been made to that method try to obtain if from the content type.

Exceptions

UnsupportedEncodingException:: If the user agent has specified an invalid character encoding

getCharsetFromContentType back to summary

private static String getCharsetFromContentType(String contentType)

Parse the character encoding from the specified content type header. If the content type is null, or there is no explicit character encoding, null is returned.

Parameters

contentType:String: a content type header

getContentLength	back to summary
public int getContentLength()

getContentLengthLong	back to summary
public long getContentLengthLong()

getContentType	back to summary
public String getContentType()

getCookies	back to summary
public ServerCookies getCookies()

getErrorException

back to summary

public Exception getErrorException()

Get the Exception that occurred during the writing of the response.

Returns:Exception: The exception that occurred

getHeader	back to summary
public String getHeader(String name)

getInputBuffer	back to summary
public InputBuffer getInputBuffer()

getLocalPort	back to summary
public int getLocalPort()

getMimeHeaders	back to summary
public MimeHeaders getMimeHeaders()

getNote	back to summary
public Object getNote(int pos)

getParameters	back to summary
public Parameters getParameters()

getPathParameter	back to summary
public String getPathParameter(String name)

getProtocolRequestId	back to summary
public String getProtocolRequestId()

getReadListener	back to summary
public ReadListener getReadListener()

getRemotePort	back to summary
public int getRemotePort()

getRemoteUser	back to summary
public MessageBytes getRemoteUser()

getRemoteUserNeedsAuthorization	back to summary
public boolean getRemoteUserNeedsAuthorization()

getRequestId	back to summary
public String getRequestId()

getRequestProcessor	back to summary
public RequestInfo getRequestProcessor()

getResponse	back to summary
public Response getResponse()

getSendfile	back to summary
public boolean getSendfile()

getServerPort	back to summary
public int getServerPort()

getServletConnection	back to summary
public ServletConnection getServletConnection()

getStartTime	back to summary
public long getStartTime()

getStartTimeNanos	back to summary
public long getStartTimeNanos()

getSupportsRelativeRedirects	back to summary
public boolean getSupportsRelativeRedirects()

getThreadId	back to summary
public long getThreadId()

getTrailerFields	back to summary
public Map<String, String> getTrailerFields()

getURLDecoder	back to summary
public UDecoder getURLDecoder()

hasExpectation	back to summary
public boolean hasExpectation()

isExceptionPresent	back to summary
public boolean isExceptionPresent()

isFinished	back to summary
public boolean isFinished()

isProcessing	back to summary
public boolean isProcessing()

isReady	back to summary
public boolean isReady()

isRequestThread	back to summary
public boolean isRequestThread()

isTrailerFieldsReady	back to summary
public boolean isTrailerFieldsReady()

localAddr	back to summary
public MessageBytes localAddr()

localName	back to summary
public MessageBytes localName()

method	back to summary
public MessageBytes method()

onDataAvailable	back to summary
public void onDataAvailable() throws IOException

peerAddr	back to summary
public MessageBytes peerAddr()

protocol	back to summary
public MessageBytes protocol()

queryString	back to summary
public MessageBytes queryString()

recycle	back to summary
public void recycle()

remoteAddr	back to summary
public MessageBytes remoteAddr()

remoteHost	back to summary
public MessageBytes remoteHost()

requestURI	back to summary
public MessageBytes requestURI()

scheme	back to summary
public MessageBytes scheme()

sendAllDataReadEvent	back to summary
public boolean sendAllDataReadEvent()

serverName

back to summary

public MessageBytes serverName()

Get the "virtual host", derived from the Host: header associated with this request.

Returns:MessageBytes: The buffer holding the server name, if any. Use isNull() to check if there is no value set.

setAttribute	back to summary
public void setAttribute(String name, Object o)

setAvailable	back to summary
public void setAvailable(int available)

setCharset	back to summary
public void setCharset(Charset charset)

setContentLength	back to summary
public void setContentLength(long len)

setContentType	back to summary
public void setContentType(String type)

setContentType	back to summary
public void setContentType(MessageBytes mb)

setErrorException

back to summary

public void setErrorException(Exception ex)

Set the error Exception that occurred during the writing of the response processing.

Parameters

ex:Exception: The exception that occurred

setExpectation	back to summary
public void setExpectation(boolean expectation)

setHook	back to summary
protected void setHook(ActionHook hook)

setInputBuffer	back to summary
public void setInputBuffer(InputBuffer inputBuffer)

setLocalPort	back to summary
public void setLocalPort(int port)

setNote

back to summary

public void setNote(int pos, Object value)

Used to store private data. Thread data could be used instead - but if you have the req, getting/setting a note is just an array access, may be faster than ThreadLocal for very frequent operations. Example use: Catalina CoyoteAdapter: ADAPTER_NOTES = 1 - stores the HttpServletRequest object ( req/res) To avoid conflicts, note in the range 0 - 8 are reserved for the servlet container ( catalina connector, etc ), and values in 9 - 16 for connector use. 17-31 range is not allocated or used.

Parameters

pos:int: Index to use to store the note
value:Object: The value to store at that index

setReadListener	back to summary
public void setReadListener(ReadListener listener)

setRemotePort	back to summary
public void setRemotePort(int port)

setRemoteUserNeedsAuthorization	back to summary
public void setRemoteUserNeedsAuthorization(boolean remoteUserNeedsAuthorization)

setRequestThread	back to summary
public void setRequestThread()

setResponse	back to summary
public void setResponse(Response response)

setSendfile	back to summary
public void setSendfile(boolean sendfile)

setServerPort	back to summary
public void setServerPort(int serverPort)

setStartTime	back to summary
public void setStartTime(long startTime) Deprecated This setter will be removed in Tomcat 11 Parameters startTime:long time Annotations @Deprecated

setStartTimeNanos	back to summary
public void setStartTimeNanos(long startTimeNanos)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateCounters	back to summary
public void updateCounters()

public final Class Request

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail